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 Method |
_accessorMethod |
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 |
_handledType
Constructor and Description |
---|
JsonValueSerializer(JsonValueSerializer src,
BeanProperty property,
JsonSerializer<?> ser,
boolean forceTypeInfo) |
JsonValueSerializer(Method valueMethod,
JsonSerializer<?> ser) |
Modifier and Type | Method and Description |
---|---|
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
Default implementation specifies no format.
|
JsonSerializer<?> |
createContextual(SerializerProvider provider,
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 provider,
Type typeHint)
Default implementation simply claims type is "string"; usually
overriden by custom serializers.
|
protected boolean |
isNaturalTypeWithStdHandling(Class<?> rawType,
JsonSerializer<?> ser) |
void |
serialize(Object bean,
com.fasterxml.jackson.core.JsonGenerator jgen,
SerializerProvider prov)
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 jgen,
SerializerProvider provider,
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() |
JsonValueSerializer |
withResolved(BeanProperty property,
JsonSerializer<?> ser,
boolean forceTypeInfo) |
createObjectNode, createSchemaNode, createSchemaNode, findConvertingContentSerializer, findPropertyFilter, getSchema, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow
getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, replaceDelegatee, unwrappingSerializer, usesObjectId
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getSchema
protected final Method _accessorMethod
protected final JsonSerializer<Object> _valueSerializer
protected final BeanProperty _property
protected final boolean _forceTypeInformation
public JsonValueSerializer(Method valueMethod, 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
nullpublic JsonValueSerializer(JsonValueSerializer src, BeanProperty property, JsonSerializer<?> ser, boolean forceTypeInfo)
public JsonValueSerializer withResolved(BeanProperty property, JsonSerializer<?> ser, boolean forceTypeInfo)
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException
createContextual
in interface ContextualSerializer
provider
- 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 can not 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 jgen, SerializerProvider prov) throws IOException
JsonSerializer
serialize
in class StdSerializer<Object>
bean
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprov
- 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 jgen, SerializerProvider provider, 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.jgen
- Generator used to output resulting Json contentprovider
- 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 provider, Type typeHint) throws JsonMappingException
StdSerializer
getSchema
in interface SchemaAware
getSchema
in class StdSerializer<Object>
provider
- 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 isNaturalTypeWithStdHandling(Class<?> rawType, JsonSerializer<?> ser)
Copyright © 2014-2015 FasterXML. All Rights Reserved.