net.markenwerk.utils.json.parser

Class DefaultJsonPullParser

java.lang.Object

net.markenwerk.utils.json.parser.DefaultJsonPullParser

All Implemented Interfaces:

Closeable, AutoCloseable, JsonPullParser

public final class DefaultJsonPullParser
extends Object
implements JsonPullParser

A DefaultJsonPullParser is a JsonPullParser that consumes a JsonSource.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
DefaultJsonPullParser(char[] characters) Creates a new DefaultJsonPullParser.
DefaultJsonPullParser(JsonSource source) Creates a new DefaultJsonPullParser.
DefaultJsonPullParser(JsonSource source, JsonParserMode... modes) Creates a new DefaultJsonPullParser.
DefaultJsonPullParser(Reader reader) Creates a new DefaultJsonPullParser.
DefaultJsonPullParser(String string) Creates a new DefaultJsonPullParser.

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.
void	close()
JsonState	currentState() Reads, if necessary, from the underlying Reader and describes the current JsonState of this DefaultJsonPullParser, 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	hasNextElement() 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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultJsonPullParser

public DefaultJsonPullParser(String string)
                      throws IllegalArgumentException

Creates a new DefaultJsonPullParser.

Parameters:

string - The String to read from.

Throws:

IllegalArgumentException - If the given String is null.

DefaultJsonPullParser

public DefaultJsonPullParser(char[] characters)
                      throws IllegalArgumentException

Creates a new DefaultJsonPullParser.

Parameters:

characters - The char[] to read from.

Throws:

IllegalArgumentException - If the given char[] is null.

DefaultJsonPullParser

public DefaultJsonPullParser(Reader reader)
                      throws IllegalArgumentException

Creates a new DefaultJsonPullParser.

Parameters:

reader - The Reader to read from.

Throws:

IllegalArgumentException - If the given Reader is null.

DefaultJsonPullParser

public DefaultJsonPullParser(JsonSource source)
                      throws IllegalArgumentException

Creates a new DefaultJsonPullParser.

Parameters:

source - The JsonSource to read from.

Throws:

IllegalArgumentException - If the given JsonSource is null.

DefaultJsonPullParser

public DefaultJsonPullParser(JsonSource source,
                             JsonParserMode... modes)
                      throws IllegalArgumentException

Creates a new DefaultJsonPullParser.

Parameters:

source - The JsonSource to read from.

modes - Selection of JsonParserModes to be used during parsing.

Throws:

IllegalArgumentException - If the given JsonSource is null.

Method Detail

hasNextElement

public boolean hasNextElement()
                       throws JsonSyntaxException,
                              IOException

Description copied from interface: JsonPullParser

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

Specified by:

hasNextElement in interface JsonPullParser

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

public JsonState currentState()
                       throws JsonSyntaxException,
                              IOException

Description copied from interface: JsonPullParser

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

Specified by:

currentState in interface JsonPullParser

Returns:

The current JsonState.

Throws:

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

IOException - If reading from the underlying Reader failed.

beginDocument

public void beginDocument()
                   throws IllegalStateException,
                          JsonSyntaxException,
                          IOException

Description copied from interface: JsonPullParser

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.

Specified by:

beginDocument in interface JsonPullParser

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

public void endDocument()
                 throws IllegalStateException,
                        JsonSyntaxException,
                        IOException

Description copied from interface: JsonPullParser

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 DefaultJsonPullParser allows multiple documents in the same JsonSource, The next JsonState will be JsonState.DOCUMENT_BEGIN or JsonState.SOURCE_END.

Specified by:

endDocument in interface JsonPullParser

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

public void beginArray()
                throws IllegalStateException,
                       JsonSyntaxException,
                       IOException

Description copied from interface: JsonPullParser

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.

Specified by:

beginArray in interface JsonPullParser

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

public void endArray()
              throws IllegalStateException,
                     JsonSyntaxException,
                     IOException

Description copied from interface: JsonPullParser

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.

Specified by:

endArray in interface JsonPullParser

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

public void beginObject()
                 throws IllegalStateException,
                        JsonSyntaxException,
                        IOException

Description copied from interface: JsonPullParser

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

Specified by:

beginObject in interface JsonPullParser

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

public void endObject()
               throws IllegalStateException,
                      JsonSyntaxException,
                      IOException

Description copied from interface: JsonPullParser

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.

Specified by:

endObject in interface JsonPullParser

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

public void nextNull()
              throws IllegalStateException,
                     JsonSyntaxException,
                     IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextNull in interface JsonPullParser

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

public boolean nextBoolean()
                    throws IllegalStateException,
                           JsonSyntaxException,
                           IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextBoolean in interface JsonPullParser

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

public byte nextByte()
              throws JsonValueException,
                     IllegalStateException,
                     JsonSyntaxException,
                     IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextByte in interface JsonPullParser

Returns:

The byte value.

Throws:

JsonValueException - 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

public char nextCharacter()
                   throws JsonValueException,
                          IllegalStateException,
                          JsonSyntaxException,
                          IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextCharacter in interface JsonPullParser

Returns:

The char value.

Throws:

JsonValueException - 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

public short nextShort()
                throws JsonValueException,
                       IllegalStateException,
                       JsonSyntaxException,
                       IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextShort in interface JsonPullParser

Returns:

The short value.

Throws:

JsonValueException - 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

public int nextInteger()
                throws JsonValueException,
                       IllegalStateException,
                       JsonSyntaxException,
                       IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextInteger in interface JsonPullParser

Returns:

The int value.

Throws:

JsonValueException - 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

public long nextLong()
              throws IllegalStateException,
                     JsonSyntaxException,
                     IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextLong in interface JsonPullParser

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

public float nextFloat()
                throws JsonValueException,
                       IllegalStateException,
                       JsonSyntaxException,
                       IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextFloat in interface JsonPullParser

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.

JsonValueException

nextDouble

public double nextDouble()
                  throws IllegalStateException,
                         JsonSyntaxException,
                         IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextDouble in interface JsonPullParser

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

public String nextString()
                  throws IllegalStateException,
                         JsonSyntaxException,
                         IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextString in interface JsonPullParser

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

public Reader readString()
                  throws IllegalStateException,
                         JsonSyntaxException,
                         IOException

Description copied from interface: JsonPullParser

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.

Specified by:

readString in interface 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

public String nextName()
                throws IllegalStateException,
                       JsonSyntaxException,
                       IOException

Description copied from interface: JsonPullParser

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.

Specified by:

nextName in interface JsonPullParser

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

public void skipValue()
               throws JsonSyntaxException,
                      IOException

Description copied from interface: JsonPullParser

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.

Specified by:

skipValue in interface JsonPullParser

Throws:

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

IOException - If reading from the underlying Reader failed.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getLine

public int getLine()

Description copied from interface: JsonPullParser

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.

Specified by:

getLine in interface JsonPullParser

Returns:

The line.

getColumn

public int getColumn()

Description copied from interface: JsonPullParser

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.

Specified by:

getColumn in interface JsonPullParser

Returns:

The line.

toString

public String toString()

Overrides:

toString in class Object