java.lang.Object

se.l4.commons.serialization.format.AbstractStreamingInput

All Implemented Interfaces:: Closeable, AutoCloseable, StreamingInput

Direct Known Subclasses:: BinaryInput, JsonInput

public abstract class AbstractStreamingInput
extends Object
implements StreamingInput

Abstract implementation of StreamingInput to simplify common operations such as peeking and value setting.

Field Summary

Fields

Modifier and Type Field Description

protected int level
Constructor Summary

Constructors

Constructor Description

AbstractStreamingInput()

Method Summary

Modifier and Type	Method	Description
`Token`	`current()`	Get the current token.
`boolean`	`getBoolean()`	Get the value as a boolean.
`byte`	`getByte()`	Get the value as a byte.
`byte[]`	`getByteArray()`	Get the value as a byte[] array.
`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.
`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.
`protected abstract Token`	`next0()`
`protected IOException`	`raiseException(String message)`
`protected SerializationException`	`raiseSerializationException(String message)`
`protected void`	`setValue(boolean value)`
`protected void`	`setValue(byte value)`
`protected void`	`setValue(byte[] value)`
`protected void`	`setValue(char value)`
`protected void`	`setValue(double value)`
`protected void`	`setValue(float value)`
`protected void`	`setValue(int value)`
`protected void`	`setValue(long value)`
`protected void`	`setValue(short value)`
`protected void`	`setValue(Object value)`
`protected void`	`setValue(String value)`
`protected void`	`setValueNull()`
`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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface se.l4.commons.serialization.format.StreamingInput

peek

Field Details
- level
  
  protected int level
Constructor Details
- AbstractStreamingInput
  
  public AbstractStreamingInput()
Method Details
- next
  
  public Token next() throws IOException
  
  Description copied from interface: StreamingInput
  
  Advance to the next token.
  
  Specified by:
  
  next in interface StreamingInput
  
  Returns:
  
  Throws:
  
  IOException
- next0
  
  protected abstract Token next0() throws IOException
  
  Throws:
  
  IOException
- raiseException
  
  protected IOException raiseException(String message)
- raiseSerializationException
  
  protected SerializationException raiseSerializationException(String message)
- next
  
  public Token next(Token expected) throws IOException
  
  Description copied from interface: StreamingInput
  
  Advance to the next token checking that it is of a certain type.
  
  Specified by:
  
  next in interface StreamingInput
  
  Returns:
  
  Throws:
  
  IOException
- skipValue
  
  public void skipValue() throws IOException
  
  Description copied from interface: StreamingInput
  
  If this token is a Token.KEY this will skip its value.
  
  Specified by:
  
  skipValue in interface StreamingInput
  
  Throws:
  
  IOException
- skip
  
  public void skip() throws IOException
  
  Description copied from interface: StreamingInput
  
  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 StreamingInput.skipValue() for skipping reading when the current token is Token.KEY.
  
  Specified by:
  
  skip in interface StreamingInput
  
  Throws:
  
  IOException
- current
  
  public Token current()
  
  Description copied from interface: StreamingInput
  
  Get the current token.
  
  Specified by:
  
  current in interface StreamingInput
  
  Returns:
- getValueType
  
  public ValueType getValueType()
  
  Description copied from interface: StreamingInput
  
  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.
  
  Specified by:
  
  getValueType in interface StreamingInput
  
  Returns:
  
  current type of value
- setValueNull
  
  protected void setValueNull()
- setValue
  
  protected void setValue(Object value)
- setValue
  
  protected void setValue(String value)
- setValue
  
  protected void setValue(boolean value)
- setValue
  
  protected void setValue(byte value)
- setValue
  
  protected void setValue(char value)
- setValue
  
  protected void setValue(double value)
- setValue
  
  protected void setValue(float value)
- setValue
  
  protected void setValue(int value)
- setValue
  
  protected void setValue(long value)
- setValue
  
  protected void setValue(short value)
- setValue
  
  protected void setValue(byte[] value)
- getValue
  
  public Object getValue()
  
  Description copied from interface: StreamingInput
  
  Get the current value.
  
  Specified by:
  
  getValue in interface StreamingInput
  
  Returns:
- getString
  
  public String getString()
  
  Description copied from interface: StreamingInput
  
  Get the current value as a string.
  
  Specified by:
  
  getString in interface StreamingInput
  
  Returns:
- getBoolean
  
  public boolean getBoolean()
  
  Description copied from interface: StreamingInput
  
  Get the value as a boolean.
  
  Specified by:
  
  getBoolean in interface StreamingInput
  
  Returns:
- getByte
  
  public byte getByte()
  
  Description copied from interface: StreamingInput
  
  Get the value as a byte.
  
  Specified by:
  
  getByte in interface StreamingInput
  
  Returns:
- getChar
  
  public char getChar()
  
  Description copied from interface: StreamingInput
  
  Get the value as a character.
  
  Specified by:
  
  getChar in interface StreamingInput
  
  Returns:
- getDouble
  
  public double getDouble()
  
  Description copied from interface: StreamingInput
  
  Get the value as a double.
  
  Specified by:
  
  getDouble in interface StreamingInput
  
  Returns:
- getFloat
  
  public float getFloat()
  
  Description copied from interface: StreamingInput
  
  Get the value as a float.
  
  Specified by:
  
  getFloat in interface StreamingInput
  
  Returns:
- getLong
  
  public long getLong()
  
  Description copied from interface: StreamingInput
  
  Get the value as a long.
  
  Specified by:
  
  getLong in interface StreamingInput
  
  Returns:
- getInt
  
  public int getInt()
  
  Description copied from interface: StreamingInput
  
  Get the value as an integer.
  
  Specified by:
  
  getInt in interface StreamingInput
  
  Returns:
- getShort
  
  public short getShort()
  
  Description copied from interface: StreamingInput
  
  Get the value as a short.
  
  Specified by:
  
  getShort in interface StreamingInput
  
  Returns:
- getByteArray
  
  public byte[] getByteArray()
  
  Description copied from interface: StreamingInput
  
  Get the value as a byte[] array.
  
  Specified by:
  
  getByteArray in interface StreamingInput
  
  Returns:

Class AbstractStreamingInput

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Methods inherited from interface se.l4.commons.serialization.format.StreamingInput

Field Details

Constructor Details

Method Details