java.lang.Object
- com.google.gson.stream.JsonReader
- - com.google.gson.internal.bind.JsonTreeReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public final class JsonTreeReader
extends JsonReader
```
This reader walks the elements of a JsonElement as if it was coming from a character stream.

Field Summary

Fields
Modifier and Type	Field	Description
`private int[]`	`pathIndices`
`private java.lang.String[]`	`pathNames`
`private static java.lang.Object`	`SENTINEL_CLOSED`
`private java.lang.Object[]`	`stack`	The nesting stack.
`private int`	`stackSize`	The used size of `stack`; the value at `stackSize - 1` is the value last placed on the stack.
`private static java.io.Reader`	`UNREADABLE_READER`

Constructor Summary

Constructors
Constructor Description

JsonTreeReader(JsonElement element)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`beginArray()`	Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.
`void`	`beginObject()`	Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.
`void`	`close()`	Closes this JSON reader and the underlying `Reader`.
`void`	`endArray()`	Consumes the next token from the JSON stream and asserts that it is the end of the current array.
`void`	`endObject()`	Consumes the next token from the JSON stream and asserts that it is the end of the current object.
`private void`	`expect(JsonToken expected)`
`java.lang.String`	`getPath()`	Returns a JSONPath in dot-notation to the next (or current) location in the JSON document.
`private java.lang.String`	`getPath(boolean usePreviousPath)`
`java.lang.String`	`getPreviousPath()`	Returns a JSONPath in dot-notation to the previous (or current) location in the JSON document.
`boolean`	`hasNext()`	Returns true if the current array or object has another element.
`private java.lang.String`	`locationString()`
`boolean`	`nextBoolean()`	Returns the `boolean` value of the next token, consuming it.
`double`	`nextDouble()`	Returns the `double` value of the next token, consuming it.
`int`	`nextInt()`	Returns the `int` value of the next token, consuming it.
`(package private) JsonElement`	`nextJsonElement()`
`long`	`nextLong()`	Returns the `long` value of the next token, consuming it.
`java.lang.String`	`nextName()`	Returns the next token, a `property name`, and consumes it.
`private java.lang.String`	`nextName(boolean skipName)`
`void`	`nextNull()`	Consumes the next token from the JSON stream and asserts that it is a literal null.
`java.lang.String`	`nextString()`	Returns the `string` value of the next token, consuming it.
`JsonToken`	`peek()`	Returns the type of the next token without consuming it.
`private java.lang.Object`	`peekStack()`
`private java.lang.Object`	`popStack()`
`void`	`promoteNameToValue()`
`private void`	`push(java.lang.Object newTop)`
`void`	`skipValue()`	Skips the next value recursively.
`java.lang.String`	`toString()`

Methods inherited from class com.google.gson.stream.JsonReader
getNestingLimit, getStrictness, isLenient, setLenient, setNestingLimit, setStrictness

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

- Field Detail
  - UNREADABLE_READER
```
private static final java.io.Reader UNREADABLE_READER
```
  - SENTINEL_CLOSED
```
private static final java.lang.Object SENTINEL_CLOSED
```
  - stack
```
private java.lang.Object[] stack
```
    The nesting stack. Using a manual array rather than an ArrayList saves 20%.
  - stackSize
```
private int stackSize
```
    The used size of stack; the value at stackSize - 1 is the value last placed on the stack. stackSize might differ from the nesting depth, because the stack also contains temporary additional objects, for example for a JsonArray it contains the JsonArray object as well as the corresponding iterator.
  - pathNames
```
private java.lang.String[] pathNames
```
  - pathIndices
```
private int[] pathIndices
```
- Constructor Detail
  - JsonTreeReader
```
public JsonTreeReader(JsonElement element)
```
- Method Detail
  - beginArray
```
public void beginArray()
                throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.
    
    Overrides:
    
    beginArray in class JsonReader
    
    Throws:
    
    java.io.IOException
  - endArray
```
public void endArray()
              throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Consumes the next token from the JSON stream and asserts that it is the end of the current array.
    
    Overrides:
    
    endArray in class JsonReader
    
    Throws:
    
    java.io.IOException
  - beginObject
```
public void beginObject()
                 throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.
    
    Overrides:
    
    beginObject in class JsonReader
    
    Throws:
    
    java.io.IOException
  - endObject
```
public void endObject()
               throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Consumes the next token from the JSON stream and asserts that it is the end of the current object.
    
    Overrides:
    
    endObject in class JsonReader
    
    Throws:
    
    java.io.IOException
  - hasNext
```
public boolean hasNext()
                throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Returns true if the current array or object has another element.
    
    Overrides:
    
    hasNext in class JsonReader
    
    Throws:
    
    java.io.IOException
  - peek
