All Superinterfaces:: AutoCloseable, Closeable

All Known Implementing Classes:: AbstractStreamingInput, BinaryInput, JsonInput

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	Description
`Token`	`current()`	Get the current token.
`boolean`	`getBoolean()`	Get the value as a boolean.
`default byte`	`getByte()`	Get the value as a byte.
`byte[]`	`getByteArray()`	Get the value as a byte[] array.
`default char`	`getChar()`	Get the value as a character.
`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.
`default ValueType`	`getValueType()`	Get the type of value the input currently has.
`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 Details
- 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:
- getValueType
  
  default ValueType getValueType()
  
  Get the type of value the input currently has. If the current token is not Token.VALUE or Token.NULL this method will raise a SerializationException.
  The type of value is defined by the input, and many number values can be converted.
  
  Returns:
  
  current type of value
- 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:
- getByte
  
  default byte getByte()
  
  Get the value as a byte.
  
  Returns:
- getChar
  
  default char getChar()
  
  Get the value as a character.
  
  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:

Interface StreamingInput

Method Summary

Methods inherited from interface java.io.Closeable

Method Details