Package org.apache.hadoop.typedbytes

Class TypedBytesRecordInput

java.lang.Object

org.apache.hadoop.typedbytes.TypedBytesRecordInput

All Implemented Interfaces:

RecordInput

public class TypedBytesRecordInput
extends java.lang.Object
implements RecordInput

Serializer for records that writes typed bytes.

Constructor Summary

Constructors

Constructor	Description
TypedBytesRecordInput(java.io.DataInput in)	Creates a new instance of TypedBytesRecordInput.
TypedBytesRecordInput(TypedBytesInput in)	Creates a new instance of TypedBytesRecordInput.

Method Summary

Modifier and Type	Method	Description
void	endMap(java.lang.String tag)	Check the mark for end of the serialized map.
void	endRecord(java.lang.String tag)	Check the mark for end of the serialized record.
void	endVector(java.lang.String tag)	Check the mark for end of the serialized vector.
static TypedBytesRecordInput	get(java.io.DataInput in)	Get a thread-local typed bytes record input for the supplied DataInput.
static TypedBytesRecordInput	get(TypedBytesInput in)	Get a thread-local typed bytes record input for the supplied TypedBytesInput.
boolean	readBool(java.lang.String tag)	Read a boolean from serialized record.
Buffer	readBuffer(java.lang.String tag)	Read byte array from serialized record.
byte	readByte(java.lang.String tag)	Read a byte from serialized record.
double	readDouble(java.lang.String tag)	Read a double-precision number from serialized record.
float	readFloat(java.lang.String tag)	Read a single-precision float from serialized record.
int	readInt(java.lang.String tag)	Read an integer from serialized record.
long	readLong(java.lang.String tag)	Read a long integer from serialized record.
java.lang.String	readString(java.lang.String tag)	Read a UTF-8 encoded string from serialized record.
Index	startMap(java.lang.String tag)	Check the mark for start of the serialized map.
void	startRecord(java.lang.String tag)	Check the mark for start of the serialized record.
Index	startVector(java.lang.String tag)	Check the mark for start of the serialized vector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TypedBytesRecordInput

public TypedBytesRecordInput(TypedBytesInput in)

Creates a new instance of TypedBytesRecordInput.

TypedBytesRecordInput

public TypedBytesRecordInput(java.io.DataInput in)

Creates a new instance of TypedBytesRecordInput.

Method Detail

get

public static TypedBytesRecordInput get(TypedBytesInput in)

Get a thread-local typed bytes record input for the supplied TypedBytesInput.

Parameters:

in - typed bytes input object

Returns:

typed bytes record input corresponding to the supplied TypedBytesInput.

get

public static TypedBytesRecordInput get(java.io.DataInput in)

Get a thread-local typed bytes record input for the supplied DataInput.

Parameters:

in - data input object

Returns:

typed bytes record input corresponding to the supplied DataInput.

readBool

public boolean readBool(java.lang.String tag)
                 throws java.io.IOException

Description copied from interface: RecordInput

Read a boolean from serialized record.

Specified by:

readBool in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

value read from serialized record.

Throws:

java.io.IOException

readBuffer

public Buffer readBuffer(java.lang.String tag)
                  throws java.io.IOException

Description copied from interface: RecordInput

Read byte array from serialized record.

Specified by:

readBuffer in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

value read from serialized record.

Throws:

java.io.IOException

readByte

public byte readByte(java.lang.String tag)
              throws java.io.IOException

Description copied from interface: RecordInput

Read a byte from serialized record.

Specified by:

readByte in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

value read from serialized record.

Throws:

java.io.IOException

readDouble

public double readDouble(java.lang.String tag)
                  throws java.io.IOException

Description copied from interface: RecordInput

Read a double-precision number from serialized record.

Specified by:

readDouble in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

value read from serialized record.

Throws:

java.io.IOException

readFloat

public float readFloat(java.lang.String tag)
                throws java.io.IOException

Description copied from interface: RecordInput

Read a single-precision float from serialized record.

Specified by:

readFloat in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

value read from serialized record.

Throws:

java.io.IOException

readInt

public int readInt(java.lang.String tag)
            throws java.io.IOException

Description copied from interface: RecordInput

Read an integer from serialized record.

Specified by:

readInt in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

value read from serialized record.

Throws:

java.io.IOException

readLong

public long readLong(java.lang.String tag)
              throws java.io.IOException

Description copied from interface: RecordInput

Read a long integer from serialized record.

Specified by:

readLong in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

value read from serialized record.

Throws:

java.io.IOException

readString

public java.lang.String readString(java.lang.String tag)
                            throws java.io.IOException

Description copied from interface: RecordInput

Read a UTF-8 encoded string from serialized record.

Specified by:

readString in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

value read from serialized record.

Throws:

java.io.IOException

startRecord

public void startRecord(java.lang.String tag)
                 throws java.io.IOException

Description copied from interface: RecordInput

Check the mark for start of the serialized record.

Specified by:

startRecord in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Throws:

java.io.IOException

startVector

public Index startVector(java.lang.String tag)
                  throws java.io.IOException

Description copied from interface: RecordInput

Check the mark for start of the serialized vector.

Specified by:

startVector in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

Index that is used to count the number of elements.

Throws:

java.io.IOException

startMap

public Index startMap(java.lang.String tag)
               throws java.io.IOException

Description copied from interface: RecordInput

Check the mark for start of the serialized map.

Specified by:

startMap in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Returns:

Index that is used to count the number of map entries.

Throws:

java.io.IOException

endRecord

public void endRecord(java.lang.String tag)
               throws java.io.IOException

Description copied from interface: RecordInput

Check the mark for end of the serialized record.

Specified by:

endRecord in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Throws:

java.io.IOException

endVector

public void endVector(java.lang.String tag)
               throws java.io.IOException

Description copied from interface: RecordInput

Check the mark for end of the serialized vector.

Specified by:

endVector in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Throws:

java.io.IOException

endMap

public void endMap(java.lang.String tag)
            throws java.io.IOException

Description copied from interface: RecordInput

Check the mark for end of the serialized map.

Specified by:

endMap in interface RecordInput

Parameters:

tag - Used by tagged serialization formats (such as XML)

Throws:

java.io.IOException