Collaboration diagram for com.vertica.sdk.State.InputState:

Public Member Functions
int	getCode ()

Public Attributes
	END_OF_CHUNK =(2)

	END_OF_FILE =(1)

	OK =(0)

Detailed Description

InputState is used by input streams; namely, UDFilter and UDParser.

Member Function Documentation

◆ getCode()

int com.vertica.sdk.State.InputState.getCode ( )

Each Input State has a unique code, but that code is an internal implementation detail not intended to be used by UDX implementations.

Returns: code

Member Data Documentation

◆ END_OF_CHUNK

com.vertica.sdk.State.InputState.END_OF_CHUNK =(2)

Reached the end of an input chunk. Applies only to a parser and only when fed by a Chunker, it means the current data block ends on a record boundary. In this state a parser should consume all data in the block before returning from process.

Returning a StreamState of INPUT_NEEDED at this point is invalid, as there is no more input available for this parser.

◆ END_OF_FILE

com.vertica.sdk.State.InputState.END_OF_FILE =(1)

Reached the end of the input stream. No further data is available. Returning a StreamState of INPUT_NEEDED at this point is invalid, as there is no more input.

◆ OK

com.vertica.sdk.State.InputState.OK =(0)

Currently at the start of or in the middle of a stream.

Public Member Functions