IdleJsonHandler (net.markenwerk:utils-json-parser 3.0.0 API)

java.lang.Object
- net.markenwerk.utils.json.handler.IdleJsonHandler<Result>

Type Parameters:

Result - The result type.

All Implemented Interfaces:

JsonHandler<Result>

Direct Known Subclasses:

NullJsonHandler
```
public abstract class IdleJsonHandler<Result>
extends Object
implements JsonHandler<Result>
```
An IdleJsonHandler is a JsonHandler with empty methods. It is intended a base for custom JsonHandler implementations, that don't need to implement all methods.
An IdleJsonHandler also provides methods to check whether a double value is a valid JSON number and to check whether a String value is a valid JSON string.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors
Constructor and Description

IdleJsonHandler()

Constructors
Constructor and Description
`IdleJsonHandler()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`checkDouble(double value)` Checks that a double value is a valid JSON number.
`static boolean`	`checkName(String name)` Checks that a `String` value is a valid JSON name.
`static boolean`	`checkString(String value)` Checks that a `String` value is a valid JSON string.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IdleJsonHandler
```
public IdleJsonHandler()
```
- Method Detail
  - onDocumentBegin
```
public void onDocumentBegin()
                     throws JsonException
```
    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>
    
    Throws:
    
    JsonException - If the handling failed.
  - onDocumentEnd
```
public void onDocumentEnd()
                   throws JsonException
```
    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>
    
    Throws:
    
    JsonException - If the handling failed.
  - onArrayBegin
```
public 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>
    
    Throws:
    
    JsonException - If the handling failed.
  - onArrayEnd
```
public 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>
    
    Throws:
    
    JsonException - If the handling failed.
  - onObjectBegin
```
public 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>
    
    Throws:
    
    JsonException - If the handling failed.
  - onObjectEnd
```
public 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>
    
    Throws:
    
    JsonException - If the handling failed.
  - onName
```
public void onName(String name)
            throws 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>
    
    Parameters:
    
    name - The name for the next JSON value.
    
    Throws:
    
    JsonIndexException - If the given value is null.
    
    JsonException - If the handling failed.
  - checkName
```
public static final boolean checkName(String name)
                               throws JsonIndexException
```
    Checks that a String value is a valid JSON name.
    
    Parameters:
    
    name - The name to be checked.
    
    Returns:
    
    Always true, if no JsonIndexException is thrown.
    
    Throws:
    
    JsonIndexException - If the given name is null.
  - onNext
```
public 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>
    
    Throws:
    
    JsonException - If the handling failed.
  - onNull
```
public 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>
    
    Throws:
    
    JsonException - If the handling failed.
  - onBoolean
```
public 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>
    
    Parameters:
    
    value - The value of the JSON boolean.
    
    Throws:
    
    JsonException - If the handling failed.
  - onLong
```
public 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>
    
    Parameters:
    
    value - The value of the JSON number.
    
    Throws:
    
    JsonException - If the handling failed.
  - onDouble
```
public 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>
    
    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.
  - checkDouble
```
public static final boolean checkDouble(double value)
                                 throws JsonValueException
```
    Checks that a double value is a valid JSON number.
    
    Parameters:
    
    value - The value to be checked.
    
    Returns:
    
    Always true, if no JsonValueException is thrown.
    
    Throws:
    
    JsonValueException - If the given value is infinite or not a number.
  - onString
```
public 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>
    
    Parameters:
    
    value - The value of the JSON string.
    
    Throws:
    
    JsonValueException - If the given value is null.
    
    JsonException - If the handling failed.
  - checkString
```
public static final boolean checkString(String value)
                                 throws JsonValueException
```
    Checks that a String value is a valid JSON string.
    
    Parameters:
    
    value - The value to be checked.
    
    Returns:
    
    Always true, if no JsonValueException is thrown.
    
    Throws:
    
    JsonValueException - If the given value is null.
  - getResult
```
public Result getResult()
                 throws JsonException
```
    Description copied from interface: JsonHandler
    
    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).
    
    Specified by:
    
    getResult in interface JsonHandler<Result>
    
    Returns:
    
    The calculated result.
    
    Throws:
    
    JsonException - If the handling failed.

Class IdleJsonHandler<Result>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdleJsonHandler

Method Detail

onDocumentBegin

onDocumentEnd

onArrayBegin

onArrayEnd

onObjectBegin

onObjectEnd

onName

checkName

onNext

onNull

onBoolean

onLong

onDouble

checkDouble

onString

checkString

getResult