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

Method Summary

Methods

Modifier and Type	Method and Description
JsonObject	getJsonObject()
protected <T> T	getLongValueOf(java.lang.String name, java.lang.Class<T> type)
java.math.BigDecimal	getOptionalBigDecimalValue(java.lang.String name)
java.lang.Boolean	getOptionalBooleanValue(java.lang.String name)
java.lang.Integer	getOptionalIntegerValue(java.lang.String name)
JsonArray	getOptionalJsonArrayValue(java.lang.String name)
JsonObjectAccessor	getOptionalJsonObjectAccessorValue(java.lang.String name)
JsonObject	getOptionalJsonObjectValue(java.lang.String name)
java.lang.Long	getOptionalLongValue(java.lang.String name)
java.lang.Object	getOptionalRawValue(java.lang.String name)
java.lang.String[]	getOptionalStringArrayValue(java.lang.String name)
java.lang.String	getOptionalStringValue(java.lang.String name)
<T> T	getOptionalTypedValue(java.lang.String name, java.lang.Class<T> type)
java.lang.Object	getRawValueOf(java.lang.String name, boolean isRequired)
java.math.BigDecimal	getRequiredBigDecimalValue(java.lang.String name)
java.lang.Boolean	getRequiredBooleanValue(java.lang.String name)
java.lang.Integer	getRequiredIntegerValue(java.lang.String name)
JsonArray	getRequiredJsonArrayValue(java.lang.String name)
JsonObjectAccessor	getRequiredJsonObjectAccessorValue(java.lang.String name)
JsonObject	getRequiredJsonObjectValue(java.lang.String name)
java.lang.Long	getRequiredLongValue(java.lang.String name)
java.lang.Object	getRequiredRawValue(java.lang.String name)
java.lang.String[]	getRequiredStringArrayValue(java.lang.String name)
java.lang.String	getRequiredStringValue(java.lang.String name)
<T> T	getRequiredTypedValue(java.lang.String name, java.lang.Class<T> type)
protected java.lang.String[]	getStringArray(java.lang.String name, boolean isRequired)
<T> T	getTypedValueOf(java.lang.String name, java.lang.Class<T> type, boolean isRequired)
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)

Method Detail

getJsonObject

public JsonObject getJsonObject()

getRequiredJsonObjectAccessorValue

public JsonObjectAccessor getRequiredJsonObjectAccessorValue(java.lang.String name)

getRequiredJsonObjectValue

public JsonObject getRequiredJsonObjectValue(java.lang.String name)

getRequiredJsonArrayValue

public JsonArray getRequiredJsonArrayValue(java.lang.String name)

getRequiredStringValue

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

getRequiredStringArrayValue

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

getRequiredBooleanValue

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

getRequiredIntegerValue

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

getRequiredLongValue

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

getRequiredBigDecimalValue

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

getRequiredRawValue

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

getOptionalJsonObjectAccessorValue

public JsonObjectAccessor getOptionalJsonObjectAccessorValue(java.lang.String name)

getOptionalJsonObjectValue

public JsonObject getOptionalJsonObjectValue(java.lang.String name)

getOptionalJsonArrayValue

public JsonArray getOptionalJsonArrayValue(java.lang.String name)

getOptionalStringValue

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

getOptionalStringArrayValue

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

getOptionalBooleanValue

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

getOptionalIntegerValue

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

getOptionalLongValue

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

getOptionalBigDecimalValue

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

getOptionalRawValue

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

getOptionalTypedValue

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

getRequiredTypedValue

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

getTypedValueOf

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

getRawValueOf

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

signalRequiredFieldMissing

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

Throws:

JsonAccessException

getStringArray

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

getLongValueOf

protected <T> T getLongValueOf(java.lang.String name,
                   java.lang.Class<T> type)