net.markenwerk.utils.json.parser

Class CharacterArrayJsonSource

java.lang.Object

net.markenwerk.utils.json.parser.CharacterArrayJsonSource

All Implemented Interfaces:

Closeable, AutoCloseable, JsonSource

public final class CharacterArrayJsonSource
extends Object
implements JsonSource

A CharacterArrayJsonSource is a JsonSource that is backed by a given char[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Field Summary

Fields inherited from interface net.markenwerk.utils.json.parser.JsonSource

BYTE_ORDER_MARK

Constructor Summary

Constructors

Constructor and Description
CharacterArrayJsonSource(char[] characters) Creates a new CharacterArrayJsonSource for the given String.

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.
void	close()
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 class java.lang.Object

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

Constructor Detail

CharacterArrayJsonSource

public CharacterArrayJsonSource(char[] characters)
                         throws IllegalArgumentException

Creates a new CharacterArrayJsonSource for the given String.

Parameters:

characters - The char[] to be used.

Throws:

IllegalArgumentException - If the given String is null.

Method Detail

getAvailable

public int getAvailable()

Description copied from interface: JsonSource

Returns the amount of currently available characters.

Specified by:

getAvailable in interface JsonSource

Returns:

The amount of currently available characters.

makeAvailable

public int makeAvailable()
                  throws IOException

Description copied from interface: JsonSource

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

Specified by:

makeAvailable in interface JsonSource

Returns:

Returns the amount of currently available characters.

Throws:

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

makeAvailable

public boolean makeAvailable(int minimum)
                      throws IOException

Description copied from interface: JsonSource

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

Specified by:

makeAvailable in interface JsonSource

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

public char nextCharacter()

Description copied from interface: JsonSource

Consumes and returns the next character in the character sequence.

Specified by:

nextCharacter in interface JsonSource

Returns:

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

peekCharacter

public char peekCharacter(int offset)

Description copied from interface: JsonSource

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

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

Specified by:

peekCharacter in interface JsonSource

Parameters:

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

Returns:

The future character in the character sequence.

nextString

public String nextString(int length)

Description copied from interface: JsonSource

Consumes and returns the next characters in the character sequence.

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

Specified by:

nextString in interface JsonSource

Parameters:

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

Returns:

The next characters in the character sequence.

appendNextString

public void appendNextString(StringBuilder builder,
                             int length)

Description copied from interface: JsonSource

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.

Specified by:

appendNextString in interface JsonSource

Parameters:

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

length - The amount of characters to be consumed.

getPast

public String getPast(int maximum)

Description copied from interface: JsonSource

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

Specified by:

getPast in interface JsonSource

Parameters:

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

Returns:

The past characters.

getFuture

public String getFuture(int maximum)

Description copied from interface: JsonSource

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.

Specified by:

getFuture in interface JsonSource

Parameters:

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

Returns:

The future characters.

getLine

public int getLine()

Description copied from interface: JsonSource

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.

Specified by:

getLine in interface JsonSource

Returns:

The line.

getColumn

public int getColumn()

Description copied from interface: JsonSource

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.

Specified by:

getColumn in interface JsonSource

Returns:

The line.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException