JsonUtil (JavaDocs for mmm-all dev-SNAPSHOT)

All Known Implementing Classes:

JsonUtilImpl
```
public interface JsonUtil
```
This is a helper class with static methods to deal with JSON.

Since:

8.0.0

Author:

hohwille

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`expectEvent(javax.json.stream.JsonParser.Event actual, javax.json.stream.JsonParser.Event expected)`
`default void`	`expectEvent(javax.json.stream.JsonParser json, javax.json.stream.JsonParser.Event event)`
`default <T> T`	`read(javax.json.stream.JsonParser json, GenericType<T> type)`
`<T> T`	`read(javax.json.stream.JsonParser json, GenericType<T> type, javax.json.stream.JsonParser.Event e)`
`default boolean`	`readBoolean(javax.json.stream.JsonParser.Event e)`
`<E> void`	`readCollection(javax.json.stream.JsonParser json, Collection<E> collection, GenericType<E> type)`
`<C extends Collection<?>> C`	`readCollection(javax.json.stream.JsonParser json, GenericType<C> type)`
`<E extends Enum<E>> E`	`readEnum(javax.json.stream.JsonParser json, Class<E> enumType)`
`<M extends Map<?,?>> M`	`readMap(javax.json.stream.JsonParser json, GenericType<M> type)`
`default <N extends Number> N`	`readNumber(javax.json.stream.JsonParser json, Class<N> type)`
`default void`	`skipValue(javax.json.stream.JsonParser json)` Skips the current value from the `JsonParser`.
`default void`	`skipValue(javax.json.stream.JsonParser json, javax.json.stream.JsonParser.Event e)` Skips the current value from the `JsonParser` when the current `JsonParser.Event` was already `read` and is given.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, BigDecimal value)` An implementation of `JsonSupport.toJson(JsonGenerator)` for a given `BigDecimal`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, BigInteger value)` An implementation of `JsonSupport.toJson(JsonGenerator)` for a given `BigInteger`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, boolean value)` An implementation of `JsonSupport.toJson(JsonGenerator)` for a given `Boolean` value.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, double value)` An implementation of `JsonSupport.toJson(JsonGenerator)` for a given `Double`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, int value)` An implementation of `JsonSupport.toJson(JsonGenerator)` for a given `Integer`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, Iterable<?> value)` An implementation of `JsonSupport.toJson(JsonGenerator)` for a given `Iterable`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, long value)` An implementation of `JsonSupport.toJson(JsonGenerator)` for a given `Long`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, Map<?,?> value)` A implementation of `JsonSupport.toJson(JsonGenerator)` for a given `Map`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, Number value)` A generic implementation of `JsonSupport.toJson(JsonGenerator)` for a given `Number`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, Object value)` A generic implementation of `JsonSupport.toJson(JsonGenerator)` for a given `value`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, Object[] value)` A implementation of `JsonSupport.toJson(JsonGenerator)` for a given `array`.
`default void`	`write(javax.json.stream.JsonGenerator json, String property, String value)` An implementation of `JsonSupport.toJson(JsonGenerator)` for a given `String` value.
`default void`	`writeNull(javax.json.stream.JsonGenerator json, String property)` An implementation of `JsonSupport.toJson(JsonGenerator)` to write the `null` value.

- Method Detail
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   Object value)
```
    A generic implementation of JsonSupport.toJson(JsonGenerator) for a given value.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   String value)
```
    An implementation of JsonSupport.toJson(JsonGenerator) for a given String value.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   boolean value)
```
    An implementation of JsonSupport.toJson(JsonGenerator) for a given Boolean value.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   Number value)
```
    A generic implementation of JsonSupport.toJson(JsonGenerator) for a given Number.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   long value)
```
    An implementation of JsonSupport.toJson(JsonGenerator) for a given Long.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   double value)
```
    An implementation of JsonSupport.toJson(JsonGenerator) for a given Double.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   BigDecimal value)
```
    An implementation of JsonSupport.toJson(JsonGenerator) for a given BigDecimal.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   BigInteger value)
```
    An implementation of JsonSupport.toJson(JsonGenerator) for a given BigInteger.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   int value)
```
    An implementation of JsonSupport.toJson(JsonGenerator) for a given Integer.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - writeNull
```
default void writeNull(javax.json.stream.JsonGenerator json,
                       String property)
```
    An implementation of JsonSupport.toJson(JsonGenerator) to write the null value.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write null).
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   Iterable<?> value)
```
    An implementation of JsonSupport.toJson(JsonGenerator) for a given Iterable.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   Map<?,?> value)
```
    A implementation of JsonSupport.toJson(JsonGenerator) for a given Map.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON. May be null.
  - write
