com.steelypip.powerups.json

Class MinXMLBuilderJSONBuilder

java.lang.Object

com.steelypip.powerups.json.JSONBuildCounter

com.steelypip.powerups.json.MinXMLBuilderJSONBuilder

All Implemented Interfaces:

JSONBuilder<MinXML>

public class MinXMLBuilderJSONBuilder
extends JSONBuildCounter
implements JSONBuilder<MinXML>

This class implements the JSONBuilder interface and constructs MinXML objects. The grammar of the constructed MinXML has a modest degree of customisation as the string constants are encapsulated in the JSONKeywords translation table.

Field Summary

Fields

Modifier and Type	Field and Description
protected MinXMLBuilder	builder
protected java.lang.String	field_name
protected JSONKeywords	keywords

Constructor Summary

Constructors

Constructor and Description
MinXMLBuilderJSONBuilder() A convenience constructor that specialises the translation table to a standard set of keywords and the MinXML builder to a FlexiMinXML builder.
MinXMLBuilderJSONBuilder(MinXMLBuilder builder) A convenience constructor that specialises the translation table to a standard set of keywords.
MinXMLBuilderJSONBuilder(MinXMLBuilder builder, JSONKeywords keys) Creates a JSONBuilder from a MinXML builder and a translation table.

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 value) 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.
MinXML	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.

Methods inherited from class com.steelypip.powerups.json.JSONBuildCounter

buildCheck, decrement, increment

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected MinXMLBuilder builder

field_name

protected java.lang.String field_name

keywords

protected final JSONKeywords keywords

Constructor Detail

MinXMLBuilderJSONBuilder

public MinXMLBuilderJSONBuilder()

A convenience constructor that specialises the translation table to a standard set of keywords and the MinXML builder to a FlexiMinXML builder.

MinXMLBuilderJSONBuilder

public MinXMLBuilderJSONBuilder(MinXMLBuilder builder)

A convenience constructor that specialises the translation table to a standard set of keywords.

Parameters:

builder - the MinXML builder used to construct the internal tree

MinXMLBuilderJSONBuilder

public MinXMLBuilderJSONBuilder(MinXMLBuilder builder,
                                JSONKeywords keys)

Creates a JSONBuilder from a MinXML builder and a translation table.

Parameters:

builder - the MinXML builder used to construct the internal tree

keys - the set of strings to embed in the final MinXML

Method Detail

addNull

public void addNull()

Description copied from interface: JSONBuilder

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

Specified by:

addNull in interface JSONBuilder<MinXML>

addBoolean

public void addBoolean(boolean value)

Description copied from interface: JSONBuilder

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

Specified by:

addBoolean in interface JSONBuilder<MinXML>

Parameters:

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

addInteger

public void addInteger(long value)

Description copied from interface: JSONBuilder

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.

Specified by:

addInteger in interface JSONBuilder<MinXML>

Parameters:

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

addInteger

public void addInteger(java.math.BigInteger value)

Description copied from interface: JSONBuilder

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

Specified by:

addInteger in interface JSONBuilder<MinXML>

Parameters:

value - the value as a big-integer

addFloat

public void addFloat(double value)

Description copied from interface: JSONBuilder

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

Specified by:

addFloat in interface JSONBuilder<MinXML>

Parameters:

value - the floating point value

addString

public void addString(java.lang.String value)

Description copied from interface: JSONBuilder

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

Specified by:

addString in interface JSONBuilder<MinXML>

Parameters:

value - the string

startArray

public void startArray()

Description copied from interface: JSONBuilder

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

Specified by:

startArray in interface JSONBuilder<MinXML>

endArray

public void endArray()

Description copied from interface: JSONBuilder

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

Specified by:

endArray in interface JSONBuilder<MinXML>

field

public void field(java.lang.String field)

Description copied from interface: JSONBuilder

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

Specified by:

field in interface JSONBuilder<MinXML>

Parameters:

field - name of the field

startObject

public void startObject()

Description copied from interface: JSONBuilder

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

Specified by:

startObject in interface JSONBuilder<MinXML>

endObject

public void endObject()

Description copied from interface: JSONBuilder

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

Specified by:

endObject in interface JSONBuilder<MinXML>

build

public MinXML build()

Description copied from interface: JSONBuilder

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.

Specified by:

build in interface JSONBuilder<MinXML>

Returns:

a value representing the tree