net.openhft.saxophone.json

Class JsonParserBuilder

java.lang.Object

net.openhft.saxophone.json.JsonParserBuilder

public final class JsonParserBuilder
extends Object

A builder of JsonParser. To obtain a new builder, call JsonParser.builder() static method.

Example usage:

public final class PrettyPrinter
         implements ResetHook,
         ObjectStartHandler, ObjectEndHandler,
         ArrayStartHandler, ArrayEndHandler,
         ObjectKeyHandler, StringValueHandler,
         NumberHandler, BooleanHandler, NullHandler {

     public static void main(String[] args) {
         PrettyPrinter prettyPrinter = new PrettyPrinter();
         JsonParser parser = JsonParser.builder()
                 .applyAdapter(prettyPrinter)
                 .options(JsonParserOption.ALLOW_COMMENTS)
                 .build();
         parser.parse(... /* not formatted JSON as Bytes */);
         parser.finish();
         System.out.println(prettyPrinter);
     }

     private int indent = 0;
     private int indentStep = 4;
     private StringBuilder sb = new StringBuilder();

See Also:

JsonParser.builder()

Method Summary

Methods

Modifier and Type	Method and Description
JsonParserBuilder	applyAdapter(JsonHandlerBase a) Convenient method to apply the adapter which implements several handler interfaces in one call.
ArrayEndHandler	arrayEndHandler() Returns the parser's array end handler, or null if the handler is not set.
JsonParserBuilder	arrayEndHandler(ArrayEndHandler arrayEndHandler) Sets the parser's array end handler, or removes it if null is passed.
ArrayStartHandler	arrayStartHandler() Returns the parser's array start handler, or null if the handler is not set.
JsonParserBuilder	arrayStartHandler(ArrayStartHandler arrayStartHandler) Sets the parser's array start handler, or removes it if null is passed.
BooleanHandler	booleanHandler() Returns the parser's boolean value handler, or null if the handler is not set.
JsonParserBuilder	booleanHandler(BooleanHandler booleanHandler) Sets the parser's boolean value handler, or removes it if null is passed.
JsonParser	build() Builds and returns a new JsonParser with the configured options and handlers.
JsonParserBuilder	clearOptions() Clears an option set.
boolean	eachTokenMustBeHandled() Returns if each input JSON token must be handled, true by default.
JsonParserBuilder	eachTokenMustBeHandled(boolean eachTokenMustBeHandled) Sets if each input JSON token must be handled.
FloatingHandler	floatingHandler() Returns the parser's floating value handler, or null if the handler is not set.
JsonParserBuilder	floatingHandler(FloatingHandler floatingHandler) Sets the parser's floating value handler, or removes it if null is passed.
IntegerHandler	integerHandler() Returns the parser's integer value handler, or null if the handler is not set.
JsonParserBuilder	integerHandler(IntegerHandler integerHandler) Sets the parser's integer value handler, or removes it if null is passed.
NullHandler	nullHandler() Returns the parser's null value handler, or null if the handler is not set.
JsonParserBuilder	nullHandler(NullHandler nullHandler) Sets the parser's null value handler, or removes it if null is passed.
NumberHandler	numberHandler() Returns the parser's number value handler, or null if the handler is not set.
JsonParserBuilder	numberHandler(NumberHandler numberHandler) Sets the parser's number value handler, or removes it if null is passed.
ObjectEndHandler	objectEndHandler() Returns the parser's object end handler, or null if the handler is not set.
JsonParserBuilder	objectEndHandler(ObjectEndHandler objectEndHandler) Sets the parser's object end handler, or removes it if null is passed.
ObjectKeyHandler	objectKeyHandler() Returns the parser's object key handler, or null if the handler is not set.
JsonParserBuilder	objectKeyHandler(ObjectKeyHandler objectKeyHandler) Sets the parser's object key handler, or removes it if null is passed.
ObjectStartHandler	objectStartHandler() Returns the parser's object start handler, or null if the handler is not set.
JsonParserBuilder	objectStartHandler(ObjectStartHandler objectStartHandler) Sets the parser's object start handler, or removes it if null is passed.
Set<JsonParserOption>	options() Returns the parser options as read-only set.
JsonParserBuilder	options(Collection<JsonParserOption> options) Sets the parser options.
JsonParserBuilder	options(JsonParserOption first, JsonParserOption... rest) Sets the parser options.
ResetHook	resetHook() Returns the parser's reset hook, or null if the hook is not set.
JsonParserBuilder	resetHook(ResetHook resetHook) Sets the parser's reset hook, or removes it if null is passed.
StringValueHandler	stringValueHandler() Returns the parser's string value handler, or null if the handler is not set.
JsonParserBuilder	stringValueHandler(StringValueHandler stringValueHandler) Sets the parser's string value handler, or removes it if null is passed.
JsonParserTopLevelStrategy	topLevelStrategy() Returns the parser's top-level strategy.
JsonParserBuilder	topLevelStrategy(JsonParserTopLevelStrategy topLevelStrategy) Sets the parser's top-level strategy

Methods inherited from class java.lang.Object

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

Method Detail

build

public JsonParser build()

Builds and returns a new JsonParser with the configured options and handlers.

After construction a JsonParser don't depend on it's builder, so you can change the builder state and construct a different parser.

Returns:

a newly built JsonParser

options

public Set<JsonParserOption> options()

Returns the parser options as read-only set. Initially there are no options (the set is empty).

Returns:

the parser options as read-only set

options

public JsonParserBuilder options(Collection<JsonParserOption> options)

Sets the parser options. The previous options, if any, are discarded.

Parameters:

options - parser options

Returns:

a reference to this builder

options

public JsonParserBuilder options(JsonParserOption first,
                        JsonParserOption... rest)

Sets the parser options. The previous options, if any, are discarded.

Parameters:

first - parser option

rest - the rest parser options

Returns:

a reference to this builder

clearOptions

public JsonParserBuilder clearOptions()

Clears an option set. After this call options() returns an empty set.

Returns:

a reference to this builder

topLevelStrategy

@NotNull
public JsonParserTopLevelStrategy topLevelStrategy()

Returns the parser's top-level strategy.

Returns:

the parser's top-level strategy

topLevelStrategy

public JsonParserBuilder topLevelStrategy(@NotNull
                                 JsonParserTopLevelStrategy topLevelStrategy)

Sets the parser's top-level strategy

Parameters:

topLevelStrategy - a new top-level strategy

Returns:

a reference to this builder

eachTokenMustBeHandled

public boolean eachTokenMustBeHandled()

Returns if each input JSON token must be handled, true by default.

Returns:

if each input JSON token must be handled

eachTokenMustBeHandled

public JsonParserBuilder eachTokenMustBeHandled(boolean eachTokenMustBeHandled)

Sets if each input JSON token must be handled. If so, when the parser see the token, but the corresponding handler is absent, IllegalStateException is thrown. Otherwise, this situation of silently ignored. The profit of the latter behaviour - the parser can skip unneeded tokens to speed up. But it is error-prone.

Parameters:

eachTokenMustBeHandled - if each input JSON token must be handled

Returns:

a reference to this builder

applyAdapter

public JsonParserBuilder applyAdapter(JsonHandlerBase a)

Convenient method to apply the adapter which implements several handler interfaces in one call.

Is equivalent to

if (a instanceof ObjectStartHandler)
     objectStartHandler((ObjectStartHandler) a);
 if (a instanceof ObjectEndHandler)
     objectEndHandler((ObjectEndHandler) a);
 // ... the same job for the rest handler interfaces
 

Parameters:

a - the adapter - an object, implementing some of concrete handler interfaces

Returns:

a reference to this builder

Throws:

IllegalArgumentException - if the adapter doesn't implement any of concrete handler interfaces

objectStartHandler

@Nullable
public ObjectStartHandler objectStartHandler()

Returns the parser's object start handler, or null if the handler is not set.

Returns:

the parser's object start handler, or null if the handler is not set

objectStartHandler

public JsonParserBuilder objectStartHandler(@Nullable
                                   ObjectStartHandler objectStartHandler)

Sets the parser's object start handler, or removes it if null is passed.

Parameters:

objectStartHandler - a new object start handler. null means there shouldn't be an object start handler in the built parser.

Returns:

a reference to this builder

objectEndHandler

@Nullable
public ObjectEndHandler objectEndHandler()

Returns the parser's object end handler, or null if the handler is not set.

Returns:

the parser's object end handler, or null if the handler is not set

objectEndHandler

public JsonParserBuilder objectEndHandler(@Nullable
                                 ObjectEndHandler objectEndHandler)

Sets the parser's object end handler, or removes it if null is passed.

Parameters:

objectEndHandler - a new object end handler. null means there shouldn't be an object end handler in the built parser.

Returns:

a reference to this builder

arrayStartHandler

@Nullable
public ArrayStartHandler arrayStartHandler()

Returns the parser's array start handler, or null if the handler is not set.

Returns:

the parser's array start handler, or null if the handler is not set

arrayStartHandler

public JsonParserBuilder arrayStartHandler(@Nullable
                                  ArrayStartHandler arrayStartHandler)

Sets the parser's array start handler, or removes it if null is passed.

Parameters:

arrayStartHandler - a new array start handler. null means there shouldn't be an array start handler in the built parser.

Returns:

a reference to this builder

arrayEndHandler

@Nullable
public ArrayEndHandler arrayEndHandler()

Returns the parser's array end handler, or null if the handler is not set.

Returns:

the parser's array end handler, or null if the handler is not set

arrayEndHandler

public JsonParserBuilder arrayEndHandler(@Nullable
                                ArrayEndHandler arrayEndHandler)

Sets the parser's array end handler, or removes it if null is passed.

Parameters:

arrayEndHandler - a new array end handler. null means there shouldn't be an array end handler in the built parser.

Returns:

a reference to this builder

booleanHandler

@Nullable
public BooleanHandler booleanHandler()

Returns the parser's boolean value handler, or null if the handler is not set.

Returns:

the parser's boolean value handler, or null if the handler is not set

booleanHandler

public JsonParserBuilder booleanHandler(@Nullable
                               BooleanHandler booleanHandler)

Sets the parser's boolean value handler, or removes it if null is passed.

Parameters:

booleanHandler - a new boolean value handler. null means there shouldn't be a boolean value handler in the built parser.

Returns:

a reference to this builder

nullHandler

@Nullable
public NullHandler nullHandler()

Returns the parser's null value handler, or null if the handler is not set.

Returns:

the parser's null value handler, or null if the handler is not set

nullHandler

public JsonParserBuilder nullHandler(@Nullable
                            NullHandler nullHandler)

Sets the parser's null value handler, or removes it if null is passed.

Parameters:

nullHandler - a new null value handler. null means there shouldn't be a null value handler in the built parser.

Returns:

a reference to this builder

stringValueHandler

@Nullable
public StringValueHandler stringValueHandler()

Returns the parser's string value handler, or null if the handler is not set.

Returns:

the parser's string value handler, or null if the handler is not set

stringValueHandler

public JsonParserBuilder stringValueHandler(@Nullable
                                   StringValueHandler stringValueHandler)

Sets the parser's string value handler, or removes it if null is passed.

Parameters:

stringValueHandler - a new string value handler. null means there shouldn't be a string value handler in the built parser.

Returns:

a reference to this builder

objectKeyHandler

@Nullable
public ObjectKeyHandler objectKeyHandler()

Returns the parser's object key handler, or null if the handler is not set.

Returns:

the parser's object key handler, or null if the handler is not set

objectKeyHandler

public JsonParserBuilder objectKeyHandler(@Nullable
                                 ObjectKeyHandler objectKeyHandler)

Sets the parser's object key handler, or removes it if null is passed.

Parameters:

objectKeyHandler - a new object key handler. null means there shouldn't be an object key handler in the built parser.

Returns:

a reference to this builder

numberHandler

@Nullable
public NumberHandler numberHandler()

Returns the parser's number value handler, or null if the handler is not set.

Returns:

the parser's number value handler, or null if the handler is not set

numberHandler

public JsonParserBuilder numberHandler(@Nullable
                              NumberHandler numberHandler)

Sets the parser's number value handler, or removes it if null is passed.

Parameters:

numberHandler - a new number value handler. null means there shouldn't be a number value handler in the built parser.

Returns:

a reference to this builder

Throws:

IllegalStateException - if integerHandler() or floatingHandler() is already set

integerHandler

@Nullable
public IntegerHandler integerHandler()

Returns the parser's integer value handler, or null if the handler is not set.

Returns:

the parser's integer value handler, or null if the handler is not set

integerHandler

public JsonParserBuilder integerHandler(@Nullable
                               IntegerHandler integerHandler)

Sets the parser's integer value handler, or removes it if null is passed.

Parameters:

integerHandler - a new integer value handler. null means there shouldn't be a integer value handler in the built parser.

Returns:

a reference to this builder

Throws:

IllegalStateException - if numberHandler() is already set

floatingHandler

@Nullable
public FloatingHandler floatingHandler()

Returns the parser's floating value handler, or null if the handler is not set.

Returns:

the parser's floating value handler, or null if the handler is not set

floatingHandler

public JsonParserBuilder floatingHandler(@Nullable
                                FloatingHandler floatingHandler)

Sets the parser's floating value handler, or removes it if null is passed.

Parameters:

floatingHandler - a new floating value handler. null means there shouldn't be a floating value handler in the built parser.

Returns:

a reference to this builder

Throws:

IllegalStateException - if numberHandler() is already set

resetHook

@Nullable
public ResetHook resetHook()

Returns the parser's reset hook, or null if the hook is not set.

Returns:

the parser's reset hook, or null if the hook is not set

resetHook

public JsonParserBuilder resetHook(@Nullable
                          ResetHook resetHook)

Sets the parser's reset hook, or removes it if null is passed.

Parameters:

resetHook - a new reset hook. null means there shouldn't be a reset hook in the built parser.

Returns:

a reference to this builder