Class DeserializationContext
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
DefaultDeserializationContext
Instance life-cycle is such that a partially configured "blueprint" object
is registered with ObjectMapper
(and ObjectReader
,
and when actual instance is needed for deserialization,
a fully configured instance will be created using a method in extended internal
API of sub-class
(DefaultDeserializationContext.createInstance(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationConfig, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.InjectableValues)
).
Each instance is guaranteed to only be used from single-threaded context;
instances may be reused if (and only if) no configuration has changed.
Defined as abstract class so that implementations must define methods for reconfiguring blueprints and creating instances.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected ArrayBuilders
protected ContextAttributes
Lazily-constructed holder for per-call attributes.protected final DeserializerCache
Object that handle details ofJsonDeserializer
caching.protected final DeserializationConfig
Generic deserialization processing configurationprotected LinkedNode<JavaType>
Type ofJsonDeserializer
(or, more specifically,ContextualDeserializer
) that is being contextualized currently.protected DateFormat
protected final DeserializerFactory
Read-only factory instance; exposed to let owners (ObjectMapper
,ObjectReader
) access it.protected final int
Bitmap ofDeserializationFeature
s that are enabledprotected final InjectableValues
Object used for resolving references to injectable values.protected ObjectBuffer
protected JsonParser
Currently active parser used for deserialization.protected final JacksonFeatureSet<StreamReadCapability>
Capabilities of the input format.protected final Class<?>
Currently active view, if any. -
Constructor Summary
ModifierConstructorDescriptionprotected
protected
protected
Copy-constructor for use withcopy()
byObjectMapper.copy()
protected
DeserializationContext
(DeserializationContext src, DeserializerFactory factory) protected
Constructor used for creating bogus per-call style instance, but without underlying parser: needed for deserializer pre-fetchingprotected
DeserializationContext
(DeserializationContext src, DeserializationConfig config, JsonParser p, InjectableValues injectableValues) Constructor used for creating actual per-call instances. -
Method Summary
Modifier and TypeMethodDescriptionprotected DateFormat
protected boolean
_isCompatible
(Class<?> target, Object value) protected String
Helper method for constructing description like "Object value" givenJsonToken
encountered.Convenience method, equivalent to:final TokenBuffer
Convenience method that is equivalent to:Factory method used for creatingTokenBuffer
to temporarily contain copy of content read from specified parser; usually for purpose of reading contents later on (possibly augmeneted with injected additional content)final boolean
Convenience method for accessing serialization view in use (if any); equivalent to:abstract void
Method called to ensure that every object id encounter during processing are resolved.Convenience method for constructing Calendar instance set to specified time, to be modified and used by caller.constructSpecializedType
(JavaType baseType, Class<?> subclass) Convenience method for constructing subtypes, retaining generic type parameter (if any).final JavaType
constructType
(Class<?> cls) Convenience method, functionally equivalent to:abstract JsonDeserializer<Object>
deserializerInstance
(Annotated annotated, Object deserDef) endOfInputException
(Class<?> instClass) Deprecated.Since 2.8; currently no way to catch EOF at databind levelextractScalarFromObject
(JsonParser p, JsonDeserializer<?> deser, Class<?> scalarType) Method to call in case incoming shape is Object Value (and parser thereby points toJsonToken.START_OBJECT
token), but a Scalar value (potentially coercible from String value) is expected.Class<?>
Helper method that is to be used when resolving basic class name into Class instance, the reason being that it may be necessary to work around various ClassLoader limitations, as well as to handle primitive type signatures.findCoercionAction
(LogicalType targetType, Class<?> targetClass, CoercionInputShape inputShape) General-purpose accessor for finding what to do when specified coercion from shape that is now always allowed to be coerced from is requested.findCoercionFromBlankString
(LogicalType targetType, Class<?> targetClass, CoercionAction actionIfBlankNotAllowed) More specialized accessor called in case of input being a blank String (one consisting of only white space characters with length of at least one).final JsonDeserializer<Object>
findContextualValueDeserializer
(JavaType type, BeanProperty prop) Method for finding a value deserializer, and creating a contextual version if necessary, for value reached via specified property.final Object
findInjectableValue
(Object valueId, BeanProperty forProperty, Object beanInstance) final KeyDeserializer
findKeyDeserializer
(JavaType keyType, BeanProperty prop) Convenience method, functionally same as:final JsonDeserializer<Object>
Variant that will try to locate deserializer for current type, but without performing any contextualization (unlikefindContextualValueDeserializer(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanProperty)
) or checking for need to create aTypeDeserializer
(unlikefindRootValueDeserializer(JavaType)
.abstract ReadableObjectId
findObjectId
(Object id, ObjectIdGenerator<?> generator, ObjectIdResolver resolver) Method called to find and return entry corresponding to given Object Id: will add an entry if necessary, and never returns nullfinal JsonDeserializer<Object>
Method for finding a deserializer for root-level value.final Class<?>
Accessor for locating currently active view, if any; returns null if no view has been set.final AnnotationIntrospector
Convenience method for accessing serialization view in use (if any); equivalent to:final ArrayBuilders
Method for accessing object useful for building arrays of primitive types (such as int[]).getAttribute
(Object key) Method for accessing attributes available in this context.final Base64Variant
Convenience method for accessing the default Base64 encoding used for decoding base64 encoded binary content.Accessor to currently active configuration (both per-request configs and per-mapper config).Accessor toJavaType
of currently contextualizedContextualDeserializer
, if any.protected DateFormat
Deprecated.final JsonFormat.Value
getDefaultPropertyFormat
(Class<?> baseType) final int
Bulk access method for getting the bit mask of allDeserializationFeature
s that are enabled.Method for getting currentDeserializerFactory
.Method for accessing default Locale to use: convenience method forfinal JsonNodeFactory
Convenience method, functionally equivalent to:final JsonParser
Method for accessing the currently active parser.Method for accessing default TimeZone to use: convenience method forfinal TypeFactory
void
handleBadMerge
(JsonDeserializer<?> deser) Method that deserializer may call if it is called to do an update ("merge") but deserializer operates on a non-mergeable type.handleInstantiationProblem
(Class<?> instClass, Object argument, Throwable t) Method that deserializers should call if they fail to instantiate value due to an exception that was thrown by constructor (or other mechanism used to create instances).handleMissingInstantiator
(Class<?> instClass, ValueInstantiator valueInst, JsonParser p, String msg, Object... msgArgs) Method that deserializers should call if they fail to instantiate value due to lack of viable instantiator (usually creator, that is, constructor or static factory method).handleMissingTypeId
(JavaType baseType, TypeIdResolver idResolver, String extraDesc) handlePrimaryContextualization
(JsonDeserializer<?> deser, BeanProperty prop, JavaType type) Method called for primary property deserializers (ones directly created to deserialize values of a POJO property), to handle details of resolvingContextualDeserializer
with given property context.handleSecondaryContextualization
(JsonDeserializer<?> deser, BeanProperty prop, JavaType type) Method called for secondary property deserializers (ones NOT directly created to deal with an annotatable POJO property, but instead created as a component -- such as value deserializers for structured types, or deserializers for root values) to handle details of resolvingContextualDeserializer
with given property context.handleUnexpectedToken
(JavaType targetType, JsonParser p) Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle).handleUnexpectedToken
(JavaType targetType, JsonToken t, JsonParser p, String msg, Object... msgArgs) Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle).handleUnexpectedToken
(Class<?> instClass, JsonParser p) Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle).handleUnexpectedToken
(Class<?> instClass, JsonToken t, JsonParser p, String msg, Object... msgArgs) Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle).boolean
handleUnknownProperty
(JsonParser p, JsonDeserializer<?> deser, Object instanceOrClass, String propName) Method that deserializers should call if they encounter an unrecognized property (and once that is not explicitly designed as ignorable), to inform possibly configuredDeserializationProblemHandler
s and let it handle the problem.handleUnknownTypeId
(JavaType baseType, String id, TypeIdResolver idResolver, String extraDesc) Method that deserializers should call if they encounter a type id (for polymorphic deserialization) that cannot be resolved to an actual type; usually since there is no mapping defined.handleWeirdKey
(Class<?> keyClass, String keyValue, String msg, Object... msgArgs) Method that deserializers should call if they encounter a String value that cannot be converted to expected key of aMap
valued property.handleWeirdNativeValue
(JavaType targetType, Object badValue, JsonParser p) handleWeirdNumberValue
(Class<?> targetClass, Number value, String msg, Object... msgArgs) Method that deserializers should call if they encounter a numeric value that cannot be converted to target property type, in cases where some numeric values could be acceptable (either with different settings, or different numeric value).handleWeirdStringValue
(Class<?> targetClass, String value, String msg, Object... msgArgs) Method that deserializers should call if they encounter a String value that cannot be converted to target property type, in cases where some String values could be acceptable (either with different settings, or different value).final boolean
hasDeserializationFeatures
(int featureMask) Bulk access method for checking that all features specified by mask are enabled.final boolean
hasSomeOfFeatures
(int featureMask) Bulk access method for checking that at least one of features specified by mask is enabled.boolean
hasValueDeserializerFor
(JavaType type, AtomicReference<Throwable> cause) Method for checking whether we could find a deserializer for given type.instantiationException
(Class<?> instClass, String msg0) Helper method for constructing instantiation exception for specified type, to indicate that instantiation failed due to missing instantiator (creator; constructor or factory method).instantiationException
(Class<?> instClass, Throwable cause) Helper method for constructing instantiation exception for specified type, to indicate problem with physically constructing instance of specified class (missing constructor, exception from constructor)invalidTypeIdException
(JavaType baseType, String typeId, String extraDesc) Helper method for constructing exception to indicate that given type id could not be resolved to a valid subtype of specified base type.final boolean
Accessor for checking whether input format has specified capability or not.final boolean
isEnabled
(DatatypeFeature feature) Method for checking whether specified datatype feature is enabled or not.final boolean
Convenience method for checking whether specified on/off feature is enabledfinal boolean
isEnabled
(MapperFeature feature) Convenience method for checking whether specified Mapper feature is enabled or not.abstract KeyDeserializer
keyDeserializerInstance
(Annotated annotated, Object deserDef) final ObjectBuffer
Method that can be used to get access to a reusable ObjectBuffer, useful for efficiently constructing Object arrays and Lists.mappingException
(Class<?> targetClass) Deprecated.Since 2.8 usehandleUnexpectedToken(Class, JsonParser)
insteadmappingException
(Class<?> targetClass, JsonToken token) Deprecated.Since 2.8 usehandleUnexpectedToken(Class, JsonParser)
insteadmappingException
(String message) Deprecated.Since 2.9 use more specific error reporting methods insteadmappingException
(String msg, Object... msgArgs) Deprecated.Since 2.9 use more specific error reporting methods insteadmissingTypeIdException
(JavaType baseType, String extraDesc) Convenience method for parsing a Date from given String, using currently configured date format (accessed usingMapperConfig.getDateFormat()
).<T> T
readPropertyValue
(JsonParser p, BeanProperty prop, JavaType type) Same asreadPropertyValue(JsonParser, BeanProperty, Class)
but with fully resolvedJavaType
as target: needs to be used for generic types, for example.<T> T
readPropertyValue
(JsonParser p, BeanProperty prop, Class<T> type) Convenience method that may be used by composite or container deserializers, for reading one-off values for the composite type, taking into account annotations that the property (passed to this method -- usually property that has custom serializer that called this method) has.Convenience method for reading the value that passedJsonParser
points to as aJsonNode
.<T> T
readTreeAsValue
(JsonNode n, JavaType targetType) <T> T
readTreeAsValue
(JsonNode n, Class<T> targetType) Helper method similar toObjectReader.treeToValue(TreeNode, Class)
which will read contents of given tree (JsonNode
) and bind them into specified target type.<T> T
readValue
(JsonParser p, JavaType type) <T> T
readValue
(JsonParser p, Class<T> type) Convenience method that may be used by composite or container deserializers, for reading one-off values contained (for sequences, it is more efficient to actually fetch deserializer once for the whole collection).<T> T
reportBadCoercion
(JsonDeserializer<?> src, Class<?> targetType, Object inputValue, String msg, Object... msgArgs) Helper method used to indicate a problem with input in cases where specific input coercion was not allowed.<T> T
reportBadDefinition
(JavaType type, String msg) Helper method called to indicate a generic problem that stems from type definition(s), not input data, or input/output state; typically this means throwing aInvalidDefinitionException
.<T> T
reportBadMerge
(JsonDeserializer<?> deser) Deprecated.<T> T
reportBadPropertyDefinition
(BeanDescription bean, BeanPropertyDefinition prop, String msg, Object... msgArgs) Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific property (of a type), unrelated to actual JSON content to map.<T> T
reportBadTypeDefinition
(BeanDescription bean, String msg, Object... msgArgs) Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific Java type, unrelated to actual JSON content to map.<T> T
reportInputMismatch
(BeanProperty prop, String msg, Object... msgArgs) Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.<T> T
reportInputMismatch
(JavaType targetType, String msg, Object... msgArgs) Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.<T> T
reportInputMismatch
(JsonDeserializer<?> src, String msg, Object... msgArgs) Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.<T> T
reportInputMismatch
(Class<?> targetType, String msg, Object... msgArgs) Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.void
reportMappingException
(String msg, Object... msgArgs) Deprecated.Since 2.9: use a more specific method, orreportBadDefinition(JavaType, String)
, orreportInputMismatch(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer<?>, java.lang.String, java.lang.Object...)
insteadvoid
reportMissingContent
(String msg, Object... msgArgs) Deprecated.Since 2.9: not clear this ever occurs<T> T
reportPropertyInputMismatch
(JavaType targetType, String propertyName, String msg, Object... msgArgs) Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.<T> T
reportPropertyInputMismatch
(Class<?> targetType, String propertyName, String msg, Object... msgArgs) Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.<T> T
reportTrailingTokens
(Class<?> targetType, JsonParser p, JsonToken trailingToken) void
reportUnknownProperty
(Object instanceOrClass, String fieldName, JsonDeserializer<?> deser) <T> T
reportUnresolvedObjectId
(ObjectIdReader oidReader, Object bean) void
reportWrongTokenException
(JsonParser p, JsonToken expToken, String msg, Object... msgArgs) Deprecated.void
reportWrongTokenException
(JavaType targetType, JsonToken expToken, String msg, Object... msgArgs) Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens.void
reportWrongTokenException
(JsonDeserializer<?> deser, JsonToken expToken, String msg, Object... msgArgs) Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens.void
reportWrongTokenException
(Class<?> targetType, JsonToken expToken, String msg, Object... msgArgs) Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens.final void
Method to call to return object buffer previously leased withleaseObjectBuffer()
.setAttribute
(Object key, Object value) Method for setting per-call value of given attribute.unknownTypeException
(JavaType type, String id, String extraDesc) weirdKeyException
(Class<?> keyClass, String keyValue, String msg) Helper method for constructing exception to indicate that given JSON Object field name was not in format to be able to deserialize specified key type.weirdNativeValueException
(Object value, Class<?> instClass) Helper method for constructing exception to indicate that input JSON token of type "native value" (seeJsonToken.VALUE_EMBEDDED_OBJECT
) is of incompatible type (and there is no delegating creator or such to use) and can not be used to construct value of specified type (usually POJO).weirdNumberException
(Number value, Class<?> instClass, String msg) Helper method for constructing exception to indicate that input JSON Number was not suitable for deserializing into given target type.weirdStringException
(String value, Class<?> instClass, String msgBase) Helper method for constructing exception to indicate that input JSON String was not suitable for deserializing into given target type.wrongTokenException
(JsonParser p, JsonToken expToken, String msg) Deprecated.wrongTokenException
(JsonParser p, JavaType targetType, JsonToken expToken, String extra) Helper method for constructingJsonMappingException
to indicate that the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens.wrongTokenException
(JsonParser p, Class<?> targetType, JsonToken expToken, String extra) Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DatabindContext
_colonConcat, _desc, _format, _quotedString, _throwNotASubtype, _throwSubtypeClassNotAllowed, _throwSubtypeNameNotAllowed, _truncate, constructType, converterInstance, objectIdGeneratorInstance, objectIdResolverInstance, reportBadDefinition, resolveAndValidateSubType, resolveSubType
-
Field Details
-
_cache
Object that handle details ofJsonDeserializer
caching. -
_factory
Read-only factory instance; exposed to let owners (ObjectMapper
,ObjectReader
) access it. -
_config
Generic deserialization processing configuration -
_featureFlags
protected final int _featureFlagsBitmap ofDeserializationFeature
s that are enabled -
_readCapabilities
Capabilities of the input format.- Since:
- 2.12
-
_view
Currently active view, if any. -
_parser
Currently active parser used for deserialization. May be different from the outermost parser when content is buffered. -
_injectableValues
Object used for resolving references to injectable values. -
_arrayBuilders
-
_objectBuffer
-
_dateFormat
-
_attributes
Lazily-constructed holder for per-call attributes.- Since:
- 2.3
-
_currentType
Type ofJsonDeserializer
(or, more specifically,ContextualDeserializer
) that is being contextualized currently.- Since:
- 2.5
-
-
Constructor Details
-
DeserializationContext
-
DeserializationContext
-
DeserializationContext
-
DeserializationContext
protected DeserializationContext(DeserializationContext src, DeserializationConfig config, JsonParser p, InjectableValues injectableValues) Constructor used for creating actual per-call instances. -
DeserializationContext
Constructor used for creating bogus per-call style instance, but without underlying parser: needed for deserializer pre-fetching- Since:
- 2.12
-
DeserializationContext
Copy-constructor for use withcopy()
byObjectMapper.copy()
-
-
Method Details
-
getConfig
Description copied from class:DatabindContext
Accessor to currently active configuration (both per-request configs and per-mapper config).- Specified by:
getConfig
in classDatabindContext
-
getActiveView
Description copied from class:DatabindContext
Accessor for locating currently active view, if any; returns null if no view has been set.- Specified by:
getActiveView
in classDatabindContext
-
canOverrideAccessModifiers
public final boolean canOverrideAccessModifiers()Description copied from class:DatabindContext
Convenience method for accessing serialization view in use (if any); equivalent to:getConfig().canOverrideAccessModifiers();
- Specified by:
canOverrideAccessModifiers
in classDatabindContext
-
isEnabled
Description copied from class:DatabindContext
Convenience method for checking whether specified Mapper feature is enabled or not. Shortcut for:getConfig().isEnabled(feature);
- Specified by:
isEnabled
in classDatabindContext
-
isEnabled
Description copied from class:DatabindContext
Method for checking whether specified datatype feature is enabled or not.- Specified by:
isEnabled
in classDatabindContext
-
getDefaultPropertyFormat
- Specified by:
getDefaultPropertyFormat
in classDatabindContext
-
getAnnotationIntrospector
Description copied from class:DatabindContext
Convenience method for accessing serialization view in use (if any); equivalent to:getConfig().getAnnotationIntrospector();
- Specified by:
getAnnotationIntrospector
in classDatabindContext
-
getTypeFactory
- Specified by:
getTypeFactory
in classDatabindContext
-
constructSpecializedType
public JavaType constructSpecializedType(JavaType baseType, Class<?> subclass) throws IllegalArgumentException Description copied from class:DatabindContext
Convenience method for constructing subtypes, retaining generic type parameter (if any).Note: since 2.11 handling has varied a bit across serialization, deserialization.
- Specified by:
constructSpecializedType
in classDatabindContext
- Throws:
IllegalArgumentException
-
getLocale
Method for accessing default Locale to use: convenience method forgetConfig().getLocale();
- Specified by:
getLocale
in classDatabindContext
-
getTimeZone
Method for accessing default TimeZone to use: convenience method forgetConfig().getTimeZone();
- Specified by:
getTimeZone
in classDatabindContext
-
getAttribute
Description copied from class:DatabindContext
Method for accessing attributes available in this context. Per-call attributes have highest precedence; attributes set viaObjectReader
orObjectWriter
have lower precedence.- Specified by:
getAttribute
in classDatabindContext
- Parameters:
key
- Key of the attribute to get- Returns:
- Value of the attribute, if any; null otherwise
-
setAttribute
Description copied from class:DatabindContext
Method for setting per-call value of given attribute. This will override any previously defined value for the attribute within this context.- Specified by:
setAttribute
in classDatabindContext
- Parameters:
key
- Key of the attribute to setvalue
- Value to set attribute to- Returns:
- This context object, to allow chaining
-
getContextualType
Accessor toJavaType
of currently contextualizedContextualDeserializer
, if any. This is sometimes useful for genericJsonDeserializer
s that do not get passed (or do not retain) type information when being constructed: happens for example for deserializers constructed from annotations.- Returns:
- Type of
ContextualDeserializer
being contextualized, if process is on-going; null if not. - Since:
- 2.5
-
getFactory
Method for getting currentDeserializerFactory
. -
isEnabled
Convenience method for checking whether specified on/off feature is enabled -
isEnabled
Accessor for checking whether input format has specified capability or not.- Returns:
- True if input format has specified capability; false if not
- Since:
- 2.12
-
getDeserializationFeatures
public final int getDeserializationFeatures()Bulk access method for getting the bit mask of allDeserializationFeature
s that are enabled.- Since:
- 2.6
-
hasDeserializationFeatures
public final boolean hasDeserializationFeatures(int featureMask) Bulk access method for checking that all features specified by mask are enabled.- Since:
- 2.3
-
hasSomeOfFeatures
public final boolean hasSomeOfFeatures(int featureMask) Bulk access method for checking that at least one of features specified by mask is enabled.- Since:
- 2.6
-
getParser
Method for accessing the currently active parser. May be different from the outermost parser when content is buffered.Use of this method is discouraged: if code has direct access to the active parser, that should be used instead.
-
findInjectableValue
public final Object findInjectableValue(Object valueId, BeanProperty forProperty, Object beanInstance) throws JsonMappingException - Throws:
JsonMappingException
-
getBase64Variant
Convenience method for accessing the default Base64 encoding used for decoding base64 encoded binary content. Same as calling:getConfig().getBase64Variant();
-
getNodeFactory
Convenience method, functionally equivalent to:getConfig().getNodeFactory();
-
findCoercionAction
public CoercionAction findCoercionAction(LogicalType targetType, Class<?> targetClass, CoercionInputShape inputShape) General-purpose accessor for finding what to do when specified coercion from shape that is now always allowed to be coerced from is requested.- Parameters:
targetType
- Logical target type of coerciontargetClass
- Physical target type of coercioninputShape
- Input shape to coerce from- Returns:
- CoercionAction configured for specific coercion
- Since:
- 2.12
-
findCoercionFromBlankString
public CoercionAction findCoercionFromBlankString(LogicalType targetType, Class<?> targetClass, CoercionAction actionIfBlankNotAllowed) More specialized accessor called in case of input being a blank String (one consisting of only white space characters with length of at least one). Will basically first determine if "blank as empty" is allowed: if not, returnsactionIfBlankNotAllowed
, otherwise returns action forCoercionInputShape.EmptyString
.- Parameters:
targetType
- Logical target type of coerciontargetClass
- Physical target type of coercionactionIfBlankNotAllowed
- Return value to use in case "blanks as empty" is not allowed- Returns:
- CoercionAction configured for specified coercion from blank string
- Since:
- 2.12
-
bufferForInputBuffering
Factory method used for creatingTokenBuffer
to temporarily contain copy of content read from specified parser; usually for purpose of reading contents later on (possibly augmeneted with injected additional content)- Since:
- 2.13
-
bufferForInputBuffering
Convenience method that is equivalent to:ctxt.bufferForInputBuffering(ctxt.getParser());
-
bufferAsCopyOfValue
Convenience method, equivalent to:TokenBuffer buffer = ctxt.bufferForInputBuffering(parser); buffer.copyCurrentStructure(parser); return buffer;
NOTE: the whole "current value" that parser points to is read and buffered, including Object and Array values (if parser pointing to start marker).
- Throws:
IOException
- Since:
- 2.9
-
hasValueDeserializerFor
Method for checking whether we could find a deserializer for given type.- Parameters:
type
- Type to checkcause
- (optional) Reference set to root cause if no deserializer could be found due to exception (to find the reason for failure)- Since:
- 2.3
-
findContextualValueDeserializer
public final JsonDeserializer<Object> findContextualValueDeserializer(JavaType type, BeanProperty prop) throws JsonMappingException Method for finding a value deserializer, and creating a contextual version if necessary, for value reached via specified property.- Throws:
JsonMappingException
-
findNonContextualValueDeserializer
public final JsonDeserializer<Object> findNonContextualValueDeserializer(JavaType type) throws JsonMappingException Variant that will try to locate deserializer for current type, but without performing any contextualization (unlikefindContextualValueDeserializer(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanProperty)
) or checking for need to create aTypeDeserializer
(unlikefindRootValueDeserializer(JavaType)
. This method is usually called from withinResolvableDeserializer.resolve(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext)
, and expectation is that caller then calls eitherhandlePrimaryContextualization(JsonDeserializer, BeanProperty, JavaType)
orhandleSecondaryContextualization(JsonDeserializer, BeanProperty, JavaType)
at a later point, as necessary.- Throws:
JsonMappingException
- Since:
- 2.5
-
findRootValueDeserializer
public final JsonDeserializer<Object> findRootValueDeserializer(JavaType type) throws JsonMappingException Method for finding a deserializer for root-level value.- Throws:
JsonMappingException
-
findKeyDeserializer
public final KeyDeserializer findKeyDeserializer(JavaType keyType, BeanProperty prop) throws JsonMappingException Convenience method, functionally same as:getDeserializerProvider().findKeyDeserializer(getConfig(), prop.getType(), prop);
- Throws:
JsonMappingException
-
findObjectId
public abstract ReadableObjectId findObjectId(Object id, ObjectIdGenerator<?> generator, ObjectIdResolver resolver) Method called to find and return entry corresponding to given Object Id: will add an entry if necessary, and never returns null -
checkUnresolvedObjectId
Method called to ensure that every object id encounter during processing are resolved.- Throws:
UnresolvedForwardReference
-
constructType
Convenience method, functionally equivalent to:getConfig().constructType(cls);
-
findClass
Helper method that is to be used when resolving basic class name into Class instance, the reason being that it may be necessary to work around various ClassLoader limitations, as well as to handle primitive type signatures.- Throws:
ClassNotFoundException
- Since:
- 2.6
-
leaseObjectBuffer
Method that can be used to get access to a reusable ObjectBuffer, useful for efficiently constructing Object arrays and Lists. Note that leased buffers should be returned once deserializer is done, to allow for reuse during same round of deserialization. -
returnObjectBuffer
Method to call to return object buffer previously leased withleaseObjectBuffer()
.- Parameters:
buf
- Returned object buffer
-
getArrayBuilders
Method for accessing object useful for building arrays of primitive types (such as int[]). -
deserializerInstance
public abstract JsonDeserializer<Object> deserializerInstance(Annotated annotated, Object deserDef) throws JsonMappingException - Throws:
JsonMappingException
-
keyDeserializerInstance
public abstract KeyDeserializer keyDeserializerInstance(Annotated annotated, Object deserDef) throws JsonMappingException - Throws:
JsonMappingException
-
handlePrimaryContextualization
public JsonDeserializer<?> handlePrimaryContextualization(JsonDeserializer<?> deser, BeanProperty prop, JavaType type) throws JsonMappingException Method called for primary property deserializers (ones directly created to deserialize values of a POJO property), to handle details of resolvingContextualDeserializer
with given property context.- Parameters:
prop
- Property for which the given primary deserializer is used; never null.- Throws:
JsonMappingException
- Since:
- 2.5
-
handleSecondaryContextualization
public JsonDeserializer<?> handleSecondaryContextualization(JsonDeserializer<?> deser, BeanProperty prop, JavaType type) throws JsonMappingException Method called for secondary property deserializers (ones NOT directly created to deal with an annotatable POJO property, but instead created as a component -- such as value deserializers for structured types, or deserializers for root values) to handle details of resolvingContextualDeserializer
with given property context. Given that these deserializers are not directly related to given property (or, in case of root value property, to any property), annotations accessible may or may not be relevant.- Parameters:
prop
- Property for which deserializer is used, if any; null when deserializing root values- Throws:
JsonMappingException
- Since:
- 2.5
-
parseDate
Convenience method for parsing a Date from given String, using currently configured date format (accessed usingMapperConfig.getDateFormat()
).Implementation will handle thread-safety issues related to date formats such that first time this method is called, date format is cloned, and cloned instance will be retained for use during this deserialization round.
- Throws:
IllegalArgumentException
-
constructCalendar
Convenience method for constructing Calendar instance set to specified time, to be modified and used by caller. -
extractScalarFromObject
public String extractScalarFromObject(JsonParser p, JsonDeserializer<?> deser, Class<?> scalarType) throws IOException Method to call in case incoming shape is Object Value (and parser thereby points toJsonToken.START_OBJECT
token), but a Scalar value (potentially coercible from String value) is expected. This would typically be used to deserializer a Number, Boolean value or some other "simple" unstructured value type.- Parameters:
p
- Actual parser to read content fromdeser
- Deserializer that needs extracted String valuescalarType
- Immediate type of scalar to extract; usually type deserializer handles but not always (for example, deserializer forint[]
would pass scalar type ofint
)- Returns:
- String value found; not
null
(exception should be thrown if no suitable value found) - Throws:
IOException
- If there are problems either reading content (underlying parser problem) or finding expected scalar value
-
readValue
Convenience method that may be used by composite or container deserializers, for reading one-off values contained (for sequences, it is more efficient to actually fetch deserializer once for the whole collection).NOTE: when deserializing values of properties contained in composite types, rather use
readPropertyValue(JsonParser, BeanProperty, Class)
; this method does not allow use of contextual annotations.- Throws:
IOException
- Since:
- 2.4
-
readValue
- Throws:
IOException
- Since:
- 2.4
-
readPropertyValue
Convenience method that may be used by composite or container deserializers, for reading one-off values for the composite type, taking into account annotations that the property (passed to this method -- usually property that has custom serializer that called this method) has.- Parameters:
p
- Parser that points to the first token of the value to readprop
- Logical property of a POJO being type- Returns:
- Value of type
type
that was read - Throws:
IOException
- Since:
- 2.4
-
readPropertyValue
Same asreadPropertyValue(JsonParser, BeanProperty, Class)
but with fully resolvedJavaType
as target: needs to be used for generic types, for example.- Throws:
IOException
- Since:
- 2.4
-
readTree
Convenience method for reading the value that passedJsonParser
points to as aJsonNode
.- Parameters:
p
- Parser that points to the first token of the value to read- Returns:
- Value read as
JsonNode
- Throws:
IOException
- Since:
- 2.10
-
readTreeAsValue
Helper method similar toObjectReader.treeToValue(TreeNode, Class)
which will read contents of given tree (JsonNode
) and bind them into specified target type. This is often used in two-phase deserialization in which content is first read as a tree, then manipulated (adding and/or removing properties of Object values, for example), and finally converted into actual target type using default deserialization logic for the type.NOTE: deserializer implementations should be careful not to try to recursively deserialize into target type deserializer has registered itself to handle.
- Parameters:
n
- Tree value to convert, if notnull
: ifnull
, will simply returnnull
targetType
- Type to deserialize contents ofn
into (ifn
notnull
)- Returns:
- Either
null
(ifn
wasnull
or a value of typetype
that was read from non-null
n
argument - Throws:
IOException
- Since:
- 2.13
-
readTreeAsValue
Same asreadTreeAsValue(JsonNode, Class)
but will fully resolvedJavaType
astargetType
NOTE: deserializer implementations should be careful not to try to recursively deserialize into target type deserializer has registered itself to handle.
- Parameters:
n
- Tree value to converttargetType
- Type to deserialize contents ofn
into- Returns:
- Value of type
type
that was read - Throws:
IOException
- Since:
- 2.13
-
handleUnknownProperty
public boolean handleUnknownProperty(JsonParser p, JsonDeserializer<?> deser, Object instanceOrClass, String propName) throws IOException Method that deserializers should call if they encounter an unrecognized property (and once that is not explicitly designed as ignorable), to inform possibly configuredDeserializationProblemHandler
s and let it handle the problem.- Returns:
- True if there was a configured problem handler that was able to handle the problem
- Throws:
IOException
-
handleWeirdKey
public Object handleWeirdKey(Class<?> keyClass, String keyValue, String msg, Object... msgArgs) throws IOException Method that deserializers should call if they encounter a String value that cannot be converted to expected key of aMap
valued property. Default implementation will try to callDeserializationProblemHandler.handleWeirdNumberValue(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, java.lang.Class<?>, java.lang.Number, java.lang.String)
on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throwInvalidFormatException
with given message.- Parameters:
keyClass
- Expected type for keykeyValue
- String value from which to deserialize keymsg
- Error message template caller wants to use if exception is to be thrownmsgArgs
- Optional arguments to use for message, if any- Returns:
- Key value to use
- Throws:
IOException
- To indicate unrecoverable problem, usually based onmsg
- Since:
- 2.8
-
handleWeirdStringValue
public Object handleWeirdStringValue(Class<?> targetClass, String value, String msg, Object... msgArgs) throws IOException Method that deserializers should call if they encounter a String value that cannot be converted to target property type, in cases where some String values could be acceptable (either with different settings, or different value). Default implementation will try to callDeserializationProblemHandler.handleWeirdStringValue(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, java.lang.Class<?>, java.lang.String, java.lang.String)
on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throwInvalidFormatException
with given message.- Parameters:
targetClass
- Type of property into which incoming number should be convertedvalue
- String value from which to deserialize property valuemsg
- Error message template caller wants to use if exception is to be thrownmsgArgs
- Optional arguments to use for message, if any- Returns:
- Property value to use
- Throws:
IOException
- To indicate unrecoverable problem, usually based onmsg
- Since:
- 2.8
-
handleWeirdNumberValue
public Object handleWeirdNumberValue(Class<?> targetClass, Number value, String msg, Object... msgArgs) throws IOException Method that deserializers should call if they encounter a numeric value that cannot be converted to target property type, in cases where some numeric values could be acceptable (either with different settings, or different numeric value). Default implementation will try to callDeserializationProblemHandler.handleWeirdNumberValue(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, java.lang.Class<?>, java.lang.Number, java.lang.String)
on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throwInvalidFormatException
with given message.- Parameters:
targetClass
- Type of property into which incoming number should be convertedvalue
- Number value from which to deserialize property valuemsg
- Error message template caller wants to use if exception is to be thrownmsgArgs
- Optional arguments to use for message, if any- Returns:
- Property value to use
- Throws:
IOException
- To indicate unrecoverable problem, usually based onmsg
- Since:
- 2.8
-
handleWeirdNativeValue
public Object handleWeirdNativeValue(JavaType targetType, Object badValue, JsonParser p) throws IOException - Throws:
IOException
-
handleMissingInstantiator
public Object handleMissingInstantiator(Class<?> instClass, ValueInstantiator valueInst, JsonParser p, String msg, Object... msgArgs) throws IOException Method that deserializers should call if they fail to instantiate value due to lack of viable instantiator (usually creator, that is, constructor or static factory method). Method should be called at point where value has not been decoded, so that handler has a chance to handle decoding using alternate mechanism, and handle underlying content (possibly by just skipping it) to keep input state valid- Parameters:
instClass
- Type that was to be instantiatedvalueInst
- (optional) Value instantiator to be used, if any; null if type does not use one for instantiation (custom deserialiers don't; standard POJO deserializer does)p
- Parser that points to the JSON value to decode- Returns:
- Object that should be constructed, if any; has to be of type
instClass
- Throws:
IOException
- Since:
- 2.9 (2.8 had alternate that did not take
ValueInstantiator
)
-
handleInstantiationProblem
public Object handleInstantiationProblem(Class<?> instClass, Object argument, Throwable t) throws IOException Method that deserializers should call if they fail to instantiate value due to an exception that was thrown by constructor (or other mechanism used to create instances). Default implementation will try to callDeserializationProblemHandler.handleInstantiationProblem(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, java.lang.Class<?>, java.lang.Object, java.lang.Throwable)
on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throw exception constructed withinstantiationException(java.lang.Class<?>, java.lang.Throwable)
.- Parameters:
instClass
- Type that was to be instantiatedargument
- (optional) Argument that was passed to constructor or equivalent instantiator; often aString
.t
- Exception that caused failure- Returns:
- Object that should be constructed, if any; has to be of type
instClass
- Throws:
IOException
- Since:
- 2.8
-
handleUnexpectedToken
Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle). This could occur, for example, if a Number deserializer encounterJsonToken.START_ARRAY
instead ofJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
.- Parameters:
instClass
- Type that was to be instantiatedp
- Parser that points to the JSON value to decode- Returns:
- Object that should be constructed, if any; has to be of type
instClass
- Throws:
IOException
- Since:
- 2.8
-
handleUnexpectedToken
public Object handleUnexpectedToken(Class<?> instClass, JsonToken t, JsonParser p, String msg, Object... msgArgs) throws IOException Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle). This could occur, for example, if a Number deserializer encounterJsonToken.START_ARRAY
instead ofJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
.- Parameters:
instClass
- Type that was to be instantiatedt
- Token encountered that does match expectedp
- Parser that points to the JSON value to decode- Returns:
- Object that should be constructed, if any; has to be of type
instClass
- Throws:
IOException
- Since:
- 2.8
-
handleUnexpectedToken
Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle). This could occur, for example, if a Number deserializer encounterJsonToken.START_ARRAY
instead ofJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
.- Parameters:
targetType
- Type that was to be instantiatedp
- Parser that points to the JSON value to decode- Returns:
- Object that should be constructed, if any; has to be of type
instClass
- Throws:
IOException
- Since:
- 2.10
-
handleUnexpectedToken
public Object handleUnexpectedToken(JavaType targetType, JsonToken t, JsonParser p, String msg, Object... msgArgs) throws IOException Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle). This could occur, for example, if a Number deserializer encounterJsonToken.START_ARRAY
instead ofJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
.- Parameters:
targetType
- Type that was to be instantiatedt
- Token encountered that does not match expectedp
- Parser that points to the JSON value to decode- Returns:
- Object that should be constructed, if any; has to be of type
instClass
- Throws:
IOException
- Since:
- 2.10
-
handleUnknownTypeId
public JavaType handleUnknownTypeId(JavaType baseType, String id, TypeIdResolver idResolver, String extraDesc) throws IOException Method that deserializers should call if they encounter a type id (for polymorphic deserialization) that cannot be resolved to an actual type; usually since there is no mapping defined. Default implementation will try to callDeserializationProblemHandler.handleUnknownTypeId(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, java.lang.String, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.jsontype.TypeIdResolver, java.lang.String)
on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throw exception constructed withinvalidTypeIdException(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, java.lang.String, java.lang.String)
.- Parameters:
baseType
- Base type from which resolution startsid
- Type id that could not be convertedextraDesc
- Additional problem description to add to default exception message, if resolution fails.- Returns:
JavaType
that id resolves to- Throws:
IOException
- To indicate unrecoverable problem, if resolution cannot be made to work- Since:
- 2.8
-
handleMissingTypeId
public JavaType handleMissingTypeId(JavaType baseType, TypeIdResolver idResolver, String extraDesc) throws IOException - Throws:
IOException
- Since:
- 2.9
-
handleBadMerge
Method that deserializer may call if it is called to do an update ("merge") but deserializer operates on a non-mergeable type. Although this should usually be caught earlier, sometimes it may only be caught during operation and if so this is the method to call. Note that ifMapperFeature.IGNORE_MERGE_FOR_UNMERGEABLE
is enabled, this method will simply return null; otherwiseInvalidDefinitionException
will be thrown.- Throws:
JsonMappingException
- Since:
- 2.10
-
_isCompatible
- Since:
- 2.9.2
-
reportWrongTokenException
public void reportWrongTokenException(JsonDeserializer<?> deser, JsonToken expToken, String msg, Object... msgArgs) throws JsonMappingException Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens. Note that this method will throw aJsonMappingException
and no recovery is attempted (viaDeserializationProblemHandler
, as problem is considered to be difficult to recover from, in general.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportWrongTokenException
public void reportWrongTokenException(JavaType targetType, JsonToken expToken, String msg, Object... msgArgs) throws JsonMappingException Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens. Note that this method will throw aJsonMappingException
and no recovery is attempted (viaDeserializationProblemHandler
, as problem is considered to be difficult to recover from, in general.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportWrongTokenException
public void reportWrongTokenException(Class<?> targetType, JsonToken expToken, String msg, Object... msgArgs) throws JsonMappingException Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens. Note that this method will throw aJsonMappingException
and no recovery is attempted (viaDeserializationProblemHandler
, as problem is considered to be difficult to recover from, in general.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportUnresolvedObjectId
public <T> T reportUnresolvedObjectId(ObjectIdReader oidReader, Object bean) throws JsonMappingException - Throws:
JsonMappingException
- Since:
- 2.8
-
reportInputMismatch
public <T> T reportInputMismatch(JsonDeserializer<?> src, String msg, Object... msgArgs) throws JsonMappingException Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportInputMismatch
public <T> T reportInputMismatch(Class<?> targetType, String msg, Object... msgArgs) throws JsonMappingException Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportInputMismatch
public <T> T reportInputMismatch(JavaType targetType, String msg, Object... msgArgs) throws JsonMappingException Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportInputMismatch
public <T> T reportInputMismatch(BeanProperty prop, String msg, Object... msgArgs) throws JsonMappingException Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportPropertyInputMismatch
public <T> T reportPropertyInputMismatch(Class<?> targetType, String propertyName, String msg, Object... msgArgs) throws JsonMappingException Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.- Throws:
JsonMappingException
- Since:
- 2.10
-
reportPropertyInputMismatch
public <T> T reportPropertyInputMismatch(JavaType targetType, String propertyName, String msg, Object... msgArgs) throws JsonMappingException Helper method used to indicate a problem with input in cases where more specificreportXxx()
method was not available.- Throws:
JsonMappingException
- Since:
- 2.10
-
reportBadCoercion
public <T> T reportBadCoercion(JsonDeserializer<?> src, Class<?> targetType, Object inputValue, String msg, Object... msgArgs) throws JsonMappingException Helper method used to indicate a problem with input in cases where specific input coercion was not allowed.- Throws:
JsonMappingException
- Since:
- 2.12
-
reportTrailingTokens
public <T> T reportTrailingTokens(Class<?> targetType, JsonParser p, JsonToken trailingToken) throws JsonMappingException - Throws:
JsonMappingException
-
reportWrongTokenException
@Deprecated public void reportWrongTokenException(JsonParser p, JsonToken expToken, String msg, Object... msgArgs) throws JsonMappingException Deprecated.- Throws:
JsonMappingException
-
reportUnknownProperty
@Deprecated public void reportUnknownProperty(Object instanceOrClass, String fieldName, JsonDeserializer<?> deser) throws JsonMappingException Deprecated.Helper method for reporting a problem with unhandled unknown property.- Parameters:
instanceOrClass
- Either value being populated (if one has been instantiated), or Class that indicates type that would be (or have been) instantiateddeser
- Deserializer that had the problem, if called by deserializer (or on behalf of one)- Throws:
JsonMappingException
-
reportMissingContent
@Deprecated public void reportMissingContent(String msg, Object... msgArgs) throws JsonMappingException Deprecated.Since 2.9: not clear this ever occurs- Throws:
JsonMappingException
- Since:
- 2.8
-
reportBadTypeDefinition
public <T> T reportBadTypeDefinition(BeanDescription bean, String msg, Object... msgArgs) throws JsonMappingException Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific Java type, unrelated to actual JSON content to map. Default behavior is to construct and throw aJsonMappingException
.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportBadPropertyDefinition
public <T> T reportBadPropertyDefinition(BeanDescription bean, BeanPropertyDefinition prop, String msg, Object... msgArgs) throws JsonMappingException Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific property (of a type), unrelated to actual JSON content to map. Default behavior is to construct and throw aJsonMappingException
.- Throws:
JsonMappingException
- Since:
- 2.9
-
reportBadDefinition
Description copied from class:DatabindContext
Helper method called to indicate a generic problem that stems from type definition(s), not input data, or input/output state; typically this means throwing aInvalidDefinitionException
.- Specified by:
reportBadDefinition
in classDatabindContext
- Throws:
JsonMappingException
-
reportBadMerge
Deprecated.- Throws:
JsonMappingException
-
wrongTokenException
public JsonMappingException wrongTokenException(JsonParser p, JavaType targetType, JsonToken expToken, String extra) Helper method for constructingJsonMappingException
to indicate that the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens. Note that most of the time this method should NOT be directly called; instead,reportWrongTokenException(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer<?>, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonToken, java.lang.String, java.lang.Object...)
should be called and will call this method as necessary.- Since:
- 2.9
-
wrongTokenException
public JsonMappingException wrongTokenException(JsonParser p, Class<?> targetType, JsonToken expToken, String extra) -
wrongTokenException
@Deprecated public JsonMappingException wrongTokenException(JsonParser p, JsonToken expToken, String msg) Deprecated. -
weirdKeyException
Helper method for constructing exception to indicate that given JSON Object field name was not in format to be able to deserialize specified key type. Note that most of the time this method should NOT be called; instead,handleWeirdKey(java.lang.Class<?>, java.lang.String, java.lang.String, java.lang.Object...)
should be called which will call this method if necessary. -
weirdStringException
Helper method for constructing exception to indicate that input JSON String was not suitable for deserializing into given target type. Note that most of the time this method should NOT be called; instead,handleWeirdStringValue(java.lang.Class<?>, java.lang.String, java.lang.String, java.lang.Object...)
should be called which will call this method if necessary.- Parameters:
value
- String value from input being deserializedinstClass
- Type that String should be deserialized intomsgBase
- Message that describes specific problem- Since:
- 2.1
-
weirdNumberException
Helper method for constructing exception to indicate that input JSON Number was not suitable for deserializing into given target type. Note that most of the time this method should NOT be called; instead,handleWeirdNumberValue(java.lang.Class<?>, java.lang.Number, java.lang.String, java.lang.Object...)
should be called which will call this method if necessary. -
weirdNativeValueException
Helper method for constructing exception to indicate that input JSON token of type "native value" (seeJsonToken.VALUE_EMBEDDED_OBJECT
) is of incompatible type (and there is no delegating creator or such to use) and can not be used to construct value of specified type (usually POJO). Note that most of the time this method should NOT be called; instead,handleWeirdNativeValue(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, java.lang.Object, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser)
should be called which will call this method- Since:
- 2.9
-
instantiationException
Helper method for constructing instantiation exception for specified type, to indicate problem with physically constructing instance of specified class (missing constructor, exception from constructor)Note that most of the time this method should NOT be called directly; instead,
handleInstantiationProblem(java.lang.Class<?>, java.lang.Object, java.lang.Throwable)
should be called which will call this method if necessary. -
instantiationException
Helper method for constructing instantiation exception for specified type, to indicate that instantiation failed due to missing instantiator (creator; constructor or factory method).Note that most of the time this method should NOT be called; instead,
handleMissingInstantiator(java.lang.Class<?>, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.ValueInstantiator, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser, java.lang.String, java.lang.Object...)
should be called which will call this method if necessary. -
invalidTypeIdException
public JsonMappingException invalidTypeIdException(JavaType baseType, String typeId, String extraDesc) Description copied from class:DatabindContext
Helper method for constructing exception to indicate that given type id could not be resolved to a valid subtype of specified base type. Most commonly called during polymorphic deserialization.Note that most of the time this method should NOT be called directly: instead, method
handleUnknownTypeId()
should be called which will call this method if necessary.- Specified by:
invalidTypeIdException
in classDatabindContext
-
missingTypeIdException
- Since:
- 2.9
-
unknownTypeException
@Deprecated public JsonMappingException unknownTypeException(JavaType type, String id, String extraDesc) Deprecated.- Since:
- 2.5
-
endOfInputException
Deprecated.Since 2.8; currently no way to catch EOF at databind levelHelper method for constructing exception to indicate that end-of-input was reached while still expecting more tokens to deserialize value of specified type. -
reportMappingException
@Deprecated public void reportMappingException(String msg, Object... msgArgs) throws JsonMappingException Deprecated.Since 2.9: use a more specific method, orreportBadDefinition(JavaType, String)
, orreportInputMismatch(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer<?>, java.lang.String, java.lang.Object...)
insteadFallback method that may be called if no otherreportXxx
is applicable -- but only in that case.- Throws:
JsonMappingException
- Since:
- 2.8
-
mappingException
Deprecated.Since 2.9 use more specific error reporting methods insteadHelper method for constructing generic mapping exception with specified message and current location information. Note that application code should almost always call one ofhandleXxx
methods, orreportMappingException(String, Object...)
instead.- Since:
- 2.6
-
mappingException
Deprecated.Since 2.9 use more specific error reporting methods insteadHelper method for constructing generic mapping exception with specified message and current location information Note that application code should almost always call one ofhandleXxx
methods, orreportMappingException(String, Object...)
instead.- Since:
- 2.6
-
mappingException
Deprecated.Since 2.8 usehandleUnexpectedToken(Class, JsonParser)
insteadHelper method for constructing generic mapping exception for specified type -
mappingException
Deprecated.Since 2.8 usehandleUnexpectedToken(Class, JsonParser)
instead -
getDateFormat
Deprecated. -
_getDateFormat
-
_shapeForToken
Helper method for constructing description like "Object value" givenJsonToken
encountered.
-