Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.ser.impl

public final Class TypeWrappedSerializer

extends JsonSerializer<Object>
implements ContextualSerializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.ser.ContextualSerializer
Imports
java.io.IOException, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.jsontype.TypeSerializer, com.fasterxml.jackson.databind.ser.ContextualSerializer
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 JsonSerializer<Object>
_serializer

protected final TypeSerializer
_typeSerializer

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
public JsonSerializer<?>
createContextual(SerializerProvider
Serializer provider to use for accessing config, other serializers
provider, BeanProperty
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)
property)

Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.

public Class<Object>
handledType()

Overrides com.fasterxml.jackson.databind.JsonSerializer.handledType.

Method for accessing type of Objects this serializer can handle.

public void
serialize(Object
Value to serialize; can not be null.
value, JsonGenerator
Generator used to output resulting Json content
g, SerializerProvider
Provider that can be used to get serializers for serializing Objects value contains, if any.
provider)

Implements abstract com.fasterxml.jackson.databind.JsonSerializer.serialize.

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

public void
serializeWithType(Object
Value to serialize; can not be null.
value, JsonGenerator
Generator used to output resulting Json content
g, SerializerProvider
Provider that can be used to get serializers for serializing Objects value contains, if any.
provider, TypeSerializer
Type serializer to use for including type information
typeSer)

Overrides com.fasterxml.jackson.databind.JsonSerializer.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 JsonSerializer<Object>
valueSerializer()

Inherited from com.fasterxml.jackson.databind.JsonSerializer:
acceptJsonFormatVisitorgetDelegateeisEmptyisEmptyisUnwrappingSerializerpropertiesreplaceDelegateeunwrappingSerializerusesObjectIdwithFilterIdwithIgnoredProperties

Field Detail

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

Constructor Detail

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

Method Detail

createContextualback to summary
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. 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.

Parameters
provider:SerializerProvider

Serializer provider to use for accessing config, other serializers

property:BeanProperty

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)

Returns:JsonSerializer<?>

Serializer to use for serializing values of specified property; may be this instance or a new instance.

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

Overrides com.fasterxml.jackson.databind.JsonSerializer.handledType.

Doc from com.fasterxml.jackson.databind.JsonSerializer.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).

Default implementation will return null, which essentially means same as returning Object.class would; that is, that nothing is known about handled type.

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

Implements abstract com.fasterxml.jackson.databind.JsonSerializer.serialize.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

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

Parameters
value:Object

Value to serialize; can not be null.

g:JsonGenerator

Generator used to output resulting Json content

provider:SerializerProvider

Provider that can be used to get serializers for serializing Objects value contains, if any.

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

Overrides com.fasterxml.jackson.databind.JsonSerializer.serializeWithType.

Doc from com.fasterxml.jackson.databind.JsonSerializer.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.
Parameters
value:Object

Value to serialize; can not be null.

g:JsonGenerator

Generator used to output resulting Json content

provider:SerializerProvider

Provider that can be used to get serializers for serializing Objects value contains, if any.

typeSer:TypeSerializer

Type serializer to use for including type information

Annotations
@Override
typeSerializerback to summary
public TypeSerializer typeSerializer()
valueSerializerback to summary
public JsonSerializer<Object> valueSerializer()