TypedBytesInput (Apache Hadoop MapReduce Streaming 3.4.1.300-dep-1001 API)

java.lang.Object
- org.apache.hadoop.typedbytes.TypedBytesInput

public class TypedBytesInput
extends java.lang.Object

Provides functionality for reading typed bytes.

Constructor Summary

Constructors
Constructor Description

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TypedBytesInput`	`get(java.io.DataInput in)`	Get a thread-local typed bytes input for the supplied `DataInput`.
`java.lang.Object`	`read()`	Reads a typed bytes sequence and converts it to a Java object.
`boolean`	`readBool()`	Reads the boolean following a `Type.BOOL` code.
`byte`	`readByte()`	Reads the byte following a `Type.BYTE` code.
`byte[]`	`readBytes()`	Reads the bytes following a `Type.BYTES` code.
`double`	`readDouble()`	Reads the double following a `Type.DOUBLE` code.
`float`	`readFloat()`	Reads the float following a `Type.FLOAT` code.
`int`	`readInt()`	Reads the integer following a `Type.INT` code.
`java.util.List`	`readList()`	Reads the list following a `Type.LIST` code.
`long`	`readLong()`	Reads the long following a `Type.LONG` code.
`java.util.TreeMap`	`readMap()`	Reads the map following a `Type.MAP` code.
`int`	`readMapHeader()`	Reads the header following a `Type.MAP` code.
`byte[]`	`readRaw()`	Reads a typed bytes sequence.
`byte[]`	`readRawBool()`	Reads the raw bytes following a `Type.BOOL` code.
`byte[]`	`readRawByte()`	Reads the raw byte following a `Type.BYTE` code.
`byte[]`	`readRawBytes()`	Reads the raw bytes following a `Type.BYTES` code.
`byte[]`	`readRawBytes(int code)`	Reads the raw bytes following a custom code.
`byte[]`	`readRawDouble()`	Reads the raw bytes following a `Type.DOUBLE` code.
`byte[]`	`readRawFloat()`	Reads the raw bytes following a `Type.FLOAT` code.
`byte[]`	`readRawInt()`	Reads the raw bytes following a `Type.INT` code.
`byte[]`	`readRawList()`	Reads the raw bytes following a `Type.LIST` code.
`byte[]`	`readRawLong()`	Reads the raw bytes following a `Type.LONG` code.
`byte[]`	`readRawMap()`	Reads the raw bytes following a `Type.MAP` code.
`byte[]`	`readRawString()`	Reads the raw bytes following a `Type.STRING` code.
`byte[]`	`readRawVector()`	Reads the raw bytes following a `Type.VECTOR` code.
`java.lang.String`	`readString()`	Reads the string following a `Type.STRING` code.
`Type`	`readType()`	Reads a type byte and returns the corresponding `Type`.
`java.util.ArrayList`	`readVector()`	Reads the vector following a `Type.VECTOR` code.
`int`	`readVectorHeader()`	Reads the header following a `Type.VECTOR` code.
`boolean`	`skipType()`	Skips a type byte.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TypedBytesInput
```
public TypedBytesInput(java.io.DataInput in)
```
    Creates a new instance of TypedBytesInput.
- Method Detail
  - get
```
public static TypedBytesInput get(java.io.DataInput in)
```
    Get a thread-local typed bytes input for the supplied DataInput.
    
    Parameters:
    
    in - data input object
    
    Returns:
    
    typed bytes input corresponding to the supplied DataInput.
  - read
```
public java.lang.Object read()
                      throws java.io.IOException
```
    Reads a typed bytes sequence and converts it to a Java object. The first byte is interpreted as a type code, and then the right number of subsequent bytes are read depending on the obtained type.
    
    Returns:
    
    the obtained object or null when the end of the file is reached
    
    Throws:
    
    java.io.IOException
  - readRaw
```
public byte[] readRaw()
               throws java.io.IOException
```
    Reads a typed bytes sequence. The first byte is interpreted as a type code, and then the right number of subsequent bytes are read depending on the obtained type.
    
    Returns:
    
    the obtained typed bytes sequence or null when the end of the file is reached
    
    Throws:
    
    java.io.IOException
  - readType
```
public Type readType()
              throws java.io.IOException
```
    Reads a type byte and returns the corresponding Type.
    
    Returns:
    
    the obtained Type or null when the end of the file is reached
    
    Throws:
    
    java.io.IOException
  - skipType
```
public boolean skipType()
                 throws java.io.IOException
```
    Skips a type byte.
    
    Returns:
    
    true iff the end of the file was not reached
    
    Throws:
    
    java.io.IOException
  - readBytes
```
public byte[] readBytes()
                 throws java.io.IOException
```
    Reads the bytes following a Type.BYTES code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readRawBytes
```
public byte[] readRawBytes(int code)
                    throws java.io.IOException
