org.pfsw.text.json

Class JsonObjectAccessor

java.lang.Object

org.pfsw.text.json.JsonObjectAccessor

public class JsonObjectAccessor
extends java.lang.Object

This is a wrapper around a single JsonObject. It supports read and write access to the objects's field values in a convenient way and supports optional and required field access as well as implicit type conversion. All access problems are signaled by JsonAccessException which is a RuntimeException.

Constructor Summary

Constructors

Constructor and Description
JsonObjectAccessor(JsonObject jsonObject) Creates a new accessor based on the given JSON object.

Method Summary

Modifier and Type	Method and Description
protected TimeValue	asTimeValue(java.lang.Long value, TimeUnit timeUnit)
static JsonObjectAccessor	create() Creates an accessor on a new empty JsonObject.
static JsonObjectAccessor	create(JsonObject jsonObject) Creates an accessor based on the given JSON object.
java.util.List<java.lang.String>	getFieldNames() Returns all field names present in the underlying JSON object (maybe empty but never null).
JsonObject	getJsonObject() Returns the underlying JSON object.
protected java.lang.Long	getLongValueOf(java.lang.String name)
protected java.lang.Long	getLongValueOf(java.lang.String name, java.lang.String targetTypeName)
protected NaturalNumber	getNaturalNumberValueOf(java.lang.String name)
java.math.BigDecimal	getOptionalBigDecimalValue(IStringConstant name) Returns either the value associated to the given name or null.
java.math.BigDecimal	getOptionalBigDecimalValue(java.lang.String name) Returns either the value associated to the given name or null.
java.lang.Boolean	getOptionalBooleanValue(IStringConstant name) Returns either the value associated to the given name or null.
java.lang.Boolean	getOptionalBooleanValue(java.lang.String name) Returns either the value associated to the given name or null.
java.lang.Integer	getOptionalIntegerValue(IStringConstant name) Returns either the value associated to the given name or null.
java.lang.Integer	getOptionalIntegerValue(java.lang.String name) Returns either the value associated to the given name or null.
JsonArray	getOptionalJsonArrayValue(IStringConstant name) Returns either the value associated to the given name or null.
JsonArray	getOptionalJsonArrayValue(java.lang.String name) Returns either the value associated to the given name or null.
JsonObjectAccessor	getOptionalJsonObjectAccessorValue(IStringConstant name) Returns either the value associated to the given name or null.
JsonObjectAccessor	getOptionalJsonObjectAccessorValue(java.lang.String name) Returns either the value associated to the given name or null.
JsonObject	getOptionalJsonObjectValue(IStringConstant name) Returns either the value associated to the given name or null.
JsonObject	getOptionalJsonObjectValue(java.lang.String name) Returns either the value associated to the given name or null.
java.lang.Long	getOptionalLongValue(IStringConstant name) Returns either the value associated to the given name or null.
java.lang.Long	getOptionalLongValue(java.lang.String name) Returns either the value associated to the given name or null.
NaturalNumber	getOptionalNaturalNumberValue(IStringConstant name) Returns either the value associated to the given name or null.
NaturalNumber	getOptionalNaturalNumberValue(java.lang.String name) Returns either the value associated to the given name or null.
java.lang.Object	getOptionalRawValue(IStringConstant name) Returns either the value associated to the given name or null.
java.lang.Object	getOptionalRawValue(java.lang.String name) Returns either the value associated to the given name or null.
java.lang.String[]	getOptionalStringArrayValue(IStringConstant name) Returns either the value associated to the given name or null.
java.lang.String[]	getOptionalStringArrayValue(java.lang.String name) Returns either the value associated to the given name or null.
java.lang.String	getOptionalStringValue(IStringConstant name) Returns either the value associated to the given name or null.
java.lang.String	getOptionalStringValue(java.lang.String name) Returns either the value associated to the given name or null.
TimeValue	getOptionalTimeValue(IStringConstant name, TimeUnit timeUnit) Returns the value at the specified field name as a TimeValue with the specified TimeUnit.
TimeValue	getOptionalTimeValue(java.lang.String name, TimeUnit timeUnit) Returns the value at the specified field name as a TimeValue with the specified TimeUnit.
<T> T	getOptionalTypedValue(IStringConstant name, java.lang.Class<T> type) Returns either the value associated to the given name or null if not preset.
<T> T	getOptionalTypedValue(java.lang.String name, java.lang.Class<T> type) Returns either the value associated to the given name or null if not preset.
java.lang.Object	getRawValueOf(IStringConstant name, boolean isRequired)
java.lang.Object	getRawValueOf(java.lang.String name, boolean isRequired)
java.math.BigDecimal	getRequiredBigDecimalValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.math.BigDecimal	getRequiredBigDecimalValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.Boolean	getRequiredBooleanValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.Boolean	getRequiredBooleanValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.Integer	getRequiredIntegerValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.Integer	getRequiredIntegerValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
JsonArray	getRequiredJsonArrayValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
JsonArray	getRequiredJsonArrayValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
JsonObjectAccessor	getRequiredJsonObjectAccessorValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
JsonObjectAccessor	getRequiredJsonObjectAccessorValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
JsonObject	getRequiredJsonObjectValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
JsonObject	getRequiredJsonObjectValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.Long	getRequiredLongValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.Long	getRequiredLongValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
NaturalNumber	getRequiredNaturalNumberValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
NaturalNumber	getRequiredNaturalNumberValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.Object	getRequiredRawValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present.
java.lang.Object	getRequiredRawValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present.
java.lang.String[]	getRequiredStringArrayValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.String[]	getRequiredStringArrayValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.String	getRequiredStringValue(IStringConstant name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
java.lang.String	getRequiredStringValue(java.lang.String name) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
TimeValue	getRequiredTimeValue(IStringConstant name, TimeUnit timeUnit) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
TimeValue	getRequiredTimeValue(java.lang.String name, TimeUnit timeUnit) Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).
<T> T	getRequiredTypedValue(IStringConstant name, java.lang.Class<T> type) Returns either the value associated to the given name or @throws JsonAccessException if the value is not of the specified type or not present.
<T> T	getRequiredTypedValue(java.lang.String name, java.lang.Class<T> type) Returns either the value associated to the given name or @throws JsonAccessException if the value is not of the specified type or not present.
protected java.lang.String[]	getStringArray(java.lang.String name, boolean isRequired)
<T> T	getTypedValueOf(IStringConstant name, java.lang.Class<T> type, boolean isRequired)
<T> T	getTypedValueOf(java.lang.String name, java.lang.Class<T> type, boolean isRequired)
boolean	hasField(IStringConstant name) Returns whether or not this JSON object contains a field with the given name.
boolean	hasField(java.lang.String name) Returns whether or not this JSON object contains a field with the given name.
boolean	isEmpty() Returns true if the underlying JSON object contains no field at all.
JsonObjectAccessor	setFieldValue(IStringConstant name, java.lang.Object value) Sets the field with the given name to the specified value.
JsonObjectAccessor	setFieldValue(java.lang.String name, java.lang.Object value) Sets the field with the given name to the specified value.
void	signalRequiredFieldMissing(java.lang.String fieldName)

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonObjectAccessor

