net.markenwerk.utils.json.parser

Class JsonSourcePushParser

java.lang.Object

net.markenwerk.utils.json.parser.JsonSourcePushParser

All Implemented Interfaces:

Closeable, AutoCloseable, JsonPushParser

public final class JsonSourcePushParser
extends Object
implements JsonPushParser

A JsonSourcePushParser 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
JsonSourcePushParser(char[] characters) Creates a new JsonSourcePushParser for the given char[].
JsonSourcePushParser(JsonSource source) Creates a new JsonSourcePushParser for the given JsonSource.
JsonSourcePushParser(Reader reader) Creates a new JsonSourcePushParser for the given Reader.
JsonSourcePushParser(Reader reader, int size) Creates a new JsonSourcePushParser for the given Reader.
JsonSourcePushParser(String string) Creates a new JsonSourcePushParser for the given String.

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.
<Result> Result	handle(JsonHandler<Result> handler, JsonParserMode... modes) 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

JsonSourcePushParser

public JsonSourcePushParser(String string)
                     throws IllegalArgumentException

Creates a new JsonSourcePushParser for the given String.

Parameters:

string - The String to read from.

Throws:

IllegalArgumentException - If the given String is null or if the given JsonHandler is null.

JsonSourcePushParser

public JsonSourcePushParser(char[] characters)
                     throws IllegalArgumentException

Creates a new JsonSourcePushParser for the given char[].

Parameters:

characters - The char[] to read from.

Throws:

IllegalArgumentException - If the given String is null or if the given JsonHandler is null.

JsonSourcePushParser

public JsonSourcePushParser(Reader reader)
                     throws IllegalArgumentException

Creates a new JsonSourcePushParser for the given Reader.

Parameters:

reader - The Reader to read from.

Throws:

IllegalArgumentException - If the given String is null.

JsonSourcePushParser

public JsonSourcePushParser(Reader reader,
                            int size)
                     throws IllegalArgumentException

Creates a new JsonSourcePushParser for the given Reader.

Parameters:

reader - The Reader to read from.

size - The buffer size to be used.

Throws:

IllegalArgumentException - If the given String is null or if the given JsonHandler is null or if the given size is smaller than the minimum buffer size.

JsonSourcePushParser

public JsonSourcePushParser(JsonSource source)
                     throws IllegalArgumentException

Creates a new JsonSourcePushParser for the given JsonSource.

Parameters:

source - The JsonSource to read from.

Throws:

IllegalArgumentException - If the given String is null or if the given JsonHandler is null.

Method Detail

handle

public <Result> Result handle(JsonHandler<Result> handler)
                       throws IllegalArgumentException,
                              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 JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader failed.

handle

public <Result> Result handle(JsonHandler<Result> handler,
                              JsonParserMode... modes)
                       throws IllegalArgumentException,
                              JsonSyntaxException,
                              IOException

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.

Type Parameters:

Result - The result type of the JsonHandler.

Parameters:

handler - The JsonHandler to report to.

modes - Selection of JsonParserModes to be used during parsing.

Returns:

The result that has been calculated by the given JsonHandler.

Throws:

IllegalArgumentException - If the given JsonHandler is null.

JsonSyntaxException - If the JsonSyntaxException document contains a syntax error.

IOException - If reading from the underlying Reader 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