com.fasterxml.jackson.databind.ser.std

Class BeanSerializerBase

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<T>

com.fasterxml.jackson.databind.ser.std.StdSerializer<java.lang.Object>

com.fasterxml.jackson.databind.ser.std.BeanSerializerBase

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, ResolvableSerializer, java.io.Serializable

Direct Known Subclasses:

BeanAsArraySerializer, BeanSerializer, UnwrappingBeanSerializer

public abstract class BeanSerializerBase
extends StdSerializer<java.lang.Object>
implements ContextualSerializer, ResolvableSerializer, JsonFormatVisitable, SchemaAware

Base class both for the standard bean serializer, and couple of variants that only differ in small details. Can be used for custom bean serializers as well, although that is not the primary design goal.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer

JsonSerializer.None

Constructor Summary

Constructors

Constructor and Description
BeanSerializerBase(BeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

Method Summary

Modifier and Type	Method and Description
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.
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.
JsonNode	getSchema(SerializerProvider provider, java.lang.reflect.Type typeHint) Deprecated.
java.util.Iterator<PropertyWriter>	properties() Accessor for iterating over logical properties that the type handled by this serializer has, from serialization perspective.
void	resolve(SerializerProvider provider) We need to implement ResolvableSerializer to be able to properly handle cyclic type references.
abstract void	serialize(java.lang.Object bean, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(java.lang.Object bean, 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.
boolean	usesObjectId() Method that can be called to see whether this serializer instance will use Object Id to handle cyclic references.
abstract BeanSerializerBase	withFilterId(java.lang.Object filterId) Mutant factory used for creating a new instance with different filter id (used with JsonFilter annotation)
abstract BeanSerializerBase	withObjectIdWriter(ObjectIdWriter objectIdWriter) Mutant factory used for creating a new instance with different ObjectIdWriter.

Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

getSchema, handledType, wrapAndThrow, wrapAndThrow

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer

getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, replaceDelegatee, unwrappingSerializer

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.fasterxml.jackson.databind.jsonschema.SchemaAware

getSchema

Constructor Detail

BeanSerializerBase

public BeanSerializerBase(BeanSerializerBase src,
                          BeanPropertyWriter[] properties,
                          BeanPropertyWriter[] filteredProperties)

Method Detail

withObjectIdWriter

public abstract BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)

Mutant factory used for creating a new instance with different ObjectIdWriter.

Since:

2.0

withFilterId

public abstract BeanSerializerBase withFilterId(java.lang.Object filterId)

Mutant factory used for creating a new instance with different filter id (used with JsonFilter annotation)

Overrides:

withFilterId in class JsonSerializer<java.lang.Object>

Since:

2.3

resolve

public void resolve(SerializerProvider provider)
             throws JsonMappingException

We need to implement ResolvableSerializer to be able to properly handle cyclic type references.

Specified by:

resolve in interface ResolvableSerializer

Parameters:

provider - Provider that has constructed serializer this method is called on.

Throws:

JsonMappingException

createContextual

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

Description copied from interface: ContextualSerializer

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.

Specified by:

createContextual in interface ContextualSerializer

Parameters:

provider - Serializer provider to use for accessing config, other serializers

property - 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:

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

Throws:

JsonMappingException

properties

public java.util.Iterator<PropertyWriter> properties()

Description copied from class: JsonSerializer

Accessor for iterating over logical properties that the type handled by this serializer has, from serialization perspective. Actual type of properties, if any, will be BeanPropertyWriter. Of standard Jackson serializers, only BeanSerializer exposes properties.

Overrides:

properties in class JsonSerializer<java.lang.Object>

usesObjectId

public boolean usesObjectId()

Description copied from class: JsonSerializer

Method that can be called to see whether this serializer instance will use Object Id to handle cyclic references.

Overrides:

usesObjectId in class JsonSerializer<java.lang.Object>

serialize

public abstract void serialize(java.lang.Object bean,
                               JsonGenerator gen,
                               SerializerProvider provider)
                        throws java.io.IOException

Description copied from class: JsonSerializer

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

Specified by:

serialize in class StdSerializer<java.lang.Object>

Parameters:

bean - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

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

Throws:

java.io.IOException

serializeWithType

public void serializeWithType(java.lang.Object bean,
                              JsonGenerator gen,
                              SerializerProvider provider,
                              TypeSerializer typeSer)
                       throws java.io.IOException

Description copied from class: JsonSerializer

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.

Overrides:

serializeWithType in class JsonSerializer<java.lang.Object>

Parameters:

bean - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

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

typeSer - Type serializer to use for including type information

Throws:

java.io.IOException

getSchema

@Deprecated
public JsonNode getSchema(SerializerProvider provider,
                                      java.lang.reflect.Type typeHint)
                               throws JsonMappingException

Deprecated.

Description copied from class: StdSerializer

Default implementation simply claims type is "string"; usually overriden by custom serializers.

Specified by:

getSchema in interface SchemaAware

Overrides:

getSchema in class StdSerializer<java.lang.Object>

Parameters:

provider - The serializer provider.

typeHint - A hint about the type.

Returns:

Json-schema for this serializer.

Throws:

JsonMappingException

acceptJsonFormatVisitor

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
                                    JavaType typeHint)
                             throws JsonMappingException

Description copied from class: StdSerializer

Default implementation specifies no format. This behavior is usually overriden by custom serializers.

Specified by:

acceptJsonFormatVisitor in interface JsonFormatVisitable

Overrides:

acceptJsonFormatVisitor in class StdSerializer<java.lang.Object>

typeHint - Type of element (entity like property) being visited

Throws:

JsonMappingException