public JsonObjectAccessor(JsonObject jsonObject)

Creates a new accessor based on the given JSON object.

Parameters:

jsonObject - The JSON object to be accessed (must not be null). throws IllegalArgumentException if the given jsonObject is null.

Method Detail

create

public static JsonObjectAccessor create()

Creates an accessor on a new empty JsonObject.

create

public static JsonObjectAccessor create(JsonObject jsonObject)

Creates an accessor based on the given JSON object.

Parameters:

jsonObject - The JSON object to be accessed (must not be null). throws IllegalArgumentException if the given jsonObject is null.

getJsonObject

public JsonObject getJsonObject()

Returns the underlying JSON object.

getFieldNames

public java.util.List<java.lang.String> getFieldNames()

Returns all field names present in the underlying JSON object (maybe empty but never null).

getRequiredJsonObjectAccessorValue

public JsonObjectAccessor getRequiredJsonObjectAccessorValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredJsonObjectAccessorValue

public JsonObjectAccessor getRequiredJsonObjectAccessorValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredJsonObjectValue

public JsonObject getRequiredJsonObjectValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredJsonObjectValue

public JsonObject getRequiredJsonObjectValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredJsonArrayValue

public JsonArray getRequiredJsonArrayValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredJsonArrayValue

public JsonArray getRequiredJsonArrayValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredStringValue

