net.markenwerk.utils.json.parser

Interface JsonSource

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CharacterArrayJsonSource, ReaderJsonSource, StringJsonSource

public interface JsonSource
extends Closeable

A JsonSource represents access to a sequence of characters to be used used by a JsonPullParser. Characters may be consumed one by one, or, for convenience, multiple at a time, or appended to a StringBuilder.

Callers must or ensure, that the desired amount of characters is available, before consuming them.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Field Summary

Fields

Modifier and Type	Field and Description
static char	BYTE_ORDER_MARK A char that represents the Unicode byte order mark.

Method Summary

Modifier and Type	Method and Description
void	appendNextString(StringBuilder builder, int length) Consumes and appends the next characters in the character sequence to the given StringBuilder.
int	getAvailable() Returns the amount of currently available characters.
int	getColumn() Returns the column that corresponds to the current position of this JsonSource in the character sequence, as if the character source was a regular file.
String	getFuture(int maximum) Returns some of the characters havn't been consumed yet, beginning with the next character to be consumed, if already available, or an empty String otherwise.
int	getLine() Returns the line that corresponds to the current position of this JsonSource in the character sequence, as if the character source was a regular file.
String	getPast(int maximum) Returns some of the characters that already have been consumed, ending with the last consumed character, if still available, or an empty String otherwise.
int	makeAvailable() Ensures that characters are available to be consumed, unless the character sequence has reached its end.
boolean	makeAvailable(int minimum) Ensures that a given minimum of characters is available to be consumed.
char	nextCharacter() Consumes and returns the next character in the character sequence.
String	nextString(int length) Consumes and returns the next characters in the character sequence.
char	peekCharacter(int offset) Returns a future character in the character sequence, without consuming it.

Methods inherited from interface java.io.Closeable

close

Field Detail

BYTE_ORDER_MARK

static final char BYTE_ORDER_MARK

A char that represents the Unicode byte order mark. A leading byte order mark in a character sequence should be ignored by a JsonSource.

See Also:

Constant Field Values

Method Detail

getAvailable

int getAvailable()

Returns the amount of currently available characters.

Returns:

The amount of currently available characters.

makeAvailable

int makeAvailable()
           throws IOException

Ensures that characters are available to be consumed, unless the character sequence has reached its end.

Returns:

Returns the amount of currently available characters.

Throws:

IOException - If something went wrong while ensuring that the desired amount of available characters.

makeAvailable

boolean makeAvailable(int minimum)
               throws IOException

Ensures that a given minimum of characters is available to be consumed.

Parameters:

minimum - The desired minimum.

Returns:

Whether the desired amount of available characters could be ensured or the end of the character sequence has been reached.

Throws:

IOException - If something went wrong while ensuring that the desired amount of available characters.

nextCharacter

char nextCharacter()

Consumes and returns the next character in the character sequence.

Returns:

The next character in the character sequence. Must be non-negative.

peekCharacter

char peekCharacter(int offset)

Returns a future character in the character sequence, without consuming it.

Callers must ensure, that the desired amount of characters is available.

Parameters:

offset - The amount of characters to look ahead. Must be non-negative.

Returns:

The future character in the character sequence.

nextString

String nextString(int length)

Consumes and returns the next characters in the character sequence.

Callers must ensure, that the desired amount of characters is available.

Parameters:

length - The amount of characters to be consumed. Must be non-negative.

Returns:

The next characters in the character sequence.

appendNextString

void appendNextString(StringBuilder builder,
                      int length)

Consumes and appends the next characters in the character sequence to the given StringBuilder.

Callers must ensure, that the desired amount of characters is available.

Parameters:

builder - The string builder to add the characters to. Must be non-negative.

length - The amount of characters to be consumed.

getLine

int getLine()

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

The line is equal to the number of consumed \n-characters + 1.

Returns:

The line.

getColumn

int getColumn()

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

The column is equal to the number of consumed characters + 1 in the current line.

Returns:

The line.

getPast

String getPast(int maximum)

Returns some of the characters that already have been consumed, ending with the last consumed character, if still available, or an empty String otherwise.

Parameters:

maximum - The maximum amount of characters. Must be non-negative.

Returns:

The past characters.

getFuture

String getFuture(int maximum)

Returns some of the characters havn't been consumed yet, beginning with the next character to be consumed, if already available, or an empty String otherwise.

Parameters:

maximum - The maximum amount of characters. Must be non-negative.

Returns:

The future characters.