Top Description Fields Constructors Methods
tools.jackson.databind.ser.impl

public final Class TypeWrappedSerializer

extends ValueSerializer<Object>
Class Inheritance
Imports
tools.jackson.core.JacksonException, .JsonGenerator, tools.jackson.databind.*, tools.jackson.databind.jsontype.TypeSerializer
Simple serializer that will call configured type serializer, passing in configured data serializer, and exposing it all as a simple serializer.

Field Summary

Modifier and TypeField and Description
protected final ValueSerializer<Object>
_serializer

protected final TypeSerializer
_typeSerializer

Constructor Summary

AccessConstructor and Description
public
TypeWrappedSerializer(TypeSerializer typeSer, ValueSerializer<?> ser)

Method Summary

Modifier and TypeMethod and Description
public ValueSerializer<?>
createContextual(SerializationContext provider, BeanProperty property)

Overrides tools.jackson.databind.ValueSerializer.createContextual.

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed).

public Class<Object>
handledType()

Overrides tools.jackson.databind.ValueSerializer.handledType.

Method for accessing type of Objects this serializer can handle.

public void
serialize(Object value, JsonGenerator g, SerializationContext provider)

Implements abstract tools.jackson.databind.ValueSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.

public void
serializeWithType(Object value, JsonGenerator g, SerializationContext provider, TypeSerializer typeSer)

Overrides tools.jackson.databind.ValueSerializer.serializeWithType.

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.

public TypeSerializer
typeSerializer()

public ValueSerializer<Object>
valueSerializer()

Inherited from tools.jackson.databind.ValueSerializer:
acceptJsonFormatVisitorgetDelegateeisEmptyisUnwrappingSerializerpropertiesreplaceDelegateeresolveunwrappingSerializerusesObjectIdwithFilterIdwithFormatOverrideswithIgnoredProperties

Field Detail

_serializerback to summary
protected final ValueSerializer<Object> _serializer
_typeSerializerback to summary
protected final TypeSerializer _typeSerializer

Constructor Detail

TypeWrappedSerializerback to summary
public TypeWrappedSerializer(TypeSerializer typeSer, ValueSerializer<?> ser)
Annotations
@SuppressWarnings:unchecked

Method Detail

createContextualback to summary
public ValueSerializer<?> createContextual(SerializationContext provider, BeanProperty property)

Overrides tools.jackson.databind.ValueSerializer.createContextual.

Doc from tools.jackson.databind.ValueSerializer.createContextual.

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.

Annotations
@Override
handledTypeback to summary
public Class<Object> handledType()

Overrides tools.jackson.databind.ValueSerializer.handledType.

Doc from tools.jackson.databind.ValueSerializer.handledType.

Method for accessing type of Objects this serializer can handle. Note that this information is not guaranteed to be exact -- it may be a more generic (super-type) -- but it should not be incorrect (return a non-related type).

Note

starting with 3.0, left abstract.

Annotations
@Override
serializeback to summary
public void serialize(Object value, JsonGenerator g, SerializationContext provider) throws JacksonException

Implements abstract tools.jackson.databind.ValueSerializer.serialize.

Doc from tools.jackson.databind.ValueSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.

Annotations
@Override
serializeWithTypeback to summary
public void serializeWithType(Object value, JsonGenerator g, SerializationContext provider, TypeSerializer typeSer) throws JacksonException

Overrides tools.jackson.databind.ValueSerializer.serializeWithType.

Doc from tools.jackson.databind.ValueSerializer.serializeWithType.

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.

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.
Annotations
@Override
typeSerializerback to summary
public TypeSerializer typeSerializer()
valueSerializerback to summary
public ValueSerializer<Object> valueSerializer()