public java.lang.String getRequiredStringValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredStringValue

public java.lang.String getRequiredStringValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredStringArrayValue

public java.lang.String[] getRequiredStringArrayValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredStringArrayValue

public java.lang.String[] getRequiredStringArrayValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredBooleanValue

public java.lang.Boolean getRequiredBooleanValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredBooleanValue

public java.lang.Boolean getRequiredBooleanValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredIntegerValue

public java.lang.Integer getRequiredIntegerValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredIntegerValue

public java.lang.Integer getRequiredIntegerValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredLongValue

public java.lang.Long getRequiredLongValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredLongValue

public java.lang.Long getRequiredLongValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredBigDecimalValue

public java.math.BigDecimal getRequiredBigDecimalValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredBigDecimalValue

public java.math.BigDecimal getRequiredBigDecimalValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredNaturalNumberValue

public NaturalNumber getRequiredNaturalNumberValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredNaturalNumberValue

public NaturalNumber getRequiredNaturalNumberValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredTimeValue

public TimeValue getRequiredTimeValue(IStringConstant name,
                                      TimeUnit timeUnit)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredTimeValue

public TimeValue getRequiredTimeValue(java.lang.String name,
                                      TimeUnit timeUnit)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present or of another type that expected (according to the return type of this method).

getRequiredRawValue

