public abstract class ReferenceTypeSerializer<T> extends StdSerializer<T> implements ContextualSerializer
ReferenceType.
Implements most of functionality, only leaving couple of abstract
methods for sub-classes to implementJsonSerializer.None| Modifier and Type | Field and Description |
|---|---|
protected PropertySerializerMap |
_dynamicSerializers
If element type cannot be statically determined, mapping from
runtime type to serializer is handled using this object
|
protected BeanProperty |
_property |
protected JavaType |
_referredType
Value type
|
protected Object |
_suppressableValue
Value that indicates suppression mechanism to use for values contained;
either "filter" (of which
equals() is called), or marker
value of MARKER_FOR_EMPTY, or null to indicate no filtering for
non-null values. |
protected boolean |
_suppressNulls
Flag that indicates what to do with `null` values, distinct from
handling of
_suppressableValue |
protected NameTransformer |
_unwrapper
In case of unwrapping, need name transformer.
|
protected JsonSerializer<Object> |
_valueSerializer
Serializer for content values, if statically known.
|
protected TypeSerializer |
_valueTypeSerializer
Type serializer used for values, if any.
|
static Object |
MARKER_FOR_EMPTY |
_handledType| Modifier | Constructor and Description |
|---|---|
|
ReferenceTypeSerializer(ReferenceType fullType,
boolean staticTyping,
TypeSerializer vts,
JsonSerializer<Object> ser) |
protected |
ReferenceTypeSerializer(ReferenceTypeSerializer<?> base,
BeanProperty property,
TypeSerializer vts,
JsonSerializer<?> valueSer,
NameTransformer unwrapper,
Object suppressableValue,
boolean suppressNulls) |
| Modifier and Type | Method and Description |
|---|---|
protected abstract Object |
_getReferenced(T value) |
protected abstract Object |
_getReferencedIfPresent(T value) |
protected abstract boolean |
_isValuePresent(T value)
Method called to see if there is a value present or not.
|
protected boolean |
_useStatic(SerializerProvider provider,
BeanProperty property,
JavaType referredType) |
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
Default implementation specifies no format.
|
JsonSerializer<?> |
createContextual(SerializerProvider provider,
BeanProperty property)
Method called to see if a different (or differently configured) serializer
is needed to serialize values of specified property.
|
JavaType |
getReferredType() |
boolean |
isEmpty(SerializerProvider provider,
T value)
Method called to check whether given serializable value is
considered "empty" value (for purposes of suppressing serialization
of empty values).
|
boolean |
isUnwrappingSerializer()
Accessor for checking whether this serializer is an
"unwrapping" serializer; this is necessary to know since
it may also require caller to suppress writing of the
leading property name.
|
void |
serialize(T ref,
JsonGenerator g,
SerializerProvider provider)
Method that can be called to ask implementation to serialize
values of type this serializer handles.
|
void |
serializeWithType(T ref,
JsonGenerator g,
SerializerProvider provider,
TypeSerializer typeSer)
Method that can be called to ask implementation to serialize
values of type this serializer handles, using specified type serializer
for embedding necessary type information.
|
JsonSerializer<T> |
unwrappingSerializer(NameTransformer transformer)
Method that will return serializer instance that produces
"unwrapped" serialization, if applicable for type being
serialized (which is the case for some serializers
that produce JSON Objects as output).
|
abstract ReferenceTypeSerializer<T> |
withContentInclusion(Object suppressableValue,
boolean suppressNulls)
Mutant factory method called to create a differently constructed instance,
specifically with different exclusion rules for contained value.
|
protected abstract ReferenceTypeSerializer<T> |
withResolved(BeanProperty prop,
TypeSerializer vts,
JsonSerializer<?> valueSer,
NameTransformer unwrapper)
Mutant factory method called when changes are needed; should construct
newly configured instance with new values as indicated.
|
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrowgetDelegatee, isEmpty, properties, replaceDelegatee, usesObjectId, withFilterIdpublic static final Object MARKER_FOR_EMPTY
protected final JavaType _referredType
protected final BeanProperty _property
protected final TypeSerializer _valueTypeSerializer
protected final JsonSerializer<Object> _valueSerializer
protected final NameTransformer _unwrapper
protected transient PropertySerializerMap _dynamicSerializers
protected final Object _suppressableValue
equals() is called), or marker
value of MARKER_FOR_EMPTY, or null to indicate no filtering for
non-null values.
Note that inclusion value for Map instance itself is handled by caller (POJO
property that refers to the Map value).protected final boolean _suppressNulls
_suppressableValuepublic ReferenceTypeSerializer(ReferenceType fullType, boolean staticTyping, TypeSerializer vts, JsonSerializer<Object> ser)
protected ReferenceTypeSerializer(ReferenceTypeSerializer<?> base, BeanProperty property, TypeSerializer vts, JsonSerializer<?> valueSer, NameTransformer unwrapper, Object suppressableValue, boolean suppressNulls)
public JsonSerializer<T> unwrappingSerializer(NameTransformer transformer)
JsonSerializerDefault implementation just returns serializer as-is, indicating that no unwrapped variant exists
unwrappingSerializer in class JsonSerializer<T>transformer - Name transformation to use to convert between names
of unwrapper propertiesprotected abstract ReferenceTypeSerializer<T> withResolved(BeanProperty prop, TypeSerializer vts, JsonSerializer<?> valueSer, NameTransformer unwrapper)
NOTE: caller has verified that there are changes, so implementations need NOT check if a new instance is needed.
public abstract ReferenceTypeSerializer<T> withContentInclusion(Object suppressableValue, boolean suppressNulls)
NOTE: caller has verified that there are changes, so implementations need NOT check if a new instance is needed.
protected abstract boolean _isValuePresent(T value)
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException
ContextualSerializercreateContextual in interface ContextualSerializerprovider - Serializer provider to use for accessing config, other serializersproperty - Method or field that represents the property
(and is used to access value to serialize).
Should be available; but there may be cases where caller cannot provide it and
null is passed instead (in which case impls usually pass 'this' serializer as is)JsonMappingExceptionprotected boolean _useStatic(SerializerProvider provider, BeanProperty property, JavaType referredType)
public boolean isEmpty(SerializerProvider provider, T value)
JsonSerializerDefault implementation will consider only null values to be empty.
NOTE: replaces JsonSerializer.isEmpty(Object), which was deprecated in 2.5
isEmpty in class JsonSerializer<T>public boolean isUnwrappingSerializer()
JsonSerializerisUnwrappingSerializer in class JsonSerializer<T>public JavaType getReferredType()
public void serialize(T ref, JsonGenerator g, SerializerProvider provider) throws IOException
JsonSerializerserialize in class StdSerializer<T>ref - Value to serialize; can not be null.g - Generator used to output resulting Json contentprovider - Provider that can be used to get serializers for
serializing Objects value contains, if any.IOExceptionpublic void serializeWithType(T ref, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException
JsonSerializer
Default implementation will throw UnsupportedOperationException
to indicate that proper type handling needs to be implemented.
For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like:
// note: method to call depends on whether this type is serialized as JSON scalar, object or Array! typeSer.writeTypePrefixForScalar(value, gen); serialize(value, gen, provider); typeSer.writeTypeSuffixForScalar(value, gen);and implementations for type serialized as JSON Arrays or Objects would differ slightly, as
START-ARRAY/END-ARRAY and
START-OBJECT/END-OBJECT pairs
need to be properly handled with respect to serializing of contents.serializeWithType in class JsonSerializer<T>ref - Value to serialize; can not be null.g - Generator used to output resulting Json contentprovider - Provider that can be used to get serializers for
serializing Objects value contains, if any.typeSer - Type serializer to use for including type informationIOExceptionpublic void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
StdSerializeracceptJsonFormatVisitor in interface JsonFormatVisitableacceptJsonFormatVisitor in class StdSerializer<T>typeHint - Type of element (entity like property) being visitedJsonMappingExceptionCopyright © 2008–2018 FasterXML. All rights reserved.