net.markenwerk.utils.json.common.handler.text

Class AbstractAppendingJavaTextJsonHandler<ActualAppendable extends Appendable,Result>

java.lang.Object

net.markenwerk.utils.json.handler.IdleJsonHandler<Result>

net.markenwerk.utils.json.common.handler.text.AbstractAppendingJavaTextJsonHandler<ActualAppendable,Result>

Type Parameters:

ActualAppendable - The actual Appendable type.

Result - The result type.

All Implemented Interfaces:

JsonHandler<Result>

Direct Known Subclasses:

AppendingJavaTextJsonHandler, JavaTextJsonHandler

public abstract class AbstractAppendingJavaTextJsonHandler<ActualAppendable extends Appendable,Result>
extends IdleJsonHandler<Result>

A AbstractAppendingJavaTextJsonHandler is a JsonHandler that appends the handled JSON document as a text, that mimics the Object.toString() behavior of Javas collection classes, to a given Appendable.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
AbstractAppendingJavaTextJsonHandler(ActualAppendable appendable, Indentation indentation) Creates a new AbstractAppendingJavaTextJsonHandler.

Method Summary

Modifier and Type	Method and Description
protected ActualAppendable	getAppendable() Returns the Appendable this AbstractAppendingJavaTextJsonHandler has been created with.
void	onArrayBegin() Called when the parsing of a JSON array started.
void	onArrayEnd() Called when the parsing of a JSON array ended.
void	onBoolean(boolean value) Called when the parsing of a JSON object encountered a JSON boolean.
void	onDocumentBegin() Called when the parsing of a JSON document started.
void	onDocumentEnd() Called when the parsing of a JSON document ended.
void	onDouble(double value) Called when the parsing of a JSON object encountered a JSON number, that represents a decimal value.
void	onLong(long value) Called when the parsing of a JSON object encountered a JSON number, that represents an integer value.
void	onName(String name) Called when the parsing of a JSON object encountered the name for the next JSON value.
void	onNext() Called when the parsing of a JSON array or JSON object encountered another element.
void	onNull() Called when the parsing of a JSON object encountered a JSON null.
void	onObjectBegin() Called when the parsing of a JSON object started.
void	onObjectEnd() Called when the parsing of a JSON object ended.
void	onString(String value) Called when the parsing of a JSON object encountered a JSON string.

Methods inherited from class net.markenwerk.utils.json.handler.IdleJsonHandler

checkDouble, checkName, checkString, getResult

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAppendingJavaTextJsonHandler

public AbstractAppendingJavaTextJsonHandler(ActualAppendable appendable,
                                            Indentation indentation)

Creates a new AbstractAppendingJavaTextJsonHandler.

Parameters:

appendable - The Appendable to be used.

indentation - The Indentation to be used.

Method Detail

getAppendable

protected ActualAppendable getAppendable()

Returns the Appendable this AbstractAppendingJavaTextJsonHandler has been created with.

Returns:

The Appendable this AbstractAppendingJavaTextJsonHandler has been created with.

onDocumentBegin

public final void onDocumentBegin()

Description copied from interface: JsonHandler

Called when the parsing of a JSON document started.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onDocumentBegin in interface JsonHandler<Result>

Overrides:

onDocumentBegin in class IdleJsonHandler<Result>

onDocumentEnd

public final void onDocumentEnd()

Description copied from interface: JsonHandler

Called when the parsing of a JSON document ended.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onDocumentEnd in interface JsonHandler<Result>

Overrides:

onDocumentEnd in class IdleJsonHandler<Result>

onArrayBegin

public final void onArrayBegin()
                        throws JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON array started. A corresponding call for the end must eventually be called.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onArrayBegin in interface JsonHandler<Result>

Overrides:

onArrayBegin in class IdleJsonHandler<Result>

Throws:

JsonException - If the handling failed.

onArrayEnd

public final void onArrayEnd()
                      throws JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON array ended.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onArrayEnd in interface JsonHandler<Result>

Overrides:

onArrayEnd in class IdleJsonHandler<Result>

Throws:

JsonException - If the handling failed.

onObjectBegin

public final void onObjectBegin()
                         throws JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON object started. A corresponding call for the end must eventually be called.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onObjectBegin in interface JsonHandler<Result>

Overrides:

onObjectBegin in class IdleJsonHandler<Result>

Throws:

JsonException - If the handling failed.

onObjectEnd

public final void onObjectEnd()
                       throws JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON object ended.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onObjectEnd in interface JsonHandler<Result>

Overrides:

onObjectEnd in class IdleJsonHandler<Result>

Throws:

JsonException - If the handling failed.

onName

public final void onName(String name)
                  throws JsonIndexException,
                         JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON object encountered the name for the next JSON value.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onName in interface JsonHandler<Result>

Overrides:

onName in class IdleJsonHandler<Result>

Parameters:

name - The name for the next JSON value.

Throws:

JsonIndexException - If the given value is null.

JsonException - If the handling failed.

onNext

public final void onNext()
                  throws JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON array or JSON object encountered another element.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onNext in interface JsonHandler<Result>

Overrides:

onNext in class IdleJsonHandler<Result>

Throws:

JsonException - If the handling failed.

onNull

public final void onNull()
                  throws JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON object encountered a JSON null.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onNull in interface JsonHandler<Result>

Overrides:

onNull in class IdleJsonHandler<Result>

Throws:

JsonException - If the handling failed.

onBoolean

public final void onBoolean(boolean value)
                     throws JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON object encountered a JSON boolean.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onBoolean in interface JsonHandler<Result>

Overrides:

onBoolean in class IdleJsonHandler<Result>

Parameters:

value - The value of the JSON boolean.

Throws:

JsonException - If the handling failed.

onLong

public final void onLong(long value)
                  throws JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON object encountered a JSON number, that represents an integer value.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onLong in interface JsonHandler<Result>

Overrides:

onLong in class IdleJsonHandler<Result>

Parameters:

value - The value of the JSON number.

Throws:

JsonException - If the handling failed.

onDouble

public final void onDouble(double value)
                    throws JsonValueException,
                           JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON object encountered a JSON number, that represents a decimal value.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onDouble in interface JsonHandler<Result>

Overrides:

onDouble in class IdleJsonHandler<Result>

Parameters:

value - The value of the JSON number.

Throws:

JsonValueException - If the given value is not a number or infinite.

JsonException - If the handling failed.

onString

public final void onString(String value)
                    throws JsonValueException,
                           JsonException

Description copied from interface: JsonHandler

Called when the parsing of a JSON object encountered a JSON string.

Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).

Specified by:

onString in interface JsonHandler<Result>

Overrides:

onString in class IdleJsonHandler<Result>

Parameters:

value - The value of the JSON string.

Throws:

JsonValueException - If the given value is null.

JsonException - If the handling failed.