net.markenwerk.utils.json.handler

Interface JsonHandler<Result>

Type Parameters:

Result - The result type.

All Known Implementing Classes:

IdleJsonHandler, NullJsonHandler

public interface JsonHandler<Result>

A JsonHandler provides a collection of callback methods that can be called for a sequence of events that describe a JSON document. A JsonHandler can calculate a result for the described JSON document.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Method Summary

Modifier and Type	Method and Description
Result	getResult() Returns the calculated result.
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.

Method Detail

onDocumentBegin

void onDocumentBegin()
              throws JsonException

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

Throws:

JsonException - If the handling failed.

onDocumentEnd

void onDocumentEnd()
            throws JsonException

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

Throws:

JsonException - If the handling failed.

onArrayBegin

void onArrayBegin()
           throws JsonException

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

Throws:

JsonException - If the handling failed.

onArrayEnd

void onArrayEnd()
         throws JsonException

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

Throws:

JsonException - If the handling failed.

onObjectBegin

void onObjectBegin()
            throws JsonException

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

Throws:

JsonException - If the handling failed.

onObjectEnd

void onObjectEnd()
          throws JsonException

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

Throws:

JsonException - If the handling failed.

onName

void onName(String name)
     throws JsonIndexException,
            JsonException

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

Parameters:

name - The name for the next JSON value.

Throws:

JsonIndexException - If the given value is null.

JsonException - If the handling failed.

onNext

void onNext()
     throws JsonException

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

Throws:

JsonException - If the handling failed.

onNull

void onNull()
     throws JsonException

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

Throws:

JsonException - If the handling failed.

onBoolean

void onBoolean(boolean value)
        throws JsonException

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

Parameters:

value - The value of the JSON boolean.

Throws:

JsonException - If the handling failed.

onLong

void onLong(long value)
     throws JsonException

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

Parameters:

value - The value of the JSON number.

Throws:

JsonException - If the handling failed.

onDouble

void onDouble(double value)
       throws JsonValueException,
              JsonException

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

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

void onString(String value)
       throws JsonValueException,
              JsonException

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

Parameters:

value - The value of the JSON string.

Throws:

JsonValueException - If the given value is null.

JsonException - If the handling failed.

getResult

Result getResult()
          throws JsonException

Returns the calculated result.

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

Returns:

The calculated result.

Throws:

JsonException - If the handling failed.