```
    Reads the raw bytes following a custom code.
    
    Parameters:
    
    code - the custom type code
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readRawBytes
```
public byte[] readRawBytes()
                    throws java.io.IOException
```
    Reads the raw bytes following a Type.BYTES code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readByte
```
public byte readByte()
              throws java.io.IOException
```
    Reads the byte following a Type.BYTE code.
    
    Returns:
    
    the obtained byte
    
    Throws:
    
    java.io.IOException
  - readRawByte
```
public byte[] readRawByte()
                   throws java.io.IOException
```
    Reads the raw byte following a Type.BYTE code.
    
    Returns:
    
    the obtained byte
    
    Throws:
    
    java.io.IOException
  - readBool
```
public boolean readBool()
                 throws java.io.IOException
```
    Reads the boolean following a Type.BOOL code.
    
    Returns:
    
    the obtained boolean
    
    Throws:
    
    java.io.IOException
  - readRawBool
```
public byte[] readRawBool()
                   throws java.io.IOException
```
    Reads the raw bytes following a Type.BOOL code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readInt
```
public int readInt()
            throws java.io.IOException
```
    Reads the integer following a Type.INT code.
    
    Returns:
    
    the obtained integer
    
    Throws:
    
    java.io.IOException
  - readRawInt
```
public byte[] readRawInt()
                  throws java.io.IOException
```
    Reads the raw bytes following a Type.INT code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readLong
```
public long readLong()
              throws java.io.IOException
```
    Reads the long following a Type.LONG code.
    
    Returns:
    
    the obtained long
    
    Throws:
    
    java.io.IOException
  - readRawLong
```
public byte[] readRawLong()
                   throws java.io.IOException
```
    Reads the raw bytes following a Type.LONG code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readFloat
```
public float readFloat()
                throws java.io.IOException
```
    Reads the float following a Type.FLOAT code.
    
    Returns:
    
    the obtained float
    
    Throws:
    
    java.io.IOException
  - readRawFloat
```
public byte[] readRawFloat()
                    throws java.io.IOException
```
    Reads the raw bytes following a Type.FLOAT code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readDouble
```
public double readDouble()
                  throws java.io.IOException
```
    Reads the double following a Type.DOUBLE code.
    
    Returns:
    
    the obtained double
    
    Throws:
    
    java.io.IOException
  - readRawDouble
```
public byte[] readRawDouble()
                     throws java.io.IOException
```
    Reads the raw bytes following a Type.DOUBLE code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readString
```
public java.lang.String readString()
                            throws java.io.IOException
```
    Reads the string following a Type.STRING code.
    
    Returns:
    
    the obtained string
    
    Throws:
    
    java.io.IOException
  - readRawString
```
public byte[] readRawString()
                     throws java.io.IOException
```
    Reads the raw bytes following a Type.STRING code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readVector
```
public java.util.ArrayList readVector()
                               throws java.io.IOException
```
    Reads the vector following a Type.VECTOR code.
    
    Returns:
    
    the obtained vector
    
    Throws:
    
    java.io.IOException
  - readRawVector
```
public byte[] readRawVector()
                     throws java.io.IOException
```
    Reads the raw bytes following a Type.VECTOR code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readVectorHeader
```
public int readVectorHeader()
                     throws java.io.IOException
```
    Reads the header following a Type.VECTOR code.
    
    Returns:
    
    the number of elements in the vector
    
    Throws:
    
    java.io.IOException
  - readList
```
public java.util.List readList()
                        throws java.io.IOException
```
    Reads the list following a Type.LIST code.
    
    Returns:
    
    the obtained list
    
    Throws:
    
    java.io.IOException
  - readRawList
```
public byte[] readRawList()
                   throws java.io.IOException
```
    Reads the raw bytes following a Type.LIST code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readMap
```
public java.util.TreeMap readMap()
                          throws java.io.IOException
```
    Reads the map following a Type.MAP code.
    
    Returns:
    
    the obtained map
    
    Throws:
    
    java.io.IOException
  - readRawMap
```
public byte[] readRawMap()
                  throws java.io.IOException
```
    Reads the raw bytes following a Type.MAP code.
    
    Returns:
    
    the obtained bytes sequence
    
    Throws:
    
    java.io.IOException
  - readMapHeader
```
public int readMapHeader()
                  throws java.io.IOException
```
    Reads the header following a Type.MAP code.
    
    Returns:
    
    the number of key-value pairs in the map
    
    Throws:
    
    java.io.IOException

Class TypedBytesInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TypedBytesInput

Method Detail

get

read

readRaw

readType

skipType

readBytes

readRawBytes

readRawBytes

readByte

readRawByte

readBool

readRawBool

readInt

readRawInt

readLong

readRawLong

readFloat

readRawFloat

readDouble

readRawDouble

readString

readRawString

readVector

readRawVector

readVectorHeader

readList

readRawList

readMap

readRawMap

readMapHeader