org.apache.flink.types.parser

Class ByteParser

java.lang.Object

org.apache.flink.types.parser.FieldParser<Byte>

org.apache.flink.types.parser.ByteParser

@PublicEvolving
public class ByteParser
extends FieldParser<Byte>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.types.parser.FieldParser

FieldParser.ParseErrorState

Constructor Summary

Constructors

Constructor and Description
ByteParser()

Method Summary

Modifier and Type	Method and Description
Byte	createValue() Returns an instance of the parsed value type.
Byte	getLastResult() Gets the parsed field.
static byte	parseField(byte[] bytes, int startPos, int length) Static utility to parse a field of type byte from a byte sequence that represents text characters (such as when read from a file stream).
int	parseField(byte[] bytes, int startPos, int limit, byte[] delimiter, Byte reusable) Parses the value of a field from the byte array.
static byte	parseField(byte[] bytes, int startPos, int length, char delimiter) Static utility to parse a field of type byte from a byte sequence that represents text characters (such as when read from a file stream).

Methods inherited from class org.apache.flink.types.parser.FieldParser

delimiterNext, getErrorState, getParserForType, setErrorState

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteParser

public ByteParser()

Method Detail

parseField

public int parseField(byte[] bytes,
                      int startPos,
                      int limit,
                      byte[] delimiter,
                      Byte reusable)

Description copied from class: FieldParser

Parses the value of a field from the byte array. The start position within the byte array and the array's valid length is given. The content of the value is delimited by a field delimiter.

Specified by:

parseField in class FieldParser<Byte>

Parameters:

bytes - The byte array that holds the value.

startPos - The index where the field starts

limit - The limit unto which the byte contents is valid for the parser. The limit is the position one after the last valid byte.

delimiter - The field delimiter character

reusable - An optional reusable field to hold the value

Returns:

The index of the next delimiter, if the field was parsed correctly. A value less than 0 otherwise.

createValue

public Byte createValue()

Description copied from class: FieldParser

Returns an instance of the parsed value type.

Specified by:

createValue in class FieldParser<Byte>

Returns:

An instance of the parsed value type.

getLastResult

public Byte getLastResult()

Description copied from class: FieldParser

Gets the parsed field. This method returns the value parsed by the last successful invocation of FieldParser.parseField(byte[], int, int, byte[], Object). It objects are mutable and reused, it will return the object instance that was passed the parse function.

Specified by:

getLastResult in class FieldParser<Byte>

Returns:

The latest parsed field.

parseField

public static final byte parseField(byte[] bytes,
                                    int startPos,
                                    int length)

Static utility to parse a field of type byte from a byte sequence that represents text characters (such as when read from a file stream).

Parameters:

bytes - The bytes containing the text data that should be parsed.

startPos - The offset to start the parsing.

length - The length of the byte sequence (counting from the offset).

Returns:

The parsed value.

Throws:

NumberFormatException - Thrown when the value cannot be parsed because the text represents not a correct number.

parseField

public static final byte parseField(byte[] bytes,
                                    int startPos,
                                    int length,
                                    char delimiter)

Static utility to parse a field of type byte from a byte sequence that represents text characters (such as when read from a file stream).

Parameters:

bytes - The bytes containing the text data that should be parsed.

startPos - The offset to start the parsing.

length - The length of the byte sequence (counting from the offset).

delimiter - The delimiter that terminates the field.

Returns:

The parsed value.

Throws:

NumberFormatException - Thrown when the value cannot be parsed because the text represents not a correct number.