JsonReader (FOSS Nova JSON API 1.0.0 API)

All Superinterfaces:

java.lang.AutoCloseable
```
public interface JsonReader
extends java.lang.AutoCloseable
```
JSON reader.

Author:

Richard Opalka

See Also:

JsonStreamFactory

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Free resources associated with this reader.
`java.math.BigDecimal`	`getBigDecimal()` Converts available context data to `BigDecimal`.
`java.math.BigInteger`	`getBigInteger()` Converts available context data to `BigInteger`.
`boolean`	`getBoolean()` Converts available context data to `boolean`.
`byte`	`getByte()` Converts available context data to `byte`.
`double`	`getDouble()` Converts available context data to `double`.
`float`	`getFloat()` Converts available context data to `float`.
`int`	`getInt()` Converts available context data to `int`.
`long`	`getLong()` Converts available context data to `long`.
`short`	`getShort()` Converts available context data to `short`.
`java.lang.String`	`getString()` Converts available context data to `String`.
`boolean`	`hasNext()` Detects if there is next JSON parsing event available.
`boolean`	`isArrayEnd()` Returns `true` if current JSON parsing event is JSON `array end` token, false otherwise.
`boolean`	`isArrayStart()` Returns `true` if current JSON parsing event is JSON `array start` token, false otherwise.
`boolean`	`isBoolean()` Returns `true` if current JSON parsing event is JSON `boolean` token, false otherwise.
`boolean`	`isNull()` Returns `true` if current JSON parsing event is JSON `null` token, false otherwise.
`boolean`	`isNumber()` Returns `true` if current JSON parsing event is JSON `number`, false otherwise.
`boolean`	`isObjectEnd()` Returns `true` if current JSON parsing event is JSON `object end` token, false otherwise.
`boolean`	`isObjectStart()` Returns `true` if current JSON parsing event is JSON `object start` token, false otherwise.
`boolean`	`isString()` Returns `true` if current JSON parsing event is JSON `string`, false otherwise.
`JsonEvent`	`next()` Returns next JSON parsing event.

- Method Detail
  - hasNext
```
boolean hasNext()
```
    Detects if there is next JSON parsing event available. Users should call this method before calling next() method.
    
    Returns:
    
    true if there are more JSON parsing events, false otherwise
  - next
```
JsonEvent next()
        throws java.io.IOException,
               JsonException
```
    Returns next JSON parsing event. Users should call hasNext() before calling this method.
    
    Returns:
    
    JsonEvent next event
    
    Throws:
    
    java.io.IOException - if some I/O error occurs
    
    JsonException - if wrong JSON is detected
  - isObjectStart
```
boolean isObjectStart()
```
    Returns true if current JSON parsing event is JSON object start token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to JSON object start token, false otherwise
  - isObjectEnd
```
boolean isObjectEnd()
```
    Returns true if current JSON parsing event is JSON object end token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to JSON object end token, false otherwise
  - isArrayStart
```
boolean isArrayStart()
```
    Returns true if current JSON parsing event is JSON array start token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to JSON array start token, false otherwise
  - isArrayEnd
```
boolean isArrayEnd()
```
    Returns true if current JSON parsing event is JSON array end token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to JSON array end token, false otherwise
  - isNull
```
boolean isNull()
```
    Returns true if current JSON parsing event is JSON null token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to JSON null token, false otherwise
  - isString
```
boolean isString()
```
    Returns true if current JSON parsing event is JSON string, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to JSON string, false otherwise
  - getString
```
java.lang.String getString()
```
    Converts available context data to String. Users have to call next() and should call isString() before calling this method.
    
    Returns:
    
    string the parsing cursor is pointing to
    
    Throws:
    
    java.lang.IllegalStateException - if cursor isn't pointing to JSON String
  - isBoolean
```
boolean isBoolean()
```
    Returns true if current JSON parsing event is JSON boolean token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor points to JSON boolean tokens, false otherwise
  - getBoolean
```
boolean getBoolean()
```
    Converts available context data to boolean. Users have to call next() and should call isBoolean() before calling this method.
    
    Returns:
    
    boolean value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.IllegalStateException - if cursor isn't pointing to JSON boolean token
  - isNumber
```
boolean isNumber()
```
    Returns true if current JSON parsing event is JSON number, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor points to JSON number, false otherwise
  - getByte
```
byte getByte()
```
    Converts available context data to byte. Users have to call next() and should call isNumber() before calling this method.
    
    Returns:
    
    byte value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.NumberFormatException - if JSON number is not convertible to byte
  - getShort
```
short getShort()
```
    Converts available context data to short. Users have to call next() and should call isNumber() before calling this method.
    
    Returns:
    
    short value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.NumberFormatException - if JSON number is not convertible to short
  - getInt
```
int getInt()
```
    Converts available context data to int. Users have to call next() and should call isNumber() before calling this method.
    
    Returns:
    
    integer value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.NumberFormatException - if JSON number is not convertible to int
  - getLong
```
long getLong()
```
    Converts available context data to long. Users have to call next() and should call isNumber() before calling this method.
    
    Returns:
    
    long value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.NumberFormatException - if JSON number is not convertible to long
  - getFloat
```
float getFloat()
```
    Converts available context data to float. Users have to call next() and should call isNumber() before calling this method.
    
    Returns:
    
    float value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.NumberFormatException - if JSON number is not convertible to float
  - getDouble
```
double getDouble()
```
    Converts available context data to double. Users have to call next() and should call isNumber() before calling this method.
    
    Returns:
    
    double value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.NumberFormatException - if JSON number is not convertible to double
  - getBigInteger
```
java.math.BigInteger getBigInteger()
```
    Converts available context data to BigInteger. Users have to call next() and should call isNumber() before calling this method.
    
    Returns:
    
    BigInteger value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.NumberFormatException - if JSON number is not convertible to BigInteger
  - getBigDecimal
```
java.math.BigDecimal getBigDecimal()
```
    Converts available context data to BigDecimal. Users have to call next() and should call isNumber() before calling this method.
    
    Returns:
    
    BigDecimal value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.NumberFormatException - if JSON number is not convertible to BigDecimal
  - close
```
void close()
    throws java.io.IOException,
           JsonException
```
    Free resources associated with this reader. Closes underlying input stream or reader.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException - if some I/O error occurs
    
    JsonException - if wrong JSON is detected

Interface JsonReader

Method Summary

Method Detail

hasNext

next

isObjectStart

isObjectEnd

isArrayStart

isArrayEnd

isNull

isString

getString

isBoolean

getBoolean

isNumber

getByte

getShort

getInt

getLong

getFloat

getDouble

getBigInteger

getBigDecimal

close