Method Detail

• readName

  String readName()

  Returns:

  the name of the current property or element.

• readStartObject

  boolean readStartObject()

  Returns:

  true if pointing to the start of an object, false otherwise.

  See Also:

  StructuredWriter.writeStartObject()

• readStartArray

  boolean readStartArray()

  Returns:

  true if pointing to the start of an object, false otherwise.

  See Also:

  StructuredWriter.writeStartArray()

• readValue

  Object readValue()

  Generic method to read and unmarshall a value supporting only the build in types Boolean, String, and Number.
  

  Returns:

  the unmarsahlled value. May be null.

• readValue

  Object readValue​(boolean recursive)

  Generic method to read and unmarshall a value supporting the build in types Boolean, String, and Number. In case recursive is true also List for arrays and Map for objects are supported.
  

  Parameters:

  recursive - - true for recursive reading of arrays as List and objects as Map, false otherwise.

  Returns:

  the unmarsahlled value. May be null.

• readObject

  void readObject​(Map<String,​Object> map)

  This method may be called if the current state is StructuredReader.State.START_OBJECT to read the object into the given Map. After the call of this method the state will point to the next one after the corresponding StructuredReader.State.END_OBJECT.

  Parameters:

  map - the Map where to add the properties. Unlike readValue(boolean) this allows you to choose the Map implementation.

• readArray

  void readArray​(Collection<Object> array)

  This method may be called called if the current state is StructuredReader.State.START_ARRAY to read the array into the given Collection. After the call of this method the state will point to the next one after the corresponding StructuredReader.State.END_ARRAY.

  Parameters:

  array - the Collection where to add the values.

• readValue

  default <V> V readValue​(Class<V> type)

  Generic method to read and unmarshall a value.
  ATTENTION:
  This generic method only exists as convenience method for the readValueAs* methods. It therefore only supports standard Java value types as described in io.github.mmm.marshall. For other types it will throw an IllegalArgumentException.

  Type Parameters:

  V - type of the value to read.

  Parameters:

  type - Class reflecting the value to read.

  Returns:

  the unmarsahlled value. May be null.

• readValueAsString

  String readValueAsString()

  Returns:

  reads the value as String.

  See Also:

  readValue(Class)

• readValueAsBoolean

  Boolean readValueAsBoolean()

  Returns:

  reads the value as Boolean.

  See Also:

  readValue(Class)

• readValueAsInteger

  Integer readValueAsInteger()

  Returns:

  reads the value as Integer.

  See Also:

  readValue(Class)

• readValueAsLong

  Long readValueAsLong()

  Returns:

  reads the value as Long.

  See Also:

  readValue(Class)

• readValueAsDouble

  Double readValueAsDouble()

  Returns:

  reads the value as Double.

  See Also:

  readValue(Class)

• readValueAsFloat

  Float readValueAsFloat()

  Returns:

  reads the value as Float.

  See Also:

  readValue(Class)

• readValueAsShort

  Short readValueAsShort()

  Returns:

  reads the value as Short.

  See Also:

  readValue(Class)

• readValueAsByte

  Byte readValueAsByte()

  Returns:

  reads the value as Byte.

  See Also:

  readValue(Class)

• readValueAsBigInteger

  BigInteger readValueAsBigInteger()

  Returns:

  reads the value as BigInteger.

  See Also:

  readValue(Class)

• readValueAsBigDecimal

  BigDecimal readValueAsBigDecimal()

  Returns:

  reads the value as BigDecimal.

  See Also:

  readValue(Class)

• skipValue

  void skipValue()

  Skips the current value. Should be called after readName().

  • If currently at start of object, skip that entire object.
  • If currently at start of array, skip the entire array.
  • If currently at a single value, skip that value.

• readEnd

  boolean readEnd()

  Returns:

  true if the end of an array or object has been reached.

• isDone

  boolean isDone()

  Returns:

  true if all data has been read and the end of the stream has been reached, false otherwise.

• getState

  StructuredReader.State getState()

  Returns:

  the current state of this reader.

• next

  StructuredReader.State next()

  Proceeds to the next StructuredReader.State skipping the current information.

  Returns:

  the new StructuredReader.State.

• close

  void close()

  Specified by:

  close in interface AutoCloseable