net.markenwerk.utils.json.parser

Interface JsonPullParser

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

JsonSourcePullParser

public interface JsonPullParser
extends Closeable

A JsonPullParser is an event based JSON parser. It reports it's current JsonState and, depending on that JsonState, allows different ways to consume the underlying JSON document.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Method Summary

Modifier and Type	Method and Description
void	beginArray() Ensures that the current JsonState is JsonState.ARRAY_BEGIN and consumes the beginning of a JSON array.
void	beginDocument() Ensures that the current JsonState is JsonState.DOCUMENT_BEGIN and consumes the begin of the JSON document.
void	beginObject() Ensures that the current JsonState is JsonState.OBJECT_BEGIN and consumes the beginning of a JSON object.
JsonState	currentState() Reads, if necessary, from the underlying Reader and describes the current JsonState of this JsonSourcePullParser, which describes the next type of value or structural element of the JSON document.
void	endArray() Ensures that the current JsonState is JsonState.ARRAY_END and consumes the end of the JSON array.
void	endDocument() Ensures that the current JsonState is JsonState.DOCUMENT_END and consumes the end of the JSON document.
void	endObject() Ensures that the current JsonState is JsonState.OBJECT_END and consumes the end of the JSON object.
int	getColumn() Returns the column that corresponds to the current position of the underlying JsonSource in the character sequence, as if the character source was a regular file.
int	getLine() Returns the line that corresponds to the current position of the underlying JsonSource in the character sequence, as if the character source was a regular file.
boolean	hasNext() Returns whether the current JSON array or JSON object has more elements.
boolean	nextBoolean() Ensures that the current JsonState is JsonState.BOOLEAN and consumes and returns the corresponding value.
byte	nextByte() Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value as a byte.
char	nextCharacter() Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value as a char.
double	nextDouble() Ensures that the current JsonState is JsonState.DOUBLE and consumes and returns the corresponding value.
float	nextFloat() Ensures that the current JsonState is JsonState.DOUBLE and consumes and returns the corresponding value as a float.
int	nextInteger() Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value as a int.
long	nextLong() Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value.
String	nextName() Ensures that the current JsonState is JsonState.NAME and consumes and returns the corresponding name of a JSON object entry.
void	nextNull() Ensures that the current JsonState is JsonState.NULL and consumes the null The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.
short	nextShort() Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value as a short.
String	nextString() Ensures that the current JsonState is JsonState.STRING and consumes and returns the corresponding value.
Reader	readString() Ensures that the current JsonState is JsonState.STRING and return a Reader that consumes the corresponding value.
void	skipValue() Skips the current JSON value.

Methods inherited from interface java.io.Closeable

close

Method Detail

hasNext

boolean hasNext()
         throws JsonSyntaxException,
                IOException

Returns whether the current JSON array or JSON object has more elements.

Returns:

Whether the current JSON array or JSON object has more elements.

Throws:

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

currentState

JsonState currentState()
                throws JsonSyntaxException,
                       IOException

Reads, if necessary, from the underlying Reader and describes the current JsonState of this JsonSourcePullParser, which describes the next type of value or structural element of the JSON document.

Returns:

The current JsonState.

Throws:

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

beginDocument

void beginDocument()
            throws IllegalStateException,
                   JsonSyntaxException,
                   IOException

Ensures that the current JsonState is JsonState.DOCUMENT_BEGIN and consumes the begin of the JSON document. The next JsonState will be JsonState.ARRAY_BEGIN or JsonState.OBJECT_BEGIN.

Throws:

IllegalStateException - If the current JsonState is not JsonState.DOCUMENT_BEGIN.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

endDocument

void endDocument()
          throws IllegalStateException,
                 JsonSyntaxException,
                 IOException

Ensures that the current JsonState is JsonState.DOCUMENT_END and consumes the end of the JSON document. The next JsonState will be JsonState.SOURCE_END.

If this JsonSourcePullParser allows multiple documents in the same JsonSource, The next JsonState will be JsonState.DOCUMENT_BEGIN or JsonState.SOURCE_END.

Throws:

IllegalStateException - If the current JsonState is not JsonState.DOCUMENT_END.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

beginArray

void beginArray()
         throws IllegalStateException,
                JsonSyntaxException,
                IOException

Ensures that the current JsonState is JsonState.ARRAY_BEGIN and consumes the beginning of a JSON array. The next JsonState describes either the first value of this JSON array or the end of this JSON array.

Throws:

IllegalStateException - If the current JsonState is not JsonState.ARRAY_BEGIN.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

endArray

void endArray()
       throws IllegalStateException,
              JsonSyntaxException,
              IOException

Ensures that the current JsonState is JsonState.ARRAY_END and consumes the end of the JSON array. The next JsonState describes either the next sibling value of this JSON array or the end of the JSON document.

Throws:

IllegalStateException - If the current JsonState is not JsonState.ARRAY_END.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

beginObject

void beginObject()
          throws IllegalStateException,
                 JsonSyntaxException,
                 IOException

