se.l4.commons.serialization.format

Interface StreamingInput

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractStreamingInput, BinaryInput, ConfigJsonInput, JsonInput, ListInput, MapInput, NullInput, ValueInput

public interface StreamingInput
extends Closeable

Input that is streamed as a set of token with values.

Author:

Andreas Holstenson

Method Summary

Modifier and Type	Method and Description
Token	current() Get the current token.
boolean	getBoolean() Get the value as a boolean.
byte[]	getByteArray() Get the value as a byte[] array.
double	getDouble() Get the value as a double.
float	getFloat() Get the value as a float.
int	getInt() Get the value as an integer.
long	getLong() Get the value as a long.
short	getShort() Get the value as a short.
String	getString() Get the current value as a string.
Object	getValue() Get the current value.
Token	next() Advance to the next token.
Token	next(Token expected) Advance to the next token checking that it is of a certain type.
Token	peek() Peek into the stream and return the next token.
void	skip() Skip the started object, list or value.
void	skipValue() If this token is a Token.KEY this will skip its value.

Methods inherited from interface java.io.Closeable

close

Method Detail

peek

Token peek()
    throws IOException

Peek into the stream and return the next token.

Returns:

Throws:

IOException

next

Token next()
    throws IOException

Advance to the next token.

Returns:

Throws:

IOException

next

Token next(Token expected)
    throws IOException

Advance to the next token checking that it is of a certain type.

Parameters:

expected -

Returns:

Throws:

IOException

skip

void skip()
   throws IOException

Skip the started object, list or value. This method should only be used when when token is either Token.OBJECT_START, Token.LIST_START or Token.VALUE. See skipValue() for skipping reading when the current token is Token.KEY.

Throws:

IOException

skipValue

void skipValue()
        throws IOException

If this token is a Token.KEY this will skip its value.

Throws:

IOException

current

Token current()

Get the current token.

Returns:

getValue

Object getValue()

Get the current value.

Returns:

getString

String getString()

Get the current value as a string.

Returns:

getBoolean

boolean getBoolean()

Get the value as a boolean.

Returns:

getDouble

double getDouble()

Get the value as a double.

Returns:

getFloat

float getFloat()

Get the value as a float.

Returns:

getLong

long getLong()

Get the value as a long.

Returns:

getInt

int getInt()

Get the value as an integer.

Returns:

getShort

short getShort()

Get the value as a short.

Returns:

getByteArray

byte[] getByteArray()

Get the value as a byte[] array.

Returns: