org.apache.flink.types.parser

Class StringParser

java.lang.Object

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

org.apache.flink.types.parser.StringParser

public class StringParser
extends FieldParser<String>

Converts a variable length field of a byte array into a String. The byte contents between delimiters is interpreted as an ASCII string. The string may be quoted in double quotes. For quoted strings, whitespaces (space and tab) leading and trailing before and after the quotes are removed.

Nested Class Summary

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

FieldParser.ParseErrorState

Constructor Summary

Constructors

Constructor and Description
StringParser()

Method Summary

Methods

Modifier and Type	Method and Description
String	createValue() Returns an instance of the parsed value type.
void	enableQuotedStringParsing(byte quoteCharacter)
String	getLastResult() Gets the parsed field.
int	parseField(byte[] bytes, int startPos, int limit, byte[] delimiter, String reusable) Parses the value of a field from the byte array.

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

StringParser

public StringParser()

Method Detail

enableQuotedStringParsing

public void enableQuotedStringParsing(byte quoteCharacter)

parseField

public int parseField(byte[] bytes,
             int startPos,
             int limit,
             byte[] delimiter,
             String 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<String>

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 String createValue()

Description copied from class: FieldParser

Returns an instance of the parsed value type.

Specified by:

createValue in class FieldParser<String>

Returns:

An instance of the parsed value type.

getLastResult

public String 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<String>

Returns:

The latest parsed field.