Ensures that the current JsonState is JsonState.OBJECT_BEGIN and consumes the beginning of a JSON object. The next JsonState describes either the JsonSourcePullParser.nextName() of the first value of this JSON object or the end of this JSON object.

Throws:

IllegalStateException - If the current JsonState is not JsonState.OBJECT_BEGIN.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

endObject

void endObject()
        throws IllegalStateException,
               JsonSyntaxException,
               IOException

Ensures that the current JsonState is JsonState.OBJECT_END and consumes the end of the JSON object. The next JsonState describes either the next sibling value of this JSON object or the end of the JSON document.

Throws:

IllegalStateException - If the current JsonState is not JsonState.OBJECT_END.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextNull

void nextNull()
       throws IllegalStateException,
              JsonSyntaxException,
              IOException

Ensures that the current JsonState is JsonState.NULL and consumes the null The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Throws:

IllegalStateException - If the current JsonState is not JsonState.NULL.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextBoolean

boolean nextBoolean()
             throws IllegalStateException,
                    JsonSyntaxException,
                    IOException

Ensures that the current JsonState is JsonState.BOOLEAN and consumes and returns the corresponding value. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The boolean value.

Throws:

IllegalStateException - If the current JsonState is not JsonState.BOOLEAN.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextByte

byte nextByte()
       throws ArithmeticException,
              IllegalStateException,
              JsonSyntaxException,
              IOException

Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value as a byte. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The byte value.

Throws:

ArithmeticException - If the value is too large or too small to fit into a byte.

IllegalStateException - If the current JsonState is not JsonState.LONG.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextCharacter

char nextCharacter()
            throws IllegalStateException,
                   JsonSyntaxException,
                   IOException

Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value as a char. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The char value.

Throws:

ArithmeticException - If the value is too large or too small to fit into a char.

IllegalStateException - If the current JsonState is not JsonState.LONG.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextShort

short nextShort()
         throws IllegalStateException,
                JsonSyntaxException,
                IOException

Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value as a short. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The short value.

Throws:

ArithmeticException - If the value is too large or too small to fit into a short.

IllegalStateException - If the current JsonState is not JsonState.LONG.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextInteger

int nextInteger()
         throws IllegalStateException,
                JsonSyntaxException,
                IOException

Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value as a int. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The int value.

Throws:

ArithmeticException - If the value is too large or too small to fit into a int.

IllegalStateException - If the current JsonState is not JsonState.LONG.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextLong

long nextLong()
       throws IllegalStateException,
              JsonSyntaxException,
              IOException

Ensures that the current JsonState is JsonState.LONG and consumes and returns the corresponding value. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The long value.

Throws:

IllegalStateException - If the current JsonState is not JsonState.LONG.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextFloat

float nextFloat()
         throws IllegalStateException,
                JsonSyntaxException,
                IOException

Ensures that the current JsonState is JsonState.DOUBLE and consumes and returns the corresponding value as a float. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The float value.

Throws:

IllegalStateException - If the current JsonState is not JsonState.DOUBLE.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextDouble

double nextDouble()
           throws IllegalStateException,
                  JsonSyntaxException,
                  IOException

Ensures that the current JsonState is JsonState.DOUBLE and consumes and returns the corresponding value. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The double value.

Throws:

IllegalStateException - If the current JsonState is not JsonState.DOUBLE.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextString

String nextString()
           throws IllegalStateException,
                  JsonSyntaxException,
                  IOException

Ensures that the current JsonState is JsonState.STRING and consumes and returns the corresponding value. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Returns:

The string value.

Throws:

IllegalStateException - If the current JsonState is not JsonState.STRING.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

readString

Reader readString()
           throws IllegalStateException,
                  JsonSyntaxException,
                  IOException

Ensures that the current JsonState is JsonState.STRING and return a Reader that consumes the corresponding value. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Important: the returned Reader must be read completely or closed, before the next call to any other method of this JsonPullParser.

Returns:

A Reader for the string value.

Throws:

IllegalStateException - If the current JsonState is not JsonState.STRING.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

nextName

String nextName()
         throws IllegalStateException,
                JsonSyntaxException,
                IOException

Ensures that the current JsonState is JsonState.NAME and consumes and returns the corresponding name of a JSON object entry. The next JsonState describes the corresponding value.

Returns:

The name.

Throws:

IllegalStateException - If the current JsonState is not JsonState.NAME.

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

skipValue

void skipValue()
        throws JsonSyntaxException,
               IOException

Skips the current JSON value. The next JsonState describes either the next sibling value of this JSON value or the end of surrounding JSON array or JSON object.

Throws:

JsonSyntaxException - If the read JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

getLine

int getLine()

Returns the line that corresponds to the current position of the underlying JsonSource in the character sequence, as if the character source was a regular file.

Returns:

The line.

getColumn

int getColumn()

Returns the column that corresponds to the current position of the underlying JsonSource in the character sequence, as if the character source was a regular file.

Returns:

The line.