EventReader (slf4j-toys 1.6.0 API)

java.lang.Object
- org.usefultoys.slf4j.internal.EventReader

```
public class EventReader
extends java.lang.Object
```
Provides methods that implement recurrent deserialization patterns. The methods consist of a simplified parser of patterns produced by EventWriter.
To ease deserialization of one event and to reduce the amount of parameters, EventReader keeps state of the deserialization of the event. For sake of simplicity, the EventReader automatically consumes separators.
Thus, the instance might be shared and reused to reduce object creation overhead, as long as events are deserialized one after the other and within the same thread.

Constructor Summary

Constructors
Constructor and Description

EventReader()

Constructors
Constructor and Description
`EventReader()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`hasMore()`
`boolean`	`readBoolean()` Read the property value as boolean.
`double`	`readDouble()` Read the property value as double.
`double`	`readDoubleOrZero()` Read the property value as double or zero if values is empty.
`<T extends java.lang.Enum<T>> T`	`readEnum(java.lang.Class<T> c)` Read the property value as enumeration.
`long`	`readLong()` Read the property value as long integer.
`long`	`readLongOrZero()` Read the property value as long integer or zero if values is empty.
`java.util.Map<java.lang.String,java.lang.String>`	`readMap()` Read the property value as a map of string key and values.
`protected java.lang.String`	`readMapKey()`
`protected java.lang.String`	`readMapValue()`
`protected boolean`	`readOptionalSymbol(char symbol)` Consumes an optional symbol if available.
`protected java.lang.String`	`readPropertyKey()`
`java.lang.String`	`readPropertyName()` Read a name of the next expected incoming property.
`protected java.lang.String`	`readPropertyValue()`
`java.lang.String`	`readString()` Read the property value as string.
`protected void`	`readSymbol(char symbol)` Consumes an expected symbol.
`EventReader`	`reset(java.lang.String encodedData)`

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

- Constructor Detail
  - EventReader
```
public EventReader()
```
- Method Detail
  - reset
```
public EventReader reset(java.lang.String encodedData)
```
  - hasMore
```
public boolean hasMore()
```
    Returns:
    
    If there are more potentially incoming property.
  - readPropertyName
```
public java.lang.String readPropertyName()
                                  throws java.io.IOException
```
    Read a name of the next expected incoming property.
    
    Returns:
    
    The name of the property.
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property name.
  - readString
```
public java.lang.String readString()
                            throws java.io.IOException
```
    Read the property value as string. May be called several times if the property value is a tuple.
    
    Returns:
    
    the property value
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property value.
  - readBoolean
```
public boolean readBoolean()
                    throws java.io.IOException
```
    Read the property value as boolean. May be called several times if the property value is a tuple.
    
    Returns:
    
    the property value
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property value.
  - readEnum
```
public <T extends java.lang.Enum<T>> T readEnum(java.lang.Class<T> c)
                                         throws java.io.IOException
```
    Read the property value as enumeration. May be called several times if the property value is a tuple.
    
    Type Parameters:
    
    T - type of enumeration
    
    Parameters:
    
    c - class of enumeration
    
    Returns:
    
    the property value
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property value.
  - readLong
```
public long readLong()
              throws java.io.IOException
```
    Read the property value as long integer. May be called several times if the property value is a tuple.
    
    Returns:
    
    the property value
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property value.
  - readLongOrZero
```
public long readLongOrZero()
                    throws java.io.IOException
```
    Read the property value as long integer or zero if values is empty. May be called several times if the property value is a tuple.
    
    Returns:
    
    the property value
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property value.
  - readDouble
```
public double readDouble()
                  throws java.io.IOException
```
    Read the property value as double. May be called several times if the property value is a tuple.
    
    Returns:
    
    the property value
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property value.
  - readDoubleOrZero
```
public double readDoubleOrZero()
                        throws java.io.IOException
```
    Read the property value as double or zero if values is empty. May be called several times if the property value is a tuple.
    
    Returns:
    
    the property value
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property value.
  - readSymbol
```
protected void readSymbol(char symbol)
                   throws java.io.IOException
```
    Consumes an expected symbol.
    
    Parameters:
    
    symbol - the expected symbol.
    
    Throws:
    
    java.io.IOException - All chars were consumed or incoming char is not the expected symbol.
  - readOptionalSymbol
```
protected boolean readOptionalSymbol(char symbol)
                              throws java.io.IOException
```
    Consumes an optional symbol if available.
    
    Parameters:
    
    symbol - the optionally expected symbol.
    
    Returns:
    
    true if the consumed char was the symbol, false otherwise.
    
    Throws:
    
    java.io.IOException - All chars were consumed.
  - readMap
```
public java.util.Map<java.lang.String,java.lang.String> readMap()
                                                         throws java.io.IOException
```
    Read the property value as a map of string key and values.
    
    Returns:
    
    the map
    
    Throws:
    
    java.io.IOException - Incoming chars are not a valid property value.
  - readMapKey
```
protected java.lang.String readMapKey()
                               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readMapValue
```
protected java.lang.String readMapValue()
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readPropertyValue
```
protected java.lang.String readPropertyValue()
                                      throws java.io.EOFException
```
    Throws:
    
    java.io.EOFException
  - readPropertyKey
```
protected java.lang.String readPropertyKey()
                                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException

Class EventReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventReader

Method Detail

reset

hasMore

readPropertyName

readString

readBoolean

readEnum

readLong

readLongOrZero

readDouble

readDoubleOrZero

readSymbol

readOptionalSymbol

readMap

readMapKey

readMapValue

readPropertyValue

readPropertyKey