```
default void write(javax.json.stream.JsonGenerator json,
                   String property,
                   Object[] value)
```
    A implementation of JsonSupport.toJson(JsonGenerator) for a given array.
    
    Parameters:
    
    json - the JsonGenerator.
    
    property - the name of the JSON property or null for no property (just to write the value).
    
    value - the value to write as JSON array. May be null.
  - expectEvent
```
default void expectEvent(javax.json.stream.JsonParser json,
                         javax.json.stream.JsonParser.Event event)
                  throws ObjectMismatchException
```
    Parameters:
    
    json - the JsonParser to get the next JsonParser.Event from.
    
    event - the expected JsonParser.Event.
    
    Throws:
    
    ObjectMismatchException - if the expected JsonParser.Event does not match.
  - expectEvent
```
default void expectEvent(javax.json.stream.JsonParser.Event actual,
                         javax.json.stream.JsonParser.Event expected)
```
    Parameters:
    
    actual - the actual JsonParser.Event received from JsonParser.
    
    expected - the expected JsonParser.Event.
    
    Throws:
    
    ObjectMismatchException - if the expected JsonParser.Event does not match.
  - read
```
default <T> T read(javax.json.stream.JsonParser json,
                   GenericType<T> type)
```
    Type Parameters:
    
    T - the generic type of the object to parse.
    
    Parameters:
    
    json - the JsonParser.
    
    type - the GenericType of the requested object to parse.
    
    Returns:
    
    the parsed value.
  - read
```
<T> T read(javax.json.stream.JsonParser json,
           GenericType<T> type,
           javax.json.stream.JsonParser.Event e)
```
    Type Parameters:
    
    T - the generic type of the object to parse.
    
    Parameters:
    
    json - the JsonParser.
    
    type - the GenericType of the requested object to parse.
    
    e - the current JsonParser.Event.
    
    collectionReflectionUtil - the CollectionReflectionUtil instance.
    
    stringUtil - the StringUtil instance.
    
    Returns:
    
    the parsed value.
  - readEnum
```
<E extends Enum<E>> E readEnum(javax.json.stream.JsonParser json,
                               Class<E> enumType)
                        throws IllegalCaseException
```
    Type Parameters:
    
    E - the generic type of the Enum to parse.
    
    Parameters:
    
    json - the JsonParser.
    
    enumType - the Class reflecting the Enum to parse.
    
    stringUtil - the StringUtil instance.
    
    Returns:
    
    the parsed Enum constant.
    
    Throws:
    
    IllegalCaseException - if no such Enum constant exists.
  - readCollection
```
<C extends Collection<?>> C readCollection(javax.json.stream.JsonParser json,
                                           GenericType<C> type)
```
    Type Parameters:
    
    C - the generic type of the Collection.
    
    Parameters:
    
    json - the JsonParser.
    
    type - the GenericType of the Collection.
    
    Returns:
    
    the parsed Collection.
  - readCollection
```
<E> void readCollection(javax.json.stream.JsonParser json,
                        Collection<E> collection,
                        GenericType<E> type)
```
    Type Parameters:
    
    E - the generic type of the elements in the Collection.
    
    Parameters:
    
    json - the JsonParser.
    
    collection - the Collection where to add the elements parsed from JSON.
    
    type - the GenericType of the elements in the Collection.
  - readMap
```
<M extends Map<?,?>> M readMap(javax.json.stream.JsonParser json,
                               GenericType<M> type)
```
    Type Parameters:
    
    M - the generic type of the Map.
    
    Parameters:
    
    json - the JsonParser.
    
    type - the GenericType of the Map.
    
    Returns:
    
    the parsed Map.
  - readBoolean
```
default boolean readBoolean(javax.json.stream.JsonParser.Event e)
```
    Parameters:
    
    e - the JSON JsonParser.Event.
    
    Returns:
    
    the coressponding Boolean value.
  - readNumber
```
default <N extends Number> N readNumber(javax.json.stream.JsonParser json,
                                        Class<N> type)
```
    Type Parameters:
    
    N - the generic type of the Number to parse.
    
    Parameters:
    
    json - the JsonParser with current event being JsonParser.Event.VALUE_NUMBER.
    
    type - the Class reflecting the type of Number to parse.
    
    Returns:
    
    the parsed value.
  - skipValue
```
default void skipValue(javax.json.stream.JsonParser json)
```
    Skips the current value from the JsonParser.
    
    Parameters:
    
    json - the JsonParser.
  - skipValue
```
default void skipValue(javax.json.stream.JsonParser json,
                       javax.json.stream.JsonParser.Event e)
```
    Skips the current value from the JsonParser when the current JsonParser.Event was already read and is given.
    
    Parameters:
    
    json - the JsonParser.
    
    e - the JsonParser.Event that was already read before.

Interface JsonUtil

Method Summary

Method Detail

write

write

write

write

write

write

write

write

write

writeNull

write

write

write

expectEvent

expectEvent

read

read

readEnum

readCollection

readCollection

readMap

readBoolean

readNumber

skipValue

skipValue