JsonReader (apollo-runtime 1.0.0-alpha API)

java.lang.Object
- com.apollographql.apollo.internal.json.JsonReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

BufferedSourceJsonReader
```
public abstract class JsonReader
extends java.lang.Object
implements java.io.Closeable
```
TODO add Modifications copyright

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JsonReader.Token
A structure, name, or value type in a JSON-encoded string.

Nested Classes
Modifier and Type	Class and Description
`static class`	`JsonReader.Token` A structure, name, or value type in a JSON-encoded string.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract void`	`beginArray()` Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.
`abstract void`	`beginObject()` Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.
`abstract void`	`endArray()` Consumes the next token from the JSON stream and asserts that it is the end of the current array.
`abstract void`	`endObject()` Consumes the next token from the JSON stream and asserts that it is the end of the current object.
`abstract boolean`	`failOnUnknown()` Returns true if this parser forbids skipping values.
`abstract java.lang.String`	`getPath()` Returns a JsonPath to the current location in the JSON value.
`abstract boolean`	`hasNext()` Returns true if the current array or object has another element.
`abstract boolean`	`isLenient()` Returns true if this parser is liberal in what it accepts.
`abstract boolean`	`nextBoolean()` Returns the boolean value of the next token, consuming it.
`abstract double`	`nextDouble()` Returns the double value of the next token, consuming it.
`abstract int`	`nextInt()` Returns the int value of the next token, consuming it.
`abstract long`	`nextLong()` Returns the long value of the next token, consuming it.
`abstract java.lang.String`	`nextName()` Returns the next token, a property name, and consumes it.
`abstract <T> T`	`nextNull()` Consumes the next token from the JSON stream and asserts that it is a literal null.
`abstract java.lang.String`	`nextString()` Returns the string value of the next token, consuming it.
`abstract JsonReader.Token`	`peek()` Returns the type of the next token without consuming it.
`abstract void`	`setFailOnUnknown(boolean failOnUnknown)` Configure whether this parser throws a `JsonDataException` when `skipValue()` is called.
`abstract void`	`setLenient(boolean lenient)` Configure this parser to be liberal in what it accepts.
`abstract void`	`skipValue()` Skips the next value recursively.

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

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - setLenient
```
public abstract void setLenient(boolean lenient)
```
    Configure this parser to be liberal in what it accepts. By default this parser is strict and only accepts JSON as specified by RFC 7159. Setting the parser to lenient causes it to ignore the following syntax errors:
    - Streams that include multiple top-level values. With strict parsing, each stream must contain exactly one top-level value.
    - Numbers may be NaNs or infinities.
    - End of line comments starting with // or # and ending with a newline character.
    - C-style comments starting with /* and ending with */. Such comments may not be nested.
    - Names that are unquoted or 'single quoted'.
    - Strings that are unquoted or 'single quoted'.
    - Array elements separated by ; instead of ,.
    - Unnecessary array separators. These are interpreted as if null was the omitted value.
    - Names and values separated by = or => instead of :.
    - Name/value pairs separated by ; instead of ,.
  - isLenient
```
public abstract boolean isLenient()
```
    Returns true if this parser is liberal in what it accepts.
  - setFailOnUnknown
```
public abstract void setFailOnUnknown(boolean failOnUnknown)
```
    Configure whether this parser throws a JsonDataException when skipValue() is called. By default this parser permits values to be skipped.
    Forbid skipping to prevent unrecognized values from being silently ignored. This option is useful in development and debugging because it means a typo like "locatiom" will be detected early. It's potentially harmful in production because it complicates revising a JSON schema.
  - failOnUnknown
```
public abstract boolean failOnUnknown()
```
    Returns true if this parser forbids skipping values.
  - beginArray
```
public abstract void beginArray()
                         throws java.io.IOException
```
    Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.
    
    Throws:
    
    java.io.IOException
  - endArray
```
public abstract void endArray()
                       throws java.io.IOException
```
    Consumes the next token from the JSON stream and asserts that it is the end of the current array.
    
    Throws:
    
    java.io.IOException
  - beginObject
```
public abstract void beginObject()
                          throws java.io.IOException
```
    Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.
    
    Throws:
    
    java.io.IOException
  - endObject
```
public abstract void endObject()
                        throws java.io.IOException
```
    Consumes the next token from the JSON stream and asserts that it is the end of the current object.
    
    Throws:
    
    java.io.IOException
  - hasNext
```
public abstract boolean hasNext()
                         throws java.io.IOException
```
    Returns true if the current array or object has another element.
    
    Throws:
    
    java.io.IOException
  - peek
```
public abstract JsonReader.Token peek()
                               throws java.io.IOException
```
    Returns the type of the next token without consuming it.
    
    Throws:
    
    java.io.IOException
  - nextName
```
public abstract java.lang.String nextName()
                                   throws java.io.IOException
```
    Returns the next token, a property name, and consumes it.
    
    Throws:
    
    JsonDataException - if the next token in the stream is not a property name.
    
    java.io.IOException
  - nextString
```
public abstract java.lang.String nextString()
                                     throws java.io.IOException
```
    Returns the string value of the next token, consuming it. If the next token is a number, this method will return its string form.
    
    Throws:
    
    JsonDataException - if the next token is not a string or if this reader is closed.
    
    java.io.IOException
  - nextBoolean
```
public abstract boolean nextBoolean()
                             throws java.io.IOException
```
    Returns the boolean value of the next token, consuming it.
    
    Throws:
    
    JsonDataException - if the next token is not a boolean or if this reader is closed.
    
    java.io.IOException
  - nextNull
```
public abstract <T> T nextNull()
                        throws java.io.IOException
```
    Consumes the next token from the JSON stream and asserts that it is a literal null. Returns null.
    
    Throws:
    
    JsonDataException - if the next token is not null or if this reader is closed.
    
    java.io.IOException
  - nextDouble
```
public abstract double nextDouble()
                           throws java.io.IOException
```
    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).
    
    Throws:
    
    JsonDataException - if the next token is not a literal value, or if the next literal value cannot be parsed as a double, or is non-finite.
    
    java.io.IOException
  - nextLong
```
public abstract long nextLong()
                       throws java.io.IOException
```
    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.
    
    Throws:
    
    JsonDataException - if the next token is not a literal value, if the next literal value cannot be parsed as a number, or exactly represented as a long.
    
    java.io.IOException
  - nextInt
```
public abstract int nextInt()
                     throws java.io.IOException
```
    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.
    
    Throws:
    
    JsonDataException - if the next token is not a literal value, if the next literal value cannot be parsed as a number, or exactly represented as an int.
    
    java.io.IOException
  - skipValue
```
public abstract void skipValue()
                        throws java.io.IOException
```
    Skips the next value recursively. If it is an object or array, all nested elements are skipped. This method is intended for use when the JSON token stream contains unrecognized or unhandled values.
    This throws a JsonDataException if this parser has been configured to fail on unknown values.
    
    Throws:
    
    java.io.IOException
  - getPath
```
public abstract java.lang.String getPath()
```
    Returns a JsonPath to the current location in the JSON value.

Class JsonReader

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Method Detail

setLenient

isLenient

setFailOnUnknown

failOnUnknown

beginArray

endArray

beginObject

endObject

hasNext

peek

nextName

nextString

nextBoolean

nextNull

nextDouble

nextLong

nextInt

skipValue

getPath