JSONStreamReader.ParseState

java.lang.Object
- java.lang.Enum<JSONStreamReader.ParseState>
- - org.json.stream.JSONStreamReader.ParseState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JSONStreamReader.ParseState>

Enclosing class:

JSONStreamReader
```
public static enum JSONStreamReader.ParseState
extends java.lang.Enum<JSONStreamReader.ParseState>
```
States of the internal state machine. Tokens returned from the nextState() loop are a subset of these states.
The states are similar in convention to the write methods in JSONWriter, such as pairing OBJECT with END_OBJECT, and ARRAY with END_ARRAY.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARRAY` Start a JSON array
`BOOLEAN_VALUE` The `Boolean.TRUE` or `Boolean.FALSE` value
`DOCUMENT` Start a JSON document
`END_ARRAY` End a JSON array
`END_DOCUMENT` End a JSON document
`END_OBJECT` End a JSON object
`INIT` Internal state -- before the DOCUMENT state
`KEY` A key of a JSON object
`KEY_SEPARATOR` Internal state -- between a KEY and *_VALUE states
`NULL_VALUE` The `JSONObject.Null` value
`NUMBER_VALUE` A `Number` value
`OBJECT` Start a JSON object
`STRING_VALUE` A `String` value
`VALUE_SEPARATOR` Internal state -- after a *_VALUE state

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isArrayDelimiter()` Is this state an array delimiter -- that is, either an `ARRAY` or an `END_ARRAY` state.
`boolean`	`isBeginStructure()` Is this state a beginning of a JSON structure -- that is, one of `DOCUMENT`, `OBJECT`, or `ARRAY`.
`boolean`	`isDocumentDelimiter()` Is this state a document delimiter -- that is, either a `DOCUMENT` or an `END_DOCUMENT` state.
`boolean`	`isEndStructure()` Is this state an end of a JSON structure -- that is, one of `END_DOCUMENT`, `END_OBJECT`, or `END_ARRAY`.
`boolean`	`isInternal()` Is this state an internal state -- that is, one that would not be returned from the `nextState()` method.
`boolean`	`isObjectDelimiter()` Is this state an object delimiter -- that is, either an `OBJECT` or an `END_OBJECT` state.
`boolean`	`isSeparator()` Is this state a separator -- that is, either a `KEY_SEPARATOR` or a `VALUE_SEPARATOR`.
`boolean`	`isText()` Is this state a text state -- that is, either a `KEY` or a `STRING_VALUE` state.
`boolean`	`isValue()` Is this state a value state -- that is, one of `NULL_VALUE`, `BOOLEAN_VALUE`, `NUMBER_VALUE`, or `STRING_VALUE`
`static JSONStreamReader.ParseState`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static JSONStreamReader.ParseState[]`	`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
  - INIT
```
public static final JSONStreamReader.ParseState INIT
```
    Internal state -- before the DOCUMENT state
  - DOCUMENT
```
public static final JSONStreamReader.ParseState DOCUMENT
```
    Start a JSON document
  - OBJECT
```
public static final JSONStreamReader.ParseState OBJECT
```
    Start a JSON object
  - END_OBJECT
```
public static final JSONStreamReader.ParseState END_OBJECT
```
    End a JSON object
  - ARRAY
```
public static final JSONStreamReader.ParseState ARRAY
```
    Start a JSON array
  - END_ARRAY
```
public static final JSONStreamReader.ParseState END_ARRAY
```
    End a JSON array
  - KEY_SEPARATOR
```
public static final JSONStreamReader.ParseState KEY_SEPARATOR
```
    Internal state -- between a KEY and *_VALUE states
  - VALUE_SEPARATOR
```
public static final JSONStreamReader.ParseState VALUE_SEPARATOR
```
    Internal state -- after a *_VALUE state
  - KEY
```
public static final JSONStreamReader.ParseState KEY
```
    A key of a JSON object
  - NULL_VALUE
```
public static final JSONStreamReader.ParseState NULL_VALUE
```
    The JSONObject.Null value
  - BOOLEAN_VALUE
```
public static final JSONStreamReader.ParseState BOOLEAN_VALUE
```
    The Boolean.TRUE or Boolean.FALSE value
  - NUMBER_VALUE
```
public static final JSONStreamReader.ParseState NUMBER_VALUE
```
    A Number value
  - STRING_VALUE
```
public static final JSONStreamReader.ParseState STRING_VALUE
```
    A String value
  - END_DOCUMENT
```
public static final JSONStreamReader.ParseState END_DOCUMENT
```
    End a JSON document
- Method Detail
  - values
```
public static JSONStreamReader.ParseState[] 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 (JSONStreamReader.ParseState c : JSONStreamReader.ParseState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JSONStreamReader.ParseState valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - isInternal
```
public boolean isInternal()
```
    Is this state an internal state -- that is, one that would not be returned from the nextState() method.
    
    Returns:
    
    true to indicate an internal state, otherwise false
  - isValue
```
public boolean isValue()
```
    Is this state a value state -- that is, one of NULL_VALUE, BOOLEAN_VALUE, NUMBER_VALUE, or STRING_VALUE
    
    Returns:
    
    true to indicate a value state, otherwise false
  - isBeginStructure
```
public boolean isBeginStructure()
```
    Is this state a beginning of a JSON structure -- that is, one of DOCUMENT, OBJECT, or ARRAY.
    
    Returns:
    
    true to indicate a beginning of a JSON structure, otherwise false
  - isEndStructure
```
public boolean isEndStructure()
```
    Is this state an end of a JSON structure -- that is, one of END_DOCUMENT, END_OBJECT, or END_ARRAY.
    
    Returns:
    
    true to indicate an end of a JSON structure, otherwise false
  - isText
```
public boolean isText()
```
    Is this state a text state -- that is, either a KEY or a STRING_VALUE state.
    
    Returns:
    
    true to indicate a text state, otherwise false
  - isDocumentDelimiter
```
public boolean isDocumentDelimiter()
```
    Is this state a document delimiter -- that is, either a DOCUMENT or an END_DOCUMENT state.
    
    Returns:
    
    true to indicate a document delimiter state, otherwise false
  - isObjectDelimiter
```
public boolean isObjectDelimiter()
```
    Is this state an object delimiter -- that is, either an OBJECT or an END_OBJECT state.
    
    Returns:
    
    true to indicate an object delimiter state, otherwise false
  - isArrayDelimiter
```
public boolean isArrayDelimiter()
```
    Is this state an array delimiter -- that is, either an ARRAY or an END_ARRAY state.
    
    Returns:
    
    true to indicate an array delimiter state, otherwise false
  - isSeparator
```
public boolean isSeparator()
```
    Is this state a separator -- that is, either a KEY_SEPARATOR or a VALUE_SEPARATOR.
    
    Returns:
    
    true to indicate a separator, otherwise false

Enum JSONStreamReader.ParseState

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INIT

DOCUMENT

OBJECT

END_OBJECT

ARRAY

END_ARRAY

KEY_SEPARATOR

VALUE_SEPARATOR

KEY

NULL_VALUE

BOOLEAN_VALUE

NUMBER_VALUE

STRING_VALUE

END_DOCUMENT

Method Detail

values

valueOf

isInternal

isValue

isBeginStructure

isEndStructure

isText

isDocumentDelimiter

isObjectDelimiter

isArrayDelimiter

isSeparator