com.github.nmorel.gwtjackson.client

Class JsonDeserializationContext.Builder

java.lang.Object

com.github.nmorel.gwtjackson.client.JsonDeserializationContext.Builder

Enclosing class:

JsonDeserializationContext

public static class JsonDeserializationContext.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
JsonDeserializationContext.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
JsonDeserializationContext.Builder	acceptSingleValueAsArray(boolean acceptSingleValueAsArray) Feature that determines whether it is acceptable to coerce non-array (in JSON) values to work with Java collection (arrays, java.util.Collection) types.
JsonDeserializationContext	build()
JsonDeserializationContext.Builder	failOnUnknownProperties(boolean failOnUnknownProperties) Determines whether encountering of unknown properties (ones that do not map to a property, and there is no "any setter" or handler that can handle it) should result in a failure (by throwing a JsonDeserializationException) or not.
JsonDeserializationContext.Builder	unwrapRootValue(boolean unwrapRootValue) Feature to allow "unwrapping" root-level JSON value, to match setting of JsonSerializationContext.Builder.wrapRootValue(boolean) used for serialization.
JsonDeserializationContext.Builder	wrapExceptions(boolean wrapExceptions) Feature that determines whether gwt-jackson code should catch and wrap RuntimeExceptions (but never Errors!) to add additional information about location (within input) of problem or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonDeserializationContext.Builder

public JsonDeserializationContext.Builder()

Method Detail

failOnUnknownProperties

public JsonDeserializationContext.Builder failOnUnknownProperties(boolean failOnUnknownProperties)

Determines whether encountering of unknown properties (ones that do not map to a property, and there is no "any setter" or handler that can handle it) should result in a failure (by throwing a JsonDeserializationException) or not. This setting only takes effect after all other handling methods for unknown properties have been tried, and property remains unhandled.

Feature is enabled by default (meaning that a JsonDeserializationException will be thrown if an unknown property is encountered).

unwrapRootValue

public JsonDeserializationContext.Builder unwrapRootValue(boolean unwrapRootValue)

Feature to allow "unwrapping" root-level JSON value, to match setting of JsonSerializationContext.Builder.wrapRootValue(boolean) used for serialization. Will verify that the root JSON value is a JSON Object, and that it has a single property with expected root name. If not, a JsonDeserializationException is thrown; otherwise value of the wrapped property will be deserialized as if it was the root value.

Feature is disabled by default.

acceptSingleValueAsArray

public JsonDeserializationContext.Builder acceptSingleValueAsArray(boolean acceptSingleValueAsArray)

Feature that determines whether it is acceptable to coerce non-array (in JSON) values to work with Java collection (arrays, java.util.Collection) types. If enabled, collection deserializers will try to handle non-array values as if they had "implicit" surrounding JSON array. This feature is meant to be used for compatibility/interoperability reasons, to work with packages (such as XML-to-JSON converters) that leave out JSON array in cases where there is just a single element in array.

Feature is disabled by default.

wrapExceptions

public JsonDeserializationContext.Builder wrapExceptions(boolean wrapExceptions)

Feature that determines whether gwt-jackson code should catch and wrap RuntimeExceptions (but never Errors!) to add additional information about location (within input) of problem or not. If enabled, exceptions will be caught and re-thrown; this can be convenient both in that all exceptions will be checked and declared, and so there is more contextual information. However, sometimes calling application may just want "raw" unchecked exceptions passed as is.

Feature is enabled by default.

build

public JsonDeserializationContext build()