```
public JsonToken peek()
               throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Returns the type of the next token without consuming it.
    
    Overrides:
    
    peek in class JsonReader
    
    Throws:
    
    java.io.IOException
  - peekStack
```
private java.lang.Object peekStack()
```
  - popStack
```
private java.lang.Object popStack()
```
  - expect
```
private void expect(JsonToken expected)
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - nextName
```
private java.lang.String nextName(boolean skipName)
                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - nextName
```
public java.lang.String nextName()
                          throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Returns the next token, a property name, and consumes it.
    
    Overrides:
    
    nextName in class JsonReader
    
    Throws:
    
    java.io.IOException
  - nextString
```
public java.lang.String nextString()
                            throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Returns the string value of the next token, consuming it. If the next token is a number, this method will return its string form.
    
    Overrides:
    
    nextString in class JsonReader
    
    Throws:
    
    java.io.IOException
  - nextBoolean
```
public boolean nextBoolean()
                    throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Returns the boolean value of the next token, consuming it.
    
    Overrides:
    
    nextBoolean in class JsonReader
    
    Throws:
    
    java.io.IOException
  - nextNull
```
public void nextNull()
              throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Consumes the next token from the JSON stream and asserts that it is a literal null.
    
    Overrides:
    
    nextNull in class JsonReader
    
    Throws:
    
    java.io.IOException
  - nextDouble
```
public double nextDouble()
                  throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Returns the double value of the next token, consuming it. If the next token is a string, this method will attempt to parse it as a double using Double.parseDouble(String).
    
    Overrides:
    
    nextDouble in class JsonReader
    
    Throws:
    
    MalformedJsonException - if the next literal value is NaN or Infinity and this reader is not lenient.
    
    java.io.IOException
  - nextLong
```
public long nextLong()
              throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Returns the long value of the next token, consuming it. If the next token is a string, this method will attempt to parse it as a long. If the next token's numeric value cannot be exactly represented by a Java long, this method throws.
    
    Overrides:
    
    nextLong in class JsonReader
    
    Throws:
    
    java.io.IOException
  - nextInt
```
public int nextInt()
            throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Returns the int value of the next token, consuming it. If the next token is a string, this method will attempt to parse it as an int. If the next token's numeric value cannot be exactly represented by a Java int, this method throws.
    
    Overrides:
    
    nextInt in class JsonReader
    
    Throws:
    
    java.io.IOException
  - nextJsonElement
```
JsonElement nextJsonElement()
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    Description copied from class: JsonReader
    
    Closes this JSON reader and the underlying Reader.
    Using the JSON reader after it has been closed will throw an IllegalStateException in most cases.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Overrides:
    
    close in class JsonReader
    
    Throws:
    
    java.io.IOException
  - skipValue
```
public void skipValue()
               throws java.io.IOException
```
    Description copied from class: JsonReader
    Skips the next value recursively. This method is intended for use when the JSON token stream contains unrecognized or unhandled values.
    The behavior depends on the type of the next JSON token:
    
    Start of a JSON array or object: It and all of its nested values are skipped.
    Primitive value (for example a JSON number): The primitive value is skipped.
    Property name: Only the name but not the value of the property is skipped. skipValue() has to be called again to skip the property value as well.
    End of a JSON array or object: Only this end token is skipped.
    End of JSON document: Skipping has no effect, the next token continues to be the end of the document.
    Overrides:
    
    skipValue in class JsonReader
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class JsonReader
  - promoteNameToValue
```
public void promoteNameToValue()
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - push
```
private void push(java.lang.Object newTop)
```
  - getPath
```
private java.lang.String getPath(boolean usePreviousPath)
```
  - getPath
```
public java.lang.String getPath()
```
    Description copied from class: JsonReader
    Returns a JSONPath in dot-notation to the next (or current) location in the JSON document. That means:
    
    For JSON arrays the path points to the index of the next element (even if there are no further elements).
    For JSON objects the path points to the last property, or to the current property if its name has already been consumed.
    
    This method can be useful to add additional context to exception messages before a value is consumed, for example when the peeked token is unexpected.
    Overrides:
    
    getPath in class JsonReader
  - getPreviousPath
```
public java.lang.String getPreviousPath()
```
    Description copied from class: JsonReader
    Returns a JSONPath in dot-notation to the previous (or current) location in the JSON document. That means:
    
    For JSON arrays the path points to the index of the previous element.
    If no element has been consumed yet it uses the index 0 (even if there are no elements).
    For JSON objects the path points to the last property, or to the current property if its name has already been consumed.
    
    This method can be useful to add additional context to exception messages after a value has been consumed.
    Overrides:
    
    getPreviousPath in class JsonReader
  - locationString
```
private java.lang.String locationString()
```

Class JsonTreeReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.google.gson.stream.JsonReader

Methods inherited from class java.lang.Object

Field Detail

UNREADABLE_READER

SENTINEL_CLOSED

stack

stackSize

pathNames

pathIndices

Constructor Detail

JsonTreeReader

Method Detail

beginArray

endArray

beginObject

endObject

hasNext

peek

peekStack

popStack

expect

nextName

nextName

nextString

nextBoolean

nextNull

nextDouble

nextLong

nextInt

nextJsonElement

close

skipValue

toString

promoteNameToValue

push

getPath

getPath

getPreviousPath

locationString