org.apache.flink.types.parser

Class StringParser

java.lang.Object

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

org.apache.flink.types.parser.StringParser

@PublicEvolving
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

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) Each parser's logic should be implemented inside this method

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

delimiterNext, endsWithDelimiter, getCharset, getErrorState, getParserForType, nextStringEndPos, nextStringLength, resetErrorStateAndParse, resetParserState, setCharset, 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

Each parser's logic should be implemented inside this method

Specified by:

parseField in class FieldParser<String>

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.