public class JsonValueSerializer extends StdSerializer<Object> implements ContextualSerializer, JsonFormatVisitable, SchemaAware
JsonValue
annotation to
indicate that serialization should be done by calling the method
annotated, and serializing result it returns.
Implementation note: we will post-process resulting serializer
(much like what is done with BeanSerializer
)
to figure out actual serializers for final types.
This must be done from createContextual(com.fasterxml.jackson.databind.SerializerProvider, com.fasterxml.jackson.databind.BeanProperty)
method, and NOT from constructor;
otherwise we could end up with an infinite loop.
JsonSerializer.None
Modifier and Type | Field and Description |
---|---|
protected AnnotatedMember |
_accessor |
protected PropertySerializerMap |
_dynamicSerializers
If value type cannot be statically determined, mapping from
runtime value types to serializers are cached in this object.
|
protected boolean |
_forceTypeInformation
This is a flag that is set in rare (?) cases where this serializer
is used for "natural" types (boolean, int, String, double); and where
we actually must force type information wrapping, even though
one would not normally be added.
|
protected BeanProperty |
_property |
protected JsonSerializer<Object> |
_valueSerializer |
protected JavaType |
_valueType
Declared type of the value accessed, as declared by accessor.
|
protected TypeSerializer |
_valueTypeSerializer |
_handledType
Constructor and Description |
---|
JsonValueSerializer(AnnotatedMember accessor,
JsonSerializer<?> ser)
Deprecated.
Since 2.12
|
JsonValueSerializer(AnnotatedMember accessor,
TypeSerializer vts,
JsonSerializer<?> ser) |
JsonValueSerializer(JsonValueSerializer src,
BeanProperty property,
TypeSerializer vts,
JsonSerializer<?> ser,
boolean forceTypeInfo) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
_acceptJsonFormatVisitorForEnum(JsonFormatVisitorWrapper visitor,
JavaType typeHint,
Class<?> enumType)
Overridable helper method used for special case handling of schema information for
Enums.
|
protected JsonSerializer<Object> |
_findDynamicSerializer(SerializerProvider ctxt,
Class<?> valueClass) |
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
Default implementation specifies no format.
|
JsonSerializer<?> |
createContextual(SerializerProvider ctxt,
BeanProperty property)
We can try to find the actual serializer for value, if we can
statically figure out what the result type must be.
|
JsonNode |
getSchema(SerializerProvider ctxt,
Type typeHint)
Default implementation simply claims type is "string"; usually
overriden by custom serializers.
|
boolean |
isEmpty(SerializerProvider ctxt,
Object bean)
Method called to check whether given serializable value is
considered "empty" value (for purposes of suppressing serialization
of empty values).
|
protected boolean |
isNaturalTypeWithStdHandling(Class<?> rawType,
JsonSerializer<?> ser) |
void |
serialize(Object bean,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider ctxt)
Method that can be called to ask implementation to serialize
values of type this serializer handles.
|
void |
serializeWithType(Object bean,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider ctxt,
TypeSerializer typeSer0)
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.
|
String |
toString() |
protected JsonValueSerializer |
withResolved(BeanProperty property,
TypeSerializer vts,
JsonSerializer<?> ser,
boolean forceTypeInfo) |
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getSchema
protected final AnnotatedMember _accessor
protected final TypeSerializer _valueTypeSerializer
protected final JsonSerializer<Object> _valueSerializer
protected final BeanProperty _property
protected final JavaType _valueType
protected final boolean _forceTypeInformation
protected transient PropertySerializerMap _dynamicSerializers
public JsonValueSerializer(AnnotatedMember accessor, TypeSerializer vts, JsonSerializer<?> ser)
ser
- Explicit serializer to use, if caller knows it (which
occurs if and only if the "value method" was annotated with
JsonSerialize.using()
), otherwise
nullTypeSerializer
since 2.11@Deprecated public JsonValueSerializer(AnnotatedMember accessor, JsonSerializer<?> ser)
public JsonValueSerializer(JsonValueSerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> ser, boolean forceTypeInfo)
protected JsonValueSerializer withResolved(BeanProperty property, TypeSerializer vts, JsonSerializer<?> ser, boolean forceTypeInfo)
public boolean isEmpty(SerializerProvider ctxt, Object bean)
JsonSerializer
Default implementation will consider only null values to be empty.
NOTE: replaces JsonSerializer.isEmpty(Object)
, which was deprecated in 2.5
isEmpty
in class JsonSerializer<Object>
public JsonSerializer<?> createContextual(SerializerProvider ctxt, BeanProperty property) throws JsonMappingException
createContextual
in interface ContextualSerializer
ctxt
- 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)JsonMappingException
public void serialize(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider ctxt) throws IOException
JsonSerializer
serialize
in class StdSerializer<Object>
bean
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentctxt
- Provider that can be used to get serializers for
serializing Objects value contains, if any.IOException
public void serializeWithType(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider ctxt, TypeSerializer typeSer0) 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<Object>
bean
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentctxt
- Provider that can be used to get serializers for
serializing Objects value contains, if any.typeSer0
- Type serializer to use for including type informationIOException
public JsonNode getSchema(SerializerProvider ctxt, Type typeHint) throws JsonMappingException
StdSerializer
getSchema
in interface SchemaAware
getSchema
in class StdSerializer<Object>
ctxt
- The serializer provider.typeHint
- A hint about the type.JsonMappingException
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
StdSerializer
acceptJsonFormatVisitor
in interface JsonFormatVisitable
acceptJsonFormatVisitor
in class StdSerializer<Object>
typeHint
- Type of element (entity like property) being visitedJsonMappingException
protected boolean _acceptJsonFormatVisitorForEnum(JsonFormatVisitorWrapper visitor, JavaType typeHint, Class<?> enumType) throws JsonMappingException
JsonMappingException
protected boolean isNaturalTypeWithStdHandling(Class<?> rawType, JsonSerializer<?> ser)
protected JsonSerializer<Object> _findDynamicSerializer(SerializerProvider ctxt, Class<?> valueClass) throws JsonMappingException
JsonMappingException
Copyright © 2008–2023 FasterXML. All rights reserved.