|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.map.MapperConfig<DeserializationConfig>
org.codehaus.jackson.map.DeserializationConfig
public class DeserializationConfig
Object that contains baseline configuration for deserialization
process. An instance is owned by ObjectMapper
, which makes
a copy that is passed during serialization process to
DeserializerProvider
and DeserializerFactory
.
Note: although configuration settings can be changed at any time (for factories and instances), they are not guaranteed to have effect if called after constructing relevant mapper or deserializer instance. This because some objects may be configured, constructed and cached first time they are needed.
Nested Class Summary | |
---|---|
static class |
DeserializationConfig.Feature
Enumeration that defines togglable features that guide the serialization feature. |
Nested classes/interfaces inherited from class org.codehaus.jackson.map.MapperConfig |
---|
MapperConfig.Base |
Field Summary | |
---|---|
protected AbstractTypeResolver |
_abstractTypeResolver
To support on-the-fly class generation for interface and abstract classes it is possible to register "abstract type resolver". |
protected int |
_featureFlags
Bit set that contains all enabled features |
protected JsonNodeFactory |
_nodeFactory
Factory used for constructing JsonNode instances. |
protected LinkedNode<DeserializationProblemHandler> |
_problemHandlers
Linked list that contains all registered problem handlers. |
protected static int |
DEFAULT_FEATURE_FLAGS
Bitfield (set of flags) of all Features that are enabled by default. |
Fields inherited from class org.codehaus.jackson.map.MapperConfig |
---|
_base, _mixInAnnotations, _mixInAnnotationsShared, _subtypeResolver, DEFAULT_DATE_FORMAT |
Constructor Summary | |
---|---|
|
DeserializationConfig(ClassIntrospector<? extends BeanDescription> intr,
AnnotationIntrospector annIntr,
VisibilityChecker<?> vc,
SubtypeResolver subtypeResolver,
PropertyNamingStrategy propertyNamingStrategy,
TypeFactory typeFactory,
HandlerInstantiator handlerInstantiator)
Constructor used by ObjectMapper to create default configuration object instance. |
protected |
DeserializationConfig(DeserializationConfig src)
|
protected |
DeserializationConfig(DeserializationConfig src,
JsonNodeFactory f)
|
protected |
DeserializationConfig(DeserializationConfig src,
MapperConfig.Base base)
|
Method Summary | ||
---|---|---|
void |
addHandler(DeserializationProblemHandler h)
Method that can be used to add a handler that can (try to) resolve non-fatal deserialization problems. |
|
boolean |
canOverrideAccessModifiers()
Accessor for determining whether it is ok to try to force override of access modifiers to be able to get or set values of non-public Methods, Fields; to invoke non-public Constructors, Methods; or to instantiate non-public Classes. |
|
void |
clearHandlers()
Method for removing all configuring problem handlers; usually done to replace existing handler(s) with different one(s) |
|
DeserializationConfig |
createUnshared(SubtypeResolver subtypeResolver)
Method that is called to create a non-shared copy of the configuration to be used for a deserialization operation. |
|
DeserializationConfig |
createUnshared(TypeResolverBuilder<?> typer,
VisibilityChecker<?> vc,
SubtypeResolver str)
Deprecated. Since 1.8 should use variant without arguments |
|
JsonDeserializer<Object> |
deserializerInstance(Annotated annotated,
Class<? extends JsonDeserializer<?>> deserClass)
|
|
void |
disable(DeserializationConfig.Feature f)
Method for disabling specified feature. |
|
void |
enable(DeserializationConfig.Feature f)
Method for enabling specified feature. |
|
void |
fromAnnotations(Class<?> cls)
Method that checks class annotations that the argument Object has, and modifies settings of this configuration object accordingly, similar to how those annotations would affect actual value classes annotated with them, but with global scope. |
|
AbstractTypeResolver |
getAbstractTypeResolver()
Deprecated. Since 1.8 resolvers should be registered using Module interface Will be removed from Jackson 2.0 |
|
AnnotationIntrospector |
getAnnotationIntrospector()
Method for getting AnnotationIntrospector configured
to introspect annotation values used for configuration. |
|
Base64Variant |
getBase64Variant()
Method called during deserialization if Base64 encoded content needs to be decoded. |
|
JsonNodeFactory |
getNodeFactory()
|
|
LinkedNode<DeserializationProblemHandler> |
getProblemHandlers()
Method for getting head of the problem handler chain. |
|
|
introspect(JavaType type)
Method that will introspect full bean properties for the purpose of building a bean deserializer |
|
|
introspectClassAnnotations(Class<?> cls)
Accessor for getting bean description that only contains class annotations: useful if no getter/setter/creator information is needed. |
|
|
introspectDirectClassAnnotations(Class<?> cls)
Accessor for getting bean description that only contains immediate class annotations: ones from the class, and its direct mix-in, if any, but not from super types. |
|
|
introspectForCreation(JavaType type)
Method that will introspect subset of bean properties needed to construct bean instance. |
|
boolean |
isAnnotationProcessingEnabled()
Method for determining whether annotation processing is enabled or not (default settings are typically that it is enabled; must explicitly disable). |
|
boolean |
isEnabled(DeserializationConfig.Feature f)
Method for checking whether given feature is enabled or not |
|
KeyDeserializer |
keyDeserializerInstance(Annotated annotated,
Class<? extends KeyDeserializer> keyDeserClass)
|
|
void |
set(DeserializationConfig.Feature f,
boolean state)
Method for enabling or disabling specified feature. |
|
void |
setAbstractTypeResolver(AbstractTypeResolver atr)
Deprecated. Since 1.8 resolvers should be registered using Module interface. Will be removed from Jackson 2.0 |
|
void |
setNodeFactory(JsonNodeFactory nf)
Deprecated. Since 1.8 should use withNodeFactory(org.codehaus.jackson.node.JsonNodeFactory) instead |
|
DeserializationConfig |
withAnnotationIntrospector(AnnotationIntrospector ai)
Method for constructing and returning a new instance with different AnnotationIntrospector
to use (replacing old one). |
|
DeserializationConfig |
withClassIntrospector(ClassIntrospector<? extends BeanDescription> ci)
Method for constructing and returning a new instance with different ClassIntrospector
to use. |
|
DeserializationConfig |
withDateFormat(DateFormat df)
Method for constructing and returning a new instance with different DateFormat
to use. |
|
DeserializationConfig |
withHandlerInstantiator(HandlerInstantiator hi)
Method for constructing and returning a new instance with different HandlerInstantiator
to use. |
|
DeserializationConfig |
withNodeFactory(JsonNodeFactory f)
|
|
DeserializationConfig |
withPropertyNamingStrategy(PropertyNamingStrategy pns)
Method for constructing and returning a new instance with different PropertyNamingStrategy
to use. |
|
DeserializationConfig |
withSubtypeResolver(SubtypeResolver str)
Method for constructing and returning a new instance with different SubtypeResolver
to use. |
|
DeserializationConfig |
withTypeFactory(TypeFactory tf)
Method for constructing and returning a new instance with different TypeFactory
to use. |
|
DeserializationConfig |
withTypeResolverBuilder(TypeResolverBuilder<?> trb)
Method for constructing and returning a new instance with different TypeResolverBuilder
to use. |
|
DeserializationConfig |
withVisibilityChecker(VisibilityChecker<?> vc)
Method for constructing and returning a new instance with different VisibilityChecker
to use. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final int DEFAULT_FEATURE_FLAGS
protected int _featureFlags
protected LinkedNode<DeserializationProblemHandler> _problemHandlers
protected AbstractTypeResolver _abstractTypeResolver
Non-final to support deprecated legacy methods; should be made final for 2.0
protected JsonNodeFactory _nodeFactory
JsonNode
instances.
Non-final to support deprecated legacy methods; should be made final for 2.0
Constructor Detail |
---|
public DeserializationConfig(ClassIntrospector<? extends BeanDescription> intr, AnnotationIntrospector annIntr, VisibilityChecker<?> vc, SubtypeResolver subtypeResolver, PropertyNamingStrategy propertyNamingStrategy, TypeFactory typeFactory, HandlerInstantiator handlerInstantiator)
protected DeserializationConfig(DeserializationConfig src)
protected DeserializationConfig(DeserializationConfig src, MapperConfig.Base base)
protected DeserializationConfig(DeserializationConfig src, JsonNodeFactory f)
Method Detail |
---|
public DeserializationConfig withClassIntrospector(ClassIntrospector<? extends BeanDescription> ci)
MapperConfig
ClassIntrospector
to use.
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withClassIntrospector
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withAnnotationIntrospector(AnnotationIntrospector ai)
MapperConfig
AnnotationIntrospector
to use (replacing old one).
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withAnnotationIntrospector
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withVisibilityChecker(VisibilityChecker<?> vc)
MapperConfig
VisibilityChecker
to use.
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withVisibilityChecker
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withTypeResolverBuilder(TypeResolverBuilder<?> trb)
MapperConfig
TypeResolverBuilder
to use.
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withTypeResolverBuilder
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withSubtypeResolver(SubtypeResolver str)
MapperConfig
SubtypeResolver
to use.
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withSubtypeResolver
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withPropertyNamingStrategy(PropertyNamingStrategy pns)
MapperConfig
PropertyNamingStrategy
to use.
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withPropertyNamingStrategy
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withTypeFactory(TypeFactory tf)
MapperConfig
TypeFactory
to use.
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withTypeFactory
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withDateFormat(DateFormat df)
MapperConfig
DateFormat
to use.
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withDateFormat
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withHandlerInstantiator(HandlerInstantiator hi)
MapperConfig
HandlerInstantiator
to use.
NOTE: make sure to register new instance with ObjectMapper
if directly calling this method.
withHandlerInstantiator
in class MapperConfig<DeserializationConfig>
public DeserializationConfig withNodeFactory(JsonNodeFactory f)
public void enable(DeserializationConfig.Feature f)
public void disable(DeserializationConfig.Feature f)
public void set(DeserializationConfig.Feature f, boolean state)
public final boolean isEnabled(DeserializationConfig.Feature f)
public void fromAnnotations(Class<?> cls)
Ones that are known to have effect are:
fromAnnotations
in class MapperConfig<DeserializationConfig>
cls
- Class of which class annotations to use
for changing configuration settingspublic DeserializationConfig createUnshared(SubtypeResolver subtypeResolver)
createUnshared
in class MapperConfig<DeserializationConfig>
public AnnotationIntrospector getAnnotationIntrospector()
AnnotationIntrospector
configured
to introspect annotation values used for configuration.
getAnnotationIntrospector
in class MapperConfig<DeserializationConfig>
public <T extends BeanDescription> T introspectClassAnnotations(Class<?> cls)
Note: part of MapperConfig
since 1.7
introspectClassAnnotations
in class MapperConfig<DeserializationConfig>
public <T extends BeanDescription> T introspectDirectClassAnnotations(Class<?> cls)
Note: part of MapperConfig
since 1.7
introspectDirectClassAnnotations
in class MapperConfig<DeserializationConfig>
public boolean isAnnotationProcessingEnabled()
MapperConfig
isAnnotationProcessingEnabled
in class MapperConfig<DeserializationConfig>
public boolean canOverrideAccessModifiers()
MapperConfig
canOverrideAccessModifiers
in class MapperConfig<DeserializationConfig>
public LinkedNode<DeserializationProblemHandler> getProblemHandlers()
public void addHandler(DeserializationProblemHandler h)
public void clearHandlers()
public Base64Variant getBase64Variant()
public final JsonNodeFactory getNodeFactory()
public <T extends BeanDescription> T introspect(JavaType type)
type
- Type of class to be introspectedpublic <T extends BeanDescription> T introspectForCreation(JavaType type)
public JsonDeserializer<Object> deserializerInstance(Annotated annotated, Class<? extends JsonDeserializer<?>> deserClass)
public KeyDeserializer keyDeserializerInstance(Annotated annotated, Class<? extends KeyDeserializer> keyDeserClass)
@Deprecated public DeserializationConfig createUnshared(TypeResolverBuilder<?> typer, VisibilityChecker<?> vc, SubtypeResolver str)
createUnshared
in class MapperConfig<DeserializationConfig>
@Deprecated public void setNodeFactory(JsonNodeFactory nf)
withNodeFactory(org.codehaus.jackson.node.JsonNodeFactory)
instead
@Deprecated public AbstractTypeResolver getAbstractTypeResolver()
AbstractTypeResolver
configured, if any
(no default) used for resolving abstract types into concrete
types (either by mapping or materializing new classes).
@Deprecated public void setAbstractTypeResolver(AbstractTypeResolver atr)
AbstractTypeResolver
to use for resolving
references to abstract types into concrete types (if possible).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |