com.steelypip.powerups.json

Interface JSONBuilder<T>

Type Parameters:

T - the type that is yielded by the parser

All Known Implementing Classes:

MinXMLBuilderJSONBuilder

public interface JSONBuilder<T>

JSONBuilder provides an builder pattern interface for JSON parsers to drive as they consume a JSON expression. Once the entire expression is consumed the build method is invoked to return a result. The type of the result depends entirely on the implementation, which allows different parsers to construct different results.

Method Summary

Modifier and Type	Method and Description
void	addBoolean(boolean value) This method should be invoked when the parser consumes a JSON expression 'true' or 'false'.
void	addFloat(double value) This method should be invoked when the parser consumes a JSON floating point value.
void	addInteger(java.math.BigInteger num) This method should preferably be invoked when the parser consumes a JSON integer value that is too large to fit in a long.
void	addInteger(long value) This method should be invoked when the parser consumes a JSON integer value.
void	addNull() This method should be invoked when the parser consumes a JSON expression 'null'.
void	addString(java.lang.String value) This method should be invoked when the parser consumes a JSON string.
T	build() This method will return a value representing the JSON tree consumed so far by the parser.
void	endArray() This method should be invoked when the parser consumes the end of an array i.e.
void	endObject() This method should be invoked when the parser consumes the end of an object i.e.
void	field(java.lang.String field) This method should be invoked when the parser consumes the field name of an object ahead of a ':'.
void	startArray() This method should be invoked when the parser consumes the start of an array i.e.
void	startObject() This method should be invoked when the parser consumes the start of an object i.e.

Method Detail

addNull

void addNull()

This method should be invoked when the parser consumes a JSON expression 'null'.

addBoolean

void addBoolean(boolean value)

This method should be invoked when the parser consumes a JSON expression 'true' or 'false'.

Parameters:

value - true if the expression was 'true', else false.

addInteger

void addInteger(long value)

This method should be invoked when the parser consumes a JSON integer value. JSON does not impose a limit on the size of integers, so arguably this should not take a long but a BigInteger. However, the difference in performance and compactness between longs and BigIntegers is so great and the use-cases where BigIntegers are needed are so rare, we separate the two.

Parameters:

value - the integer value as a signed 64-bit integer.

addInteger

void addInteger(java.math.BigInteger num)

This method should preferably be invoked when the parser consumes a JSON integer value that is too large to fit in a long.

Parameters:

num - the value as a big-integer

addFloat

void addFloat(double value)

This method should be invoked when the parser consumes a JSON floating point value.

Parameters:

value - the floating point value

addString

void addString(java.lang.String value)

This method should be invoked when the parser consumes a JSON string.

Parameters:

value - the string

startArray

void startArray()

This method should be invoked when the parser consumes the start of an array i.e. '['.

endArray

void endArray()

This method should be invoked when the parser consumes the end of an array i.e. ']'.

field

void field(java.lang.String field)

This method should be invoked when the parser consumes the field name of an object ahead of a ':'.

Parameters:

field - name of the field

startObject

void startObject()

This method should be invoked when the parser consumes the start of an object i.e. '{'.

endObject

void endObject()

This method should be invoked when the parser consumes the end of an object i.e. '}'.

build

T build()
 throws JSONBuildFailedException

This method will return a value representing the JSON tree consumed so far by the parser. If it is called prematurely, before an entire balanced tree is consumed, the implementation must throw an exception. It must also throw an exception if more than one tree is consumed. The exception should preferably inherit from JSONBuildFailedException.

Returns:

a value representing the tree

Throws:

JSONBuildFailedException