public abstract class SerializerProvider extends DatabindContext
ObjectMapper
and
JsonSerializer
s to obtain serializers capable of serializing
instances of specific types; as well as the default implementation
of the functionality.
Provider handles caching aspects of serializer handling; all construction
details are delegated to SerializerFactory
instance.
Object life-cycle is such that an initial instance ("blueprint") is created
and referenced by ObjectMapper
and ObjectWriter
intances;
but for actual usage, a configured instance is created by using
a create method in sub-class
DefaultSerializerProvider
.
Only this instance can be used for actual serialization calls; blueprint
object is only to be used for creating instances.
Modifier and Type | Field and Description |
---|---|
static JsonSerializer<java.lang.Object> |
DEFAULT_NULL_KEY_SERIALIZER |
Constructor and Description |
---|
SerializerProvider()
Constructor for creating master (or "blue-print") provider object,
which is only used as the template for constructing per-binding
instances.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canOverrideAccessModifiers()
Convenience method for accessing serialization view in use (if any); equivalent to:
|
void |
defaultSerializeDateKey(java.util.Date date,
JsonGenerator gen)
Method that will handle serialization of Dates used as
Map keys,
based on SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS
value (and if using textual representation, configured date format) |
void |
defaultSerializeDateKey(long timestamp,
JsonGenerator gen)
Method that will handle serialization of Dates used as
Map keys,
based on SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS
value (and if using textual representation, configured date format) |
void |
defaultSerializeDateValue(java.util.Date date,
JsonGenerator gen)
Method that will handle serialization of Date(-like) values, using
SerializationConfig settings to determine expected serialization
behavior. |
void |
defaultSerializeDateValue(long timestamp,
JsonGenerator gen)
Method that will handle serialization of Date(-like) values, using
SerializationConfig settings to determine expected serialization
behavior. |
void |
defaultSerializeField(java.lang.String fieldName,
java.lang.Object value,
JsonGenerator gen)
Convenience method that will serialize given field with specified
value.
|
void |
defaultSerializeNull(JsonGenerator gen) |
void |
defaultSerializeValue(java.lang.Object value,
JsonGenerator gen)
Convenience method that will serialize given value (which can be
null) using standard serializer locating functionality.
|
JsonSerializer<java.lang.Object> |
findKeySerializer(java.lang.Class<?> rawKeyType,
BeanProperty property) |
JsonSerializer<java.lang.Object> |
findKeySerializer(JavaType keyType,
BeanProperty property)
Method called to get the serializer to use for serializing
non-null Map keys.
|
JsonSerializer<java.lang.Object> |
findNullKeySerializer(JavaType serializationType,
BeanProperty property)
Method called to find a serializer to use for null values for given
declared type.
|
JsonSerializer<java.lang.Object> |
findNullValueSerializer(BeanProperty property)
Method called to get the serializer to use for serializing null
values for specified property.
|
abstract WritableObjectId |
findObjectId(java.lang.Object forPojo,
ObjectIdGenerator<?> generatorType)
Method called to find the Object Id for given POJO, if one
has been generated.
|
JsonSerializer<java.lang.Object> |
findPrimaryPropertySerializer(java.lang.Class<?> valueType,
BeanProperty property) |
JsonSerializer<java.lang.Object> |
findPrimaryPropertySerializer(JavaType valueType,
BeanProperty property)
Similar to
findValueSerializer(JavaType, BeanProperty) , but used
when finding "primary" property value serializer (one directly handling
value of the property). |
JsonSerializer<java.lang.Object> |
findTypedValueSerializer(java.lang.Class<?> valueType,
boolean cache,
BeanProperty property)
Method called to locate regular serializer, matching type serializer,
and if both found, wrap them in a serializer that calls both in correct
sequence.
|
JsonSerializer<java.lang.Object> |
findTypedValueSerializer(JavaType valueType,
boolean cache,
BeanProperty property)
Method called to locate regular serializer, matching type serializer,
and if both found, wrap them in a serializer that calls both in correct
sequence.
|
TypeSerializer |
findTypeSerializer(JavaType javaType)
Method called to get the
TypeSerializer to use for including Type Id necessary
for serializing for the given Java class. |
JsonSerializer<java.lang.Object> |
findValueSerializer(java.lang.Class<?> valueType)
Method variant used when we do NOT want contextualization to happen; it will need
to be handled at a later point, but caller wants to be able to do that
as needed; sometimes to avoid infinite loops
|
JsonSerializer<java.lang.Object> |
findValueSerializer(java.lang.Class<?> valueType,
BeanProperty property)
Method called to get hold of a serializer for a value of given type;
or if no such serializer can be found, a default handler (which
may do a best-effort generic serialization or just simply
throw an exception when invoked).
|
JsonSerializer<java.lang.Object> |
findValueSerializer(JavaType valueType)
Method variant used when we do NOT want contextualization to happen; it will need
to be handled at a later point, but caller wants to be able to do that
as needed; sometimes to avoid infinite loops
|
JsonSerializer<java.lang.Object> |
findValueSerializer(JavaType valueType,
BeanProperty property)
Similar to
findValueSerializer(Class,BeanProperty) , but takes
full generics-aware type instead of raw class. |
java.lang.Class<?> |
getActiveView()
Accessor for locating currently active view, if any;
returns null if no view has been set.
|
AnnotationIntrospector |
getAnnotationIntrospector()
Convenience method for accessing serialization view in use (if any); equivalent to:
|
java.lang.Object |
getAttribute(java.lang.Object key)
Method for accessing attributes available in this context.
|
SerializationConfig |
getConfig()
Method for accessing configuration for the serialization processing.
|
JsonSerializer<java.lang.Object> |
getDefaultNullKeySerializer() |
JsonSerializer<java.lang.Object> |
getDefaultNullValueSerializer() |
JsonFormat.Value |
getDefaultPropertyFormat(java.lang.Class<?> baseType) |
JsonInclude.Value |
getDefaultPropertyInclusion(java.lang.Class<?> baseType) |
FilterProvider |
getFilterProvider()
Convenience method for accessing provider to find serialization filters used,
equivalent to calling:
|
JsonGenerator |
getGenerator()
NOTE: current implementation simply returns `null` as generator is not yet
assigned to this provider.
|
java.util.Locale |
getLocale()
Method for accessing default Locale to use: convenience method for
|
java.lang.Class<?> |
getSerializationView()
Deprecated.
Since 2.2, use
getActiveView() instead. |
java.util.TimeZone |
getTimeZone()
Method for accessing default TimeZone to use: convenience method for
|
TypeFactory |
getTypeFactory() |
JsonSerializer<java.lang.Object> |
getUnknownTypeSerializer(java.lang.Class<?> unknownType)
Method called to get the serializer to use if provider
cannot determine an actual type-specific serializer
to use; typically when none of
SerializerFactory
instances are able to construct a serializer. |
JsonSerializer<?> |
handlePrimaryContextualization(JsonSerializer<?> ser,
BeanProperty property)
Method called for primary property serializers (ones
directly created to serialize values of a POJO property),
to handle details of resolving
ContextualSerializer with given property context. |
JsonSerializer<?> |
handleSecondaryContextualization(JsonSerializer<?> ser,
BeanProperty property)
Method called for secondary property serializers (ones
NOT directly created to serialize values of a POJO property
but instead created as a dependant serializer -- such as value serializers
for structured types, or serializers for root values)
to handle details of resolving
ContextualDeserializer with given property context. |
boolean |
hasSerializationFeatures(int featureMask)
"Bulk" access method for checking that all features specified by
mask are enabled.
|
abstract java.lang.Object |
includeFilterInstance(BeanPropertyDefinition forProperty,
java.lang.Class<?> filterClass)
Method that can be called to construct and configure
JsonInclude
filter instance,
given a Class to instantiate (with default constructor, by default). |
abstract boolean |
includeFilterSuppressNulls(java.lang.Object filter)
Follow-up method that may be called after calling
includeFilterInstance(com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition, java.lang.Class<?>) ,
to check handling of `null` values by the filter. |
JsonMappingException |
invalidTypeIdException(JavaType baseType,
java.lang.String typeId,
java.lang.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.
|
boolean |
isEnabled(MapperFeature feature)
Convenience method for checking whether specified serialization
feature is enabled or not.
|
boolean |
isEnabled(SerializationFeature feature)
Convenience method for checking whether specified serialization
feature is enabled or not.
|
boolean |
isUnknownTypeSerializer(JsonSerializer<?> ser)
Helper method called to see if given serializer is considered to be
something returned by
getUnknownTypeSerializer(java.lang.Class<?>) , that is, something
for which no regular serializer was found or constructed. |
JsonMappingException |
mappingException(java.lang.String message,
java.lang.Object... msgArgs)
Deprecated.
Since 2.9
|
<T> T |
reportBadDefinition(java.lang.Class<?> raw,
java.lang.String msg,
java.lang.Throwable cause) |
<T> T |
reportBadDefinition(JavaType type,
java.lang.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 a
InvalidDefinitionException . |
<T> T |
reportBadDefinition(JavaType type,
java.lang.String msg,
java.lang.Throwable cause) |
<T> T |
reportBadPropertyDefinition(BeanDescription bean,
BeanPropertyDefinition prop,
java.lang.String message,
java.lang.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,
java.lang.String msg,
java.lang.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.
|
void |
reportMappingProblem(java.lang.String message,
java.lang.Object... args)
Helper method called to indicate problem; default behavior is to construct and
throw a
JsonMappingException , but in future may collect more than one
and only throw after certain number, or at the end of serialization. |
void |
reportMappingProblem(java.lang.Throwable t,
java.lang.String message,
java.lang.Object... msgArgs)
Helper method called to indicate problem; default behavior is to construct and
throw a
JsonMappingException , but in future may collect more than one
and only throw after certain number, or at the end of serialization. |
abstract JsonSerializer<java.lang.Object> |
serializerInstance(Annotated annotated,
java.lang.Object serDef)
Method that can be called to construct and configure serializer instance,
either given a
Class to instantiate (with default constructor),
or an uninitialized serializer instance. |
SerializerProvider |
setAttribute(java.lang.Object key,
java.lang.Object value)
Method for setting per-call value of given attribute.
|
void |
setDefaultKeySerializer(JsonSerializer<java.lang.Object> ks)
Method that can be used to specify serializer that will be
used to write JSON property names matching null keys for Java
Maps (which will throw an exception if try write such property
name)
|
void |
setNullKeySerializer(JsonSerializer<java.lang.Object> nks)
Method that can be used to specify serializer to use for serializing
all non-null JSON property names, unless more specific key serializer
is found (i.e.
|
void |
setNullValueSerializer(JsonSerializer<java.lang.Object> nvs)
Method that can be used to specify serializer that will be
used to write JSON values matching Java null values
instead of default one (which simply writes JSON null).
|
constructSpecializedType, constructType, converterInstance, objectIdGeneratorInstance, objectIdResolverInstance, reportBadDefinition, resolveAndValidateSubType, resolveSubType
public static final JsonSerializer<java.lang.Object> DEFAULT_NULL_KEY_SERIALIZER
public SerializerProvider()
public void setDefaultKeySerializer(JsonSerializer<java.lang.Object> ks)
public void setNullValueSerializer(JsonSerializer<java.lang.Object> nvs)
Note that you can get finer control over serializer to use by overriding
findNullValueSerializer(com.fasterxml.jackson.databind.BeanProperty)
, which gets called once per each
property.
public void setNullKeySerializer(JsonSerializer<java.lang.Object> nks)
Note that key serializer registration are different from value serializer registrations.
public final SerializationConfig getConfig()
getConfig
in class DatabindContext
public final AnnotationIntrospector getAnnotationIntrospector()
DatabindContext
getConfig().getAnnotationIntrospector();
getAnnotationIntrospector
in class DatabindContext
public final TypeFactory getTypeFactory()
getTypeFactory
in class DatabindContext
public final java.lang.Class<?> getActiveView()
DatabindContext
getActiveView
in class DatabindContext
@Deprecated public final java.lang.Class<?> getSerializationView()
getActiveView()
instead.public final boolean canOverrideAccessModifiers()
DatabindContext
getConfig().canOverrideAccessModifiers();
canOverrideAccessModifiers
in class DatabindContext
public final boolean isEnabled(MapperFeature feature)
DatabindContext
getConfig().isEnabled(feature);
isEnabled
in class DatabindContext
public final JsonFormat.Value getDefaultPropertyFormat(java.lang.Class<?> baseType)
getDefaultPropertyFormat
in class DatabindContext
public final JsonInclude.Value getDefaultPropertyInclusion(java.lang.Class<?> baseType)
public java.util.Locale getLocale()
getConfig().getLocale();
getLocale
in class DatabindContext
public java.util.TimeZone getTimeZone()
getConfig().getTimeZone();
getTimeZone
in class DatabindContext
public java.lang.Object getAttribute(java.lang.Object key)
DatabindContext
ObjectReader
or ObjectWriter
have lower
precedence.getAttribute
in class DatabindContext
key
- Key of the attribute to getpublic SerializerProvider setAttribute(java.lang.Object key, java.lang.Object value)
DatabindContext
setAttribute
in class DatabindContext
key
- Key of the attribute to setvalue
- Value to set attribute topublic final boolean isEnabled(SerializationFeature feature)
getConfig().isEnabled(feature);
public final boolean hasSerializationFeatures(int featureMask)
public final FilterProvider getFilterProvider()
getConfig().getFilterProvider();
public JsonGenerator getGenerator()
NOTE: current implementation simply returns `null` as generator is not yet assigned to this provider.
public abstract WritableObjectId findObjectId(java.lang.Object forPojo, ObjectIdGenerator<?> generatorType)
public JsonSerializer<java.lang.Object> findValueSerializer(java.lang.Class<?> valueType, BeanProperty property) throws JsonMappingException
Note: this method is only called for non-null values; not for keys or null values. For these, check out other accessor methods.
Note that serializers produced should NOT handle polymorphic serialization
aspects; separate TypeSerializer
is to be constructed by caller
if and as necessary.
JsonMappingException
- if there are fatal problems with
accessing suitable serializer; including that of not
finding any serializerpublic JsonSerializer<java.lang.Object> findValueSerializer(JavaType valueType, BeanProperty property) throws JsonMappingException
findValueSerializer(Class,BeanProperty)
, but takes
full generics-aware type instead of raw class.
This is necessary for accurate handling of external type information,
to handle polymorphic types.
Note: this call will also contextualize serializer before returning it.
property
- When creating secondary serializers, property for which
serializer is needed: annotations of the property (or bean that contains it)
may be checked to create contextual serializers.JsonMappingException
public JsonSerializer<java.lang.Object> findValueSerializer(java.lang.Class<?> valueType) throws JsonMappingException
JsonMappingException
public JsonSerializer<java.lang.Object> findValueSerializer(JavaType valueType) throws JsonMappingException
JsonMappingException
public JsonSerializer<java.lang.Object> findPrimaryPropertySerializer(JavaType valueType, BeanProperty property) throws JsonMappingException
findValueSerializer(JavaType, BeanProperty)
, but used
when finding "primary" property value serializer (one directly handling
value of the property). Difference has to do with contextual resolution,
and method(s) called: this method should only be called when caller is
certain that this is the primary property value serializer.property
- Property that is being handled; will never be null, and its
type has to match valueType
parameter.JsonMappingException
public JsonSerializer<java.lang.Object> findPrimaryPropertySerializer(java.lang.Class<?> valueType, BeanProperty property) throws JsonMappingException
JsonMappingException
public JsonSerializer<java.lang.Object> findTypedValueSerializer(java.lang.Class<?> valueType, boolean cache, BeanProperty property) throws JsonMappingException
valueType
- Type for purpose of locating a serializer; usually dynamic
runtime type, but can also be static declared type, depending on configurationcache
- Whether resulting value serializer should be cached or not; this is just
a hintproperty
- When creating secondary serializers, property for which
serializer is needed: annotations of the property (or bean that contains it)
may be checked to create contextual serializers.JsonMappingException
public JsonSerializer<java.lang.Object> findTypedValueSerializer(JavaType valueType, boolean cache, BeanProperty property) throws JsonMappingException
valueType
- Declared type of value being serialized (which may not
be actual runtime type); used for finding both value serializer and
type serializer to use for adding polymorphic type (if any)cache
- Whether resulting value serializer should be cached or not; this is just
a hintproperty
- When creating secondary serializers, property for which
serializer is needed: annotations of the property (or bean that contains it)
may be checked to create contextual serializers.JsonMappingException
public TypeSerializer findTypeSerializer(JavaType javaType) throws JsonMappingException
TypeSerializer
to use for including Type Id necessary
for serializing for the given Java class.
Useful for schema generators.JsonMappingException
public JsonSerializer<java.lang.Object> findKeySerializer(JavaType keyType, BeanProperty property) throws JsonMappingException
findValueSerializer(java.lang.Class<?>, com.fasterxml.jackson.databind.BeanProperty)
method is because actual write
method must be different (@link JsonGenerator#writeFieldName};
but also since behavior for some key types may differ.
Note that the serializer itself can be called with instances of any Java object, but not nulls.
JsonMappingException
public JsonSerializer<java.lang.Object> findKeySerializer(java.lang.Class<?> rawKeyType, BeanProperty property) throws JsonMappingException
JsonMappingException
public JsonSerializer<java.lang.Object> getDefaultNullKeySerializer()
public JsonSerializer<java.lang.Object> getDefaultNullValueSerializer()
public JsonSerializer<java.lang.Object> findNullKeySerializer(JavaType serializationType, BeanProperty property) throws JsonMappingException
JsonMappingException
public JsonSerializer<java.lang.Object> findNullValueSerializer(BeanProperty property) throws JsonMappingException
Default implementation simply calls getDefaultNullValueSerializer()
;
can be overridden to add custom null serialization for properties
of certain type or name. This gives method full granularity to basically
override null handling for any specific property or class of properties.
JsonMappingException
public JsonSerializer<java.lang.Object> getUnknownTypeSerializer(java.lang.Class<?> unknownType)
SerializerFactory
instances are able to construct a serializer.
Typically, returned serializer will throw an exception,
although alternatively ToStringSerializer
could be returned as well.
unknownType
- Type for which no serializer is foundpublic boolean isUnknownTypeSerializer(JsonSerializer<?> ser)
getUnknownTypeSerializer(java.lang.Class<?>)
, that is, something
for which no regular serializer was found or constructed.public abstract JsonSerializer<java.lang.Object> serializerInstance(Annotated annotated, java.lang.Object serDef) throws JsonMappingException
Class
to instantiate (with default constructor),
or an uninitialized serializer instance.
Either way, serialize will be properly resolved
(via ResolvableSerializer
) and/or contextualized
(via ContextualSerializer
) as necessary.annotated
- Annotated entity that contained definitionserDef
- Serializer definition: either an instance or classJsonMappingException
public abstract java.lang.Object includeFilterInstance(BeanPropertyDefinition forProperty, java.lang.Class<?> filterClass) throws JsonMappingException
JsonInclude
filter instance,
given a Class
to instantiate (with default constructor, by default).forProperty
- (optional) If filter is created for a property, that property;
`null` if filter created via defaulting, global or per-type.JsonMappingException
public abstract boolean includeFilterSuppressNulls(java.lang.Object filter) throws JsonMappingException
includeFilterInstance(com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition, java.lang.Class<?>)
,
to check handling of `null` values by the filter.JsonMappingException
public JsonSerializer<?> handlePrimaryContextualization(JsonSerializer<?> ser, BeanProperty property) throws JsonMappingException
ContextualSerializer
with given property context.property
- Property for which the given primary serializer is used; never null.JsonMappingException
public JsonSerializer<?> handleSecondaryContextualization(JsonSerializer<?> ser, BeanProperty property) throws JsonMappingException
ContextualDeserializer
with given property context.
Given that these serializers 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.property
- Property for which serializer is used, if any; null
when deserializing root valuesJsonMappingException
public final void defaultSerializeValue(java.lang.Object value, JsonGenerator gen) throws java.io.IOException
defaultSerializeField(java.lang.String, java.lang.Object, com.fasterxml.jackson.core.JsonGenerator)
instead.java.io.IOException
public final void defaultSerializeField(java.lang.String fieldName, java.lang.Object value, JsonGenerator gen) throws java.io.IOException
java.io.IOException
public final void defaultSerializeDateValue(long timestamp, JsonGenerator gen) throws java.io.IOException
SerializationConfig
settings to determine expected serialization
behavior.
Note: date here means "full" date, that is, date AND time, as per
Java convention (and not date-only values like in SQL)java.io.IOException
public final void defaultSerializeDateValue(java.util.Date date, JsonGenerator gen) throws java.io.IOException
SerializationConfig
settings to determine expected serialization
behavior.
Note: date here means "full" date, that is, date AND time, as per
Java convention (and not date-only values like in SQL)java.io.IOException
public void defaultSerializeDateKey(long timestamp, JsonGenerator gen) throws java.io.IOException
Map
keys,
based on SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS
value (and if using textual representation, configured date format)java.io.IOException
public void defaultSerializeDateKey(java.util.Date date, JsonGenerator gen) throws java.io.IOException
Map
keys,
based on SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS
value (and if using textual representation, configured date format)java.io.IOException
public final void defaultSerializeNull(JsonGenerator gen) throws java.io.IOException
java.io.IOException
public void reportMappingProblem(java.lang.String message, java.lang.Object... args) throws JsonMappingException
JsonMappingException
, but in future may collect more than one
and only throw after certain number, or at the end of serialization.JsonMappingException
public <T> T reportBadTypeDefinition(BeanDescription bean, java.lang.String msg, java.lang.Object... msgArgs) throws JsonMappingException
JsonMappingException
.JsonMappingException
public <T> T reportBadPropertyDefinition(BeanDescription bean, BeanPropertyDefinition prop, java.lang.String message, java.lang.Object... msgArgs) throws JsonMappingException
JsonMappingException
.JsonMappingException
public <T> T reportBadDefinition(JavaType type, java.lang.String msg) throws JsonMappingException
DatabindContext
InvalidDefinitionException
.reportBadDefinition
in class DatabindContext
JsonMappingException
public <T> T reportBadDefinition(JavaType type, java.lang.String msg, java.lang.Throwable cause) throws JsonMappingException
JsonMappingException
public <T> T reportBadDefinition(java.lang.Class<?> raw, java.lang.String msg, java.lang.Throwable cause) throws JsonMappingException
JsonMappingException
public void reportMappingProblem(java.lang.Throwable t, java.lang.String message, java.lang.Object... msgArgs) throws JsonMappingException
JsonMappingException
, but in future may collect more than one
and only throw after certain number, or at the end of serialization.JsonMappingException
public JsonMappingException invalidTypeIdException(JavaType baseType, java.lang.String typeId, java.lang.String extraDesc)
DatabindContext
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.
@Deprecated public JsonMappingException mappingException(java.lang.String message, java.lang.Object... msgArgs)
JsonMappingException
;
usually only indirectly used by calling
reportMappingProblem(String, Object...)
.Copyright © 2010 - 2020 Adobe. All Rights Reserved