java.lang.Object
- io.github.mmm.marshall.AbstractStructuredReader

All Implemented Interfaces:

StructuredReader, AutoCloseable
```
public abstract class AbstractStructuredReader
extends Object
implements StructuredReader
```
Abstract base implementation of StructuredReader.

Nested Class Summary
- Nested classes/interfaces inherited from interface io.github.mmm.marshall.StructuredReader
  StructuredReader.State

Field Summary

Fields
Modifier and Type Field Description

protected MarshallingConfig config
The MarshallingConfig.

protected String name
The current name.

protected StructuredReader.State state

Constructor Summary

Constructors
Constructor Description

AbstractStructuredReader(MarshallingConfig config)
The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`expect(StructuredReader.State expected)`	Verifies that the `current state` is the same as the given states.
`protected void`	`expect(StructuredReader.State expected, StructuredReader.State expected2)`	Verifies that the `current state` is one of the given states.
`protected void`	`expect(StructuredReader.State expected, StructuredReader.State expected2, StructuredReader.State expected3)`	Verifies that the `current state` is one of the given states.
`protected void`	`expectNot(StructuredReader.State unexpected)`	Verifies that the `current state` is not the same as the given state.
`StructuredReader.State`	`getState()`
`protected RuntimeException`	`handleValueParseError(String value, Class<?> typeClass, Throwable e)`
`boolean`	`isDone()`
`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`.
`boolean`	`readEnd()`
`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`.
`boolean`	`readStartArray()`
`boolean`	`readStartObject()`
`Object`	`readValue(boolean recursive)`	Generic method to read and unmarshall a value supporting the build in types `Boolean`, `String`, and `Number`.
`BigDecimal`	`readValueAsBigDecimal()`
`BigInteger`	`readValueAsBigInteger()`
`Byte`	`readValueAsByte()`
`Double`	`readValueAsDouble()`
`Float`	`readValueAsFloat()`
`Integer`	`readValueAsInteger()`
`Long`	`readValueAsLong()`
`protected String`	`readValueAsNumberString()`
`Short`	`readValueAsShort()`
`void`	`skipValue()`	Skips the current value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.mmm.marshall.StructuredReader
close, next, readName, readValue, readValue, readValueAsBoolean, readValueAsString

- Field Detail
  - config
```
protected final MarshallingConfig config
```
    The MarshallingConfig.
  - name
```
protected String name
```
    The current name.
    
    See Also:
    
    StructuredReader.readName()
  - state
```
protected StructuredReader.State state
```
    See Also:
    
    getState()
- Constructor Detail
  - AbstractStructuredReader
```
public AbstractStructuredReader(MarshallingConfig config)
```
    The constructor.
    
    Parameters:
    
    config - the MarshallingConfig.
- Method Detail
  - getState
```
public StructuredReader.State getState()
```
    Specified by:
    
    getState in interface StructuredReader
    
    Returns:
    
    the current state of this reader.
  - readStartObject
```
public boolean readStartObject()
```
    Specified by:
    
    readStartObject in interface StructuredReader
    
    Returns:
    
    true if pointing to the start of an object, false otherwise.
    
    See Also:
    
    StructuredWriter.writeStartObject()
  - readStartArray
```
public boolean readStartArray()
```
    Specified by:
    
    readStartArray in interface StructuredReader
    
    Returns:
    
    true if pointing to the start of an object, false otherwise.
    
    See Also:
    
    StructuredWriter.writeStartArray()
  - readEnd
```
public boolean readEnd()
```
    Specified by:
    
    readEnd in interface StructuredReader
    
    Returns:
    
    true if the end of an array or object has been reached.
  - isDone
```
public boolean isDone()
```
    Specified by:
    
    isDone in interface StructuredReader
    
    Returns:
    
    true if all data has been read and the end of the stream has been reached, false otherwise.
  - readValueAsNumberString
```
protected String readValueAsNumberString()
```
    Returns:
    
    the value as String but assuring it as number.
    
    See Also:
    
    StructuredReader.readValueAsString()
  - expect
```
protected void expect(StructuredReader.State expected)
```
    Verifies that the current state is the same as the given states.
    
    Parameters:
    
    expected - first accepted state.
  - expect
```
protected void expect(StructuredReader.State expected,
                      StructuredReader.State expected2)
```
    Verifies that the current state is one of the given states.
    
    Parameters:
    
    expected - first accepted state.
    
    expected2 - second accepted state.
  - expect
```
protected void expect(StructuredReader.State expected,
                      StructuredReader.State expected2,
                      StructuredReader.State expected3)
```
    Verifies that the current state is one of the given states.
    
    Parameters:
    
    expected - first accepted state.
    
    expected2 - second accepted state.
    
    expected3 - third accepted state.
  - expectNot
```
protected void expectNot(StructuredReader.State unexpected)
```
    Verifies that the current state is not the same as the given state.
    
    Parameters:
    
    unexpected - the unexpected state.
  - handleValueParseError
```
protected RuntimeException handleValueParseError(String value,
                                                 Class<?> typeClass,
                                                 Throwable e)
```
    Parameters:
    
    value - the value that was read.
    
    typeClass - the expected type.
    
    e - a potential error that occurred or null if no cause.
    
    Returns:
    
    nothing. Will always throw IllegalStateException. However to signal the compiler that the program flow will exit with the call of this function you may prefix it with "throw".
  - readValueAsInteger
```
public Integer readValueAsInteger()
```
    Specified by:
    
    readValueAsInteger in interface StructuredReader
    
    Returns:
    
    reads the value as Integer.
    
    See Also:
    
    StructuredReader.readValue(Class)
  - readValueAsLong
```
public Long readValueAsLong()
```
    Specified by:
    
    readValueAsLong in interface StructuredReader
    
    Returns:
    
    reads the value as Long.
    
    See Also:
    
    StructuredReader.readValue(Class)
  - readValueAsDouble
```
public Double readValueAsDouble()
```
    Specified by:
    
    readValueAsDouble in interface StructuredReader
    
    Returns:
    
    reads the value as Double.
    
    See Also:
    
    StructuredReader.readValue(Class)
  - readValueAsFloat
```
public Float readValueAsFloat()
```
    Specified by:
    
    readValueAsFloat in interface StructuredReader
    
    Returns:
    
    reads the value as Float.
    
    See Also:
    
    StructuredReader.readValue(Class)
  - readValueAsShort
```
public Short readValueAsShort()
```
    Specified by:
    
    readValueAsShort in interface StructuredReader
    
    Returns:
    
    reads the value as Short.
    
    See Also:
    
    StructuredReader.readValue(Class)
  - readValueAsByte
```
public Byte readValueAsByte()
```
    Specified by:
    
    readValueAsByte in interface StructuredReader
    
    Returns:
    
    reads the value as Byte.
    
    See Also:
    
    StructuredReader.readValue(Class)
  - readValueAsBigInteger
```
public BigInteger readValueAsBigInteger()
```
    Specified by:
    
    readValueAsBigInteger in interface StructuredReader
    
    Returns:
    
    reads the value as BigInteger.
    
    See Also:
    
    StructuredReader.readValue(Class)
  - readValueAsBigDecimal
```
public BigDecimal readValueAsBigDecimal()
```
    Specified by:
    
    readValueAsBigDecimal in interface StructuredReader
    
    Returns:
    
    reads the value as BigDecimal.
    
    See Also:
    
    StructuredReader.readValue(Class)
  - readValue
```
public Object readValue(boolean recursive)
```
    Description copied from interface: StructuredReader
    
    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.
    
    Specified by:
    
    readValue in interface StructuredReader
    
    Parameters:
    
    recursive - - true for recursive reading of arrays as List and objects as Map, false otherwise.
    
    Returns:
    
    the unmarsahlled value. May be null.
  - readObject
```
public void readObject(Map<String,Object> map)
```
    Description copied from interface: StructuredReader
    
    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.
    
    Specified by:
    
    readObject in interface StructuredReader
    
    Parameters:
    
    map - the Map where to add the properties. Unlike StructuredReader.readValue(boolean) this allows you to choose the Map implementation.
  - readArray
```
public void readArray(Collection<Object> array)
```
    Description copied from interface: StructuredReader
    
    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.
    
    Specified by:
    
    readArray in interface StructuredReader
    
    Parameters:
    
    array - the Collection where to add the values.
  - skipValue
```
public void skipValue()
```
    Description copied from interface: StructuredReader
    Skips the current value. Should be called after StructuredReader.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.
    Specified by:
    
    skipValue in interface StructuredReader

Modifier and Type	Field	Description
`protected MarshallingConfig`	`config`	The `MarshallingConfig`.
`protected String`	`name`	The current name.
`protected StructuredReader.State`	`state`

Class AbstractStructuredReader

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.mmm.marshall.StructuredReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.mmm.marshall.StructuredReader

Field Detail

config

name

state

Constructor Detail

AbstractStructuredReader

Method Detail

getState

readStartObject

readStartArray

readEnd

isDone

readValueAsNumberString

expect

expect

expect

expectNot

handleValueParseError

readValueAsInteger

readValueAsLong

readValueAsDouble

readValueAsFloat

readValueAsShort

readValueAsByte

readValueAsBigInteger

readValueAsBigDecimal

readValue

readObject

readArray

skipValue