public class StdDelegatingSerializer extends StdSerializer<Object> implements ContextualSerializer, ResolvableSerializer, JsonFormatVisitable, SchemaAware
Converter
, and then this delegate value is serialized by Jackson.
Note that although types may be related, they must not be same; trying to do this will result in an exception.
JsonSerializer.None
Modifier and Type | Field and Description |
---|---|
protected Converter<Object,?> |
_converter |
protected JsonSerializer<Object> |
_delegateSerializer
Underlying serializer for type
T . |
protected JavaType |
_delegateType
Fully resolved delegate type, with generic information if any available.
|
_handledType
Constructor and Description |
---|
StdDelegatingSerializer(Class<T> cls,
Converter<T,?> converter) |
StdDelegatingSerializer(Converter<?,?> converter) |
StdDelegatingSerializer(Converter<Object,?> converter,
JavaType delegateType,
JsonSerializer<?> delegateSerializer) |
Modifier and Type | Method and Description |
---|---|
protected JsonSerializer<Object> |
_findSerializer(Object value,
SerializerProvider serializers)
Helper method used for locating serializer to use in dynamic use case, where
actual type value gets converted to is not specified beyond basic
Object , and where serializer needs to be located dynamically
based on actual value type. |
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
Default implementation specifies no format.
|
protected Object |
convertValue(Object value)
Method called to convert from source Java value into delegate
value (which will be serialized using standard Jackson serializer for delegate type)
|
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.
|
protected Converter<Object,?> |
getConverter() |
JsonSerializer<?> |
getDelegatee()
Accessor that can be used to determine if this serializer uses
another serializer for actual serialization, by delegating
calls.
|
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint)
Default implementation simply claims type is "string"; usually
overriden by custom serializers.
|
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint,
boolean isOptional)
Default implementation simply claims type is "string"; usually
overriden by custom serializers.
|
boolean |
isEmpty(SerializerProvider prov,
Object value)
Method called to check whether given serializable value is
considered "empty" value (for purposes of suppressing serialization
of empty values).
|
void |
resolve(SerializerProvider provider)
Method called after
SerializerProvider has registered
the serializer, but before it has returned it to the caller. |
void |
serialize(Object value,
JsonGenerator gen,
SerializerProvider provider)
Method that can be called to ask implementation to serialize
values of type this serializer handles.
|
void |
serializeWithType(Object value,
JsonGenerator gen,
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.
|
protected StdDelegatingSerializer |
withDelegate(Converter<Object,?> converter,
JavaType delegateType,
JsonSerializer<?> delegateSerializer)
Method used for creating resolved contextual instances.
|
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
protected final JavaType _delegateType
protected final JsonSerializer<Object> _delegateSerializer
T
.public StdDelegatingSerializer(Converter<?,?> converter)
public StdDelegatingSerializer(Converter<Object,?> converter, JavaType delegateType, JsonSerializer<?> delegateSerializer)
protected StdDelegatingSerializer withDelegate(Converter<Object,?> converter, JavaType delegateType, JsonSerializer<?> delegateSerializer)
public void resolve(SerializerProvider provider) throws JsonMappingException
ResolvableSerializer
SerializerProvider
has registered
the serializer, but before it has returned it to the caller.
Called object can then resolve its dependencies to other types,
including self-references (direct or indirect).
Note that this method does NOT return serializer, since resolution is not allowed to change actual serializer to use.
resolve
in interface ResolvableSerializer
provider
- Provider that has constructed serializer this method
is called on.JsonMappingException
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException
ContextualSerializer
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 cannot provide it and
null is passed instead (in which case impls usually pass 'this' serializer as is)JsonMappingException
public JsonSerializer<?> getDelegatee()
JsonSerializer
getDelegatee
in class JsonSerializer<Object>
public void serialize(Object value, JsonGenerator gen, SerializerProvider provider) throws IOException
JsonSerializer
serialize
in class StdSerializer<Object>
value
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for
serializing Objects value contains, if any.IOException
public void serializeWithType(Object value, JsonGenerator gen, 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<Object>
value
- Value to serialize; can not be null.gen
- 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 informationIOException
public boolean isEmpty(SerializerProvider prov, Object value)
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 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 JsonNode getSchema(SerializerProvider provider, Type typeHint, boolean isOptional) throws JsonMappingException
StdSerializer
getSchema
in interface SchemaAware
getSchema
in class StdSerializer<Object>
provider
- The serializer provider.typeHint
- A hint about the type.isOptional
- Is the type optionalJsonMappingException
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 Object convertValue(Object value)
The default implementation uses configured Converter
to do
conversion.
value
- Value to convertprotected JsonSerializer<Object> _findSerializer(Object value, SerializerProvider serializers) throws JsonMappingException
Object
, and where serializer needs to be located dynamically
based on actual value type.JsonMappingException
Copyright © 2021 JBoss by Red Hat. All rights reserved.