java.lang.Object
- java.lang.Enum<StructuredReader.State>
- - io.github.mmm.marshall.StructuredReader.State

All Implemented Interfaces:

Serializable, Comparable<StructuredReader.State>

Enclosing interface:

StructuredReader
```
public static enum StructuredReader.State
extends Enum<StructuredReader.State>
```
Enum with the possible states of a StructuredReader.

See Also:

StructuredReader.getState()

Enum Constant Summary

Enum Constants
Enum Constant	Description
`DONE`	End of data.
`END_ARRAY`	End of an array.
`END_OBJECT`	End of an object.
`NAME`	Name of a property.
`START_ARRAY`	Start of an array.
`START_OBJECT`	Start of an object.
`VALUE`	A regular value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isEnd()`
`boolean`	`isStart()`
`static StructuredReader.State`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static StructuredReader.State[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - START_ARRAY
```
public static final StructuredReader.State START_ARRAY
```
    Start of an array.
    
    See Also:
    
    StructuredReader.readStartArray()
  - START_OBJECT
```
public static final StructuredReader.State START_OBJECT
```
    Start of an object.
    
    See Also:
    
    StructuredReader.readStartObject()
  - VALUE
```
public static final StructuredReader.State VALUE
```
    A regular value.
    
    See Also:
    
    StructuredReader.readValue()
  - NAME
```
public static final StructuredReader.State NAME
```
    Name of a property.
    
    See Also:
    
    StructuredReader.readName()
  - END_ARRAY
```
public static final StructuredReader.State END_ARRAY
```
    End of an array.
    
    See Also:
    
    StructuredReader.readEnd(), StructuredReader.readStartArray()
  - END_OBJECT
```
public static final StructuredReader.State END_OBJECT
```
    End of an object.
    
    See Also:
    
    StructuredReader.readEnd(), StructuredReader.readStartObject()
  - DONE
```
public static final StructuredReader.State DONE
```
    End of data.
    
    See Also:
    
    StructuredReader.isDone()
- Method Detail
  - values
```
public static StructuredReader.State[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (StructuredReader.State c : StructuredReader.State.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StructuredReader.State valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isStart
```
public boolean isStart()
```
    Returns:
    
    true if a start StructuredReader.State such as START_ARRAY or START_OBJECT, false otherwise.
  - isEnd
```
public boolean isEnd()
```
    Returns:
    
    true if an end StructuredReader.State such as END_ARRAY or END_OBJECT, false otherwise.

Enum StructuredReader.State

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

START_ARRAY

START_OBJECT

VALUE

NAME

END_ARRAY

END_OBJECT

DONE

Method Detail

values

valueOf

isStart

isEnd