com.fasterxml.jackson.databind.ser.std

Class BeanSerializerBase

java.lang.Object

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

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

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

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, ResolvableSerializer, Serializable

Direct Known Subclasses:

BeanAsArraySerializer, BeanSerializer, UnwrappingBeanSerializer

public abstract class BeanSerializerBase
extends StdSerializer<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

Field Summary

Fields

Modifier and Type	Field and Description
protected AnyGetterWriter	_anyGetterWriter Handler for JsonAnyGetter annotated properties
protected JavaType	_beanType
protected BeanPropertyWriter[]	_filteredProps Optional filters used to suppress output of properties that are only to be included in certain views
protected ObjectIdWriter	_objectIdWriter If this POJO can be alternatively serialized using just an object id to denote a reference to previously serialized object, this Object will handle details.
protected Object	_propertyFilterId Id of the bean property filter to use, if any; null if none.
protected BeanPropertyWriter[]	_props Writers used for outputting actual property values
protected JsonFormat.Shape	_serializationShape Requested shape from bean class annotations.
protected AnnotatedMember	_typeId If using custom type ids (usually via getter, or field), this is the reference to that member.
protected static PropertyName	NAME_FOR_OBJECT_REF
protected static BeanPropertyWriter[]	NO_PROPS

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

_handledType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BeanSerializerBase(BeanSerializerBase src) Copy-constructor that is useful for sub-classes that just want to copy all super-class properties without modifications.
protected	BeanSerializerBase(BeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
protected	BeanSerializerBase(BeanSerializerBase src, NameTransformer unwrapper) Copy-constructor that will also rename properties with given prefix (if it's non-empty)
protected	BeanSerializerBase(BeanSerializerBase src, ObjectIdWriter objectIdWriter)
protected	BeanSerializerBase(BeanSerializerBase src, ObjectIdWriter objectIdWriter, Object filterId)
protected	BeanSerializerBase(BeanSerializerBase src, Set<String> toIgnore) Deprecated.
protected	BeanSerializerBase(BeanSerializerBase src, Set<String> toIgnore, Set<String> toInclude)
protected	BeanSerializerBase(BeanSerializerBase src, String[] toIgnore) Deprecated.
protected	BeanSerializerBase(JavaType type, BeanSerializerBuilder builder, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties) Constructor used by BeanSerializerBuilder to create an instance

Method Summary

Modifier and Type	Method and Description
protected String	_customTypeId(Object bean) Deprecated.
protected void	_serializeObjectId(Object bean, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer, WritableObjectId objectId)
protected void	_serializeWithObjectId(Object bean, JsonGenerator gen, SerializerProvider provider, boolean startEndObject)
protected void	_serializeWithObjectId(Object bean, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer)
protected WritableTypeId	_typeIdDef(TypeSerializer typeSer, Object bean, JsonToken valueShape)
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.
protected abstract BeanSerializerBase	asArraySerializer() Mutant factory for creating a variant that output POJO as a JSON Array.
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 JsonSerializer<Object>	findConvertingSerializer(SerializerProvider provider, BeanPropertyWriter prop) Helper method that can be used to see if specified property is annotated to indicate use of a converter for property value (in case of container types, it is container type itself, not key or content type).
JsonNode	getSchema(SerializerProvider provider, Type typeHint) Deprecated.
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(Object bean, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
protected void	serializeFields(Object bean, JsonGenerator gen, SerializerProvider provider)
protected void	serializeFieldsFiltered(Object bean, JsonGenerator gen, SerializerProvider provider) Alternative serialization method that gets called when there is a PropertyFilter that needs to be called to determine which properties are to be serialized (and possibly how)
void	serializeWithType(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.
protected abstract BeanSerializerBase	withByNameInclusion(Set<String> toIgnore, Set<String> toInclude) Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)
abstract BeanSerializerBase	withFilterId(Object filterId) Mutant factory used for creating a new instance with different filter id (used with JsonFilter annotation)
protected BeanSerializerBase	withIgnorals(Set<String> toIgnore) Deprecated. Since 2.12
protected BeanSerializerBase	withIgnorals(String[] toIgnore) Deprecated. since 2.8
abstract BeanSerializerBase	withObjectIdWriter(ObjectIdWriter objectIdWriter) Mutant factory used for creating a new instance with different ObjectIdWriter.
protected abstract BeanSerializerBase	withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties) Mutant factory used for creating a new instance with modified set of properties.

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

_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

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

getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, replaceDelegatee, unwrappingSerializer

Methods inherited from class java.lang.Object

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

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

getSchema

Field Detail

NAME_FOR_OBJECT_REF

protected static final PropertyName NAME_FOR_OBJECT_REF

NO_PROPS

protected static final BeanPropertyWriter[] NO_PROPS

_beanType

protected final JavaType _beanType

Since:

2.9

_props

protected final BeanPropertyWriter[] _props

Writers used for outputting actual property values

_filteredProps

protected final BeanPropertyWriter[] _filteredProps

Optional filters used to suppress output of properties that are only to be included in certain views

_anyGetterWriter

protected final AnyGetterWriter _anyGetterWriter

Handler for JsonAnyGetter annotated properties

_propertyFilterId

protected final Object _propertyFilterId

Id of the bean property filter to use, if any; null if none.

_typeId

protected final AnnotatedMember _typeId

If using custom type ids (usually via getter, or field), this is the reference to that member.

_objectIdWriter

protected final ObjectIdWriter _objectIdWriter

If this POJO can be alternatively serialized using just an object id to denote a reference to previously serialized object, this Object will handle details.

_serializationShape

protected final JsonFormat.Shape _serializationShape

Requested shape from bean class annotations.

Constructor Detail

BeanSerializerBase

protected BeanSerializerBase(JavaType type,
                             BeanSerializerBuilder builder,
                             BeanPropertyWriter[] properties,
                             BeanPropertyWriter[] filteredProperties)

Constructor used by BeanSerializerBuilder to create an instance

Parameters:

type - Nominal type of values handled by this serializer

builder - Builder for accessing other collected information

BeanSerializerBase

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

BeanSerializerBase

protected BeanSerializerBase(BeanSerializerBase src,
                             ObjectIdWriter objectIdWriter)

BeanSerializerBase

protected BeanSerializerBase(BeanSerializerBase src,
                             ObjectIdWriter objectIdWriter,
                             Object filterId)

Since:

2.3

BeanSerializerBase

@Deprecated
protected BeanSerializerBase(BeanSerializerBase src,
                                         String[] toIgnore)

Deprecated.

BeanSerializerBase

@Deprecated
protected BeanSerializerBase(BeanSerializerBase src,
                                         Set<String> toIgnore)

Deprecated.

BeanSerializerBase

protected BeanSerializerBase(BeanSerializerBase src,
                             Set<String> toIgnore,
                             Set<String> toInclude)

BeanSerializerBase

protected BeanSerializerBase(BeanSerializerBase src)

Copy-constructor that is useful for sub-classes that just want to copy all super-class properties without modifications.

BeanSerializerBase

protected BeanSerializerBase(BeanSerializerBase src,
                             NameTransformer unwrapper)

Copy-constructor that will also rename properties with given prefix (if it's non-empty)

Method Detail

withObjectIdWriter

public abstract BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)

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

Since:

2.0

withIgnorals

@Deprecated
protected BeanSerializerBase withIgnorals(Set<String> toIgnore)

Deprecated. Since 2.12

Mutant factory used for creating a new instance with additional set of properties to ignore (from properties this instance otherwise has)

Since:

2.8

withByNameInclusion

protected abstract BeanSerializerBase withByNameInclusion(Set<String> toIgnore,
                                                          Set<String> toInclude)

Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)

Since:

2.12

withIgnorals

@Deprecated
protected BeanSerializerBase withIgnorals(String[] toIgnore)

Deprecated. since 2.8

Mutant factory used for creating a new instance with additional set of properties to ignore (from properties this instance otherwise has)

asArraySerializer

protected abstract BeanSerializerBase asArraySerializer()

Mutant factory for creating a variant that output POJO as a JSON Array. Implementations may ignore this request if output as array is not possible (either at all, or reliably).

Since:

2.1

withFilterId

public abstract BeanSerializerBase withFilterId(Object filterId)

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

Overrides:

withFilterId in class JsonSerializer<Object>

Since:

2.3

withProperties

protected abstract BeanSerializerBase withProperties(BeanPropertyWriter[] properties,
                                                     BeanPropertyWriter[] filteredProperties)

Mutant factory used for creating a new instance with modified set of properties.

Note: in 2.11.x, need to keep non-abstract for slightly better compatibility (XML module extends)

Since:

2.11.1

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

findConvertingSerializer

protected JsonSerializer<Object> findConvertingSerializer(SerializerProvider provider,
                                                          BeanPropertyWriter prop)
                                                   throws JsonMappingException

Helper method that can be used to see if specified property is annotated to indicate use of a converter for property value (in case of container types, it is container type itself, not key or content type).

Throws:

JsonMappingException

Since:

2.2

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 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<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<Object>

serialize

public abstract void serialize(Object bean,
                               JsonGenerator gen,
                               SerializerProvider provider)
                        throws 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<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:

IOException

serializeWithType

public void serializeWithType(Object bean,
                              JsonGenerator gen,
                              SerializerProvider provider,
                              TypeSerializer typeSer)
                       throws 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<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:

IOException

_serializeWithObjectId

protected final void _serializeWithObjectId(Object bean,
                                            JsonGenerator gen,
                                            SerializerProvider provider,
                                            boolean startEndObject)
                                     throws IOException

Throws:

IOException

_serializeWithObjectId

protected final void _serializeWithObjectId(Object bean,
                                            JsonGenerator gen,
                                            SerializerProvider provider,
                                            TypeSerializer typeSer)
                                     throws IOException

Throws:

IOException

_serializeObjectId

protected void _serializeObjectId(Object bean,
                                  JsonGenerator g,
                                  SerializerProvider provider,
                                  TypeSerializer typeSer,
                                  WritableObjectId objectId)
                           throws IOException

Throws:

IOException

_typeIdDef

protected final WritableTypeId _typeIdDef(TypeSerializer typeSer,
                                          Object bean,
                                          JsonToken valueShape)

Since:

2.9

_customTypeId

@Deprecated
protected final String _customTypeId(Object bean)

Deprecated.

serializeFields

protected void serializeFields(Object bean,
                               JsonGenerator gen,
                               SerializerProvider provider)
                        throws IOException

Throws:

IOException

serializeFieldsFiltered

protected void serializeFieldsFiltered(Object bean,
                                       JsonGenerator gen,
                                       SerializerProvider provider)
                                throws IOException

Alternative serialization method that gets called when there is a PropertyFilter that needs to be called to determine which properties are to be serialized (and possibly how)

Throws:

IOException

getSchema

@Deprecated
public JsonNode getSchema(SerializerProvider provider,
                                      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<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<Object>

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

Throws:

JsonMappingException