net.markenwerk.utils.json.parser

Class DefaultJsonPushParser

java.lang.Object

net.markenwerk.utils.json.parser.DefaultJsonPushParser

All Implemented Interfaces:

Closeable, AutoCloseable, JsonPushParser

public final class DefaultJsonPushParser
extends Object
implements JsonPushParser

A DefaultJsonPushParser is a stream based JSON parser. It reads characters from a given Reader as far as necessary to calculate a JsonState or to yield the next value.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
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.
<Result> Result	handle(JsonHandler<Result> handler) Handle the character sequence from the JsonSource and report to the JsonHandler.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJsonPushParser

public DefaultJsonPushParser(String string)
                      throws IllegalArgumentException

Creates a new DefaultJsonPushParser.

Parameters:

string - The String to read from.

Throws:

IllegalArgumentException - If the given String is null.

DefaultJsonPushParser

public DefaultJsonPushParser(char[] characters)
                      throws IllegalArgumentException

Creates a new DefaultJsonPushParser.

Parameters:

characters - The char[] to read from.

Throws:

IllegalArgumentException - If the given char[] is null.

DefaultJsonPushParser

public DefaultJsonPushParser(Reader reader)
                      throws IllegalArgumentException

Creates a new DefaultJsonPushParser.

Parameters:

reader - The Reader to read from.

Throws:

IllegalArgumentException - If the given Reader is null.

DefaultJsonPushParser

public DefaultJsonPushParser(JsonSource source)
                      throws IllegalArgumentException

Creates a new DefaultJsonPushParser.

Parameters:

source - The JsonSource to read from.

Throws:

IllegalArgumentException - If the given JsonSource is null.

DefaultJsonPushParser

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

Creates a new DefaultJsonPushParser.

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

handle

public <Result> Result handle(JsonHandler<Result> handler)
                       throws IllegalArgumentException,
                              JsonException,
                              JsonSyntaxException,
                              IOException

Description copied from interface: JsonPushParser

Handle the character sequence from the JsonSource and report to the JsonHandler.

Calling this method closes the underlying JsonSource, but it can be closed manually.

Specified by:

handle in interface JsonPushParser

Type Parameters:

Result - The result type of the JsonHandler.

Parameters:

handler - The JsonHandler to report to.

Returns:

The result that has been calculated by the given JsonHandler.

Throws:

IllegalArgumentException - If the given JsonHandler is null.

JsonSyntaxException - If the JSON text contains a syntax error.

JsonException - If the given JsonHandler failed while handling an event.

IOException - If reading from the underlying JsonSource failed.

getLine

public int getLine()

Description copied from interface: JsonPushParser

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 JsonPushParser

Returns:

The line.

getColumn

public int getColumn()

Description copied from interface: JsonPushParser

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 JsonPushParser

Returns:

The line.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object