public java.lang.Object getRequiredRawValue(IStringConstant name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present.

getRequiredRawValue

public java.lang.Object getRequiredRawValue(java.lang.String name)

Returns either the value associated to the given name or throws a JsonAccessException if the value is not present.

getOptionalJsonObjectAccessorValue

public JsonObjectAccessor getOptionalJsonObjectAccessorValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalJsonObjectAccessorValue

public JsonObjectAccessor getOptionalJsonObjectAccessorValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalJsonObjectValue

public JsonObject getOptionalJsonObjectValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalJsonObjectValue

public JsonObject getOptionalJsonObjectValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalJsonArrayValue

public JsonArray getOptionalJsonArrayValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalJsonArrayValue

public JsonArray getOptionalJsonArrayValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalStringValue

public java.lang.String getOptionalStringValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalStringValue

public java.lang.String getOptionalStringValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalStringArrayValue

public java.lang.String[] getOptionalStringArrayValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalStringArrayValue

public java.lang.String[] getOptionalStringArrayValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalBooleanValue

public java.lang.Boolean getOptionalBooleanValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalBooleanValue

public java.lang.Boolean getOptionalBooleanValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalIntegerValue

public java.lang.Integer getOptionalIntegerValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalIntegerValue

public java.lang.Integer getOptionalIntegerValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalLongValue

public java.lang.Long getOptionalLongValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalLongValue

public java.lang.Long getOptionalLongValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalBigDecimalValue

public java.math.BigDecimal getOptionalBigDecimalValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalBigDecimalValue

public java.math.BigDecimal getOptionalBigDecimalValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalNaturalNumberValue

public NaturalNumber getOptionalNaturalNumberValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalNaturalNumberValue

public NaturalNumber getOptionalNaturalNumberValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalTimeValue

public TimeValue getOptionalTimeValue(IStringConstant name,
                                      TimeUnit timeUnit)

Returns the value at the specified field name as a TimeValue with the specified TimeUnit.

Parameters:

name - The name of the field (must not be null).

timeUnit - The time unit of the value found in the object (must not be null).

Returns:

Returns either the TimeUnit or null if field not present.

getOptionalTimeValue

public TimeValue getOptionalTimeValue(java.lang.String name,
                                      TimeUnit timeUnit)

Returns the value at the specified field name as a TimeValue with the specified TimeUnit.

Parameters:

name - The name of the field (must not be null).

timeUnit - The time unit of the value found in the object (must not be null).

Returns:

Returns either the TimeUnit or null if field not present.

getOptionalRawValue

public java.lang.Object getOptionalRawValue(IStringConstant name)

Returns either the value associated to the given name or null.

getOptionalRawValue

public java.lang.Object getOptionalRawValue(java.lang.String name)

Returns either the value associated to the given name or null.

getOptionalTypedValue

public <T> T getOptionalTypedValue(IStringConstant name,
                                   java.lang.Class<T> type)

Returns either the value associated to the given name or null if not preset.

Throws:

JsonAccessException - if the value is not of the specified type.

getOptionalTypedValue

public <T> T getOptionalTypedValue(java.lang.String name,
                                   java.lang.Class<T> type)

Returns either the value associated to the given name or null if not preset.

Throws:

JsonAccessException - if the value is not of the specified type.

getRequiredTypedValue

public <T> T getRequiredTypedValue(IStringConstant name,
                                   java.lang.Class<T> type)

Returns either the value associated to the given name or @throws JsonAccessException if the value is not of the specified type or not present.

getRequiredTypedValue

public <T> T getRequiredTypedValue(java.lang.String name,
                                   java.lang.Class<T> type)

Returns either the value associated to the given name or @throws JsonAccessException if the value is not of the specified type or not present.

getTypedValueOf

public <T> T getTypedValueOf(IStringConstant name,
                             java.lang.Class<T> type,
                             boolean isRequired)

getTypedValueOf

public <T> T getTypedValueOf(java.lang.String name,
                             java.lang.Class<T> type,
                             boolean isRequired)

getRawValueOf

public java.lang.Object getRawValueOf(IStringConstant name,
                                      boolean isRequired)

getRawValueOf

public java.lang.Object getRawValueOf(java.lang.String name,
                                      boolean isRequired)

setFieldValue

public JsonObjectAccessor setFieldValue(java.lang.String name,
                                        java.lang.Object value)

Sets the field with the given name to the specified value.

Parameters:

name - The name of the field.

value - The value to be set.

Returns:

this object instance.

setFieldValue

public JsonObjectAccessor setFieldValue(IStringConstant name,
                                        java.lang.Object value)

Sets the field with the given name to the specified value.

Parameters:

name - The name of the field.

value - The value to be set.

Returns:

this object instance.

hasField

public boolean hasField(java.lang.String name)

Returns whether or not this JSON object contains a field with the given name.

hasField

public boolean hasField(IStringConstant name)

Returns whether or not this JSON object contains a field with the given name.

isEmpty

public boolean isEmpty()

Returns true if the underlying JSON object contains no field at all.

signalRequiredFieldMissing

public void signalRequiredFieldMissing(java.lang.String fieldName)
                                throws JsonAccessException

Throws:

JsonAccessException

getStringArray

protected java.lang.String[] getStringArray(java.lang.String name,
                                            boolean isRequired)

getNaturalNumberValueOf

protected NaturalNumber getNaturalNumberValueOf(java.lang.String name)

getLongValueOf

protected java.lang.Long getLongValueOf(java.lang.String name)

getLongValueOf

protected java.lang.Long getLongValueOf(java.lang.String name,
                                        java.lang.String targetTypeName)

asTimeValue

protected TimeValue asTimeValue(java.lang.Long value,
                                TimeUnit timeUnit)