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

public Class BeanSerializer

extends BeanSerializerBase
Class Inheritance
Imports
java.io.IOException, java.util.Set, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.ser.impl.BeanAsArraySerializer, .ObjectIdWriter, .UnwrappingBeanSerializer, com.fasterxml.jackson.databind.ser.std.BeanSerializerBase, com.fasterxml.jackson.databind.util.NameTransformer

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Serializer class that can serialize Java objects that map to JSON Object output. Internally handling is mostly dealt with by a sequence of BeanPropertyWriters that will handle access value to serialize and call appropriate serializers to write out JSON.

Implementation Note

we will post-process resulting serializer, to figure out actual serializers for final types. This must be done from resolve method, and NOT from constructor; otherwise we could end up with an infinite loop.

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

Inherited from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase:
_anyGetterWriter_beanType_filteredProps_objectIdWriter_propertyFilterId_props_serializationShape_typeIdNAME_FOR_OBJECT_REFNO_PROPS

Constructor Summary

AccessConstructor and Description
public
BeanSerializer(JavaType type, BeanSerializerBuilder
Builder object that contains collected information that may be needed for serializer
builder, BeanPropertyWriter[]
Property writers used for actual serialization
properties, BeanPropertyWriter[] filteredProperties)

protected
BeanSerializer(BeanSerializerBase src)
References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Alternate copy constructor that can be used to construct standard BeanSerializer passing an instance of "compatible enough" source serializer.

protected
BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter)
References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

protected
BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter, Object filterId)
References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

protected
BeanSerializer(BeanSerializerBase src, Set<String> toIgnore, Set<String> toInclude)
References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

protected
BeanSerializer(BeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Method Summary

Modifier and TypeMethod and Description
protected BeanSerializerBase
asArraySerializer()

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.asArraySerializer.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Implementation has to check whether as-array serialization is possible reliably; if (and only if) so, will construct a BeanAsArraySerializer, otherwise will return this serializer as is.

public static BeanSerializer
createDummy(JavaType forType)
Deprecated Since 2.10

public static BeanSerializer
createDummy(JavaType forType, BeanSerializerBuilder builder)
References Deprecated BeanSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

Method for constructing dummy bean serializer; one that never outputs any properties

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

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serialize.

Main serialization method that will delegate actual output to configured BeanPropertyWriter instances.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public JsonSerializer<Object>
unwrappingSerializer(NameTransformer
Name transformation to use to convert between names of unwrapper properties
unwrapper)

Overrides com.fasterxml.jackson.databind.JsonSerializer.unwrappingSerializer.

Method that will return serializer instance that produces "unwrapped" serialization, if applicable for type being serialized (which is the case for some serializers that produce JSON Objects as output).

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

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withByNameInclusion.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

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

public BeanSerializerBase
withFilterId(Object filterId)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withFilterId.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

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

public JsonSerializer<?>
withIgnoredProperties(Set<String>
Set of property names to ignore for serialization;
toIgnore)

Overrides com.fasterxml.jackson.databind.JsonSerializer.withIgnoredProperties.

Mutant factory method called to create a new instance after excluding specified set of properties by name, if there is any.

public BeanSerializerBase
withObjectIdWriter(ObjectIdWriter objectIdWriter)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withObjectIdWriter.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

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

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

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withProperties.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

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

Inherited from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase:
_customTypeId_serializeObjectId_serializeWithObjectId_serializeWithObjectId_typeIdDefacceptJsonFormatVisitorcreateContextualfindConvertingSerializergetSchemapropertiesresolveserializeFieldsserializeFieldsFilteredserializeWithTypeusesObjectIdwithIgnoralswithIgnorals

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

Constructor Detail

BeanSerializerback to summary
public BeanSerializer(JavaType type, BeanSerializerBuilder builder, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
Parameters
builder:BeanSerializerBuilder

Builder object that contains collected information that may be needed for serializer

properties:BeanPropertyWriter[]

Property writers used for actual serialization

BeanSerializerback to summary
protected BeanSerializer(BeanSerializerBase src)

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Alternate copy constructor that can be used to construct standard BeanSerializer passing an instance of "compatible enough" source serializer.

BeanSerializerback to summary
protected BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter)

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

BeanSerializerback to summary
protected BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter, Object filterId)

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

BeanSerializerback to summary
protected BeanSerializer(BeanSerializerBase src, Set<String> toIgnore, Set<String> toInclude)

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

BeanSerializerback to summary
protected BeanSerializer(BeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Method Detail

asArraySerializerback to summary
protected BeanSerializerBase asArraySerializer()

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.asArraySerializer.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Implementation has to check whether as-array serialization is possible reliably; if (and only if) so, will construct a BeanAsArraySerializer, otherwise will return this serializer as is.

Annotations
@Override
createDummyback to summary
public static BeanSerializer createDummy(JavaType forType)

Deprecated

Since 2.10

Annotations
@Deprecated
createDummyback to summary
public static BeanSerializer createDummy(JavaType forType, BeanSerializerBuilder builder)

References Deprecated

BeanSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Method for constructing dummy bean serializer; one that never outputs any properties

Since
2.10
serializeback to summary
public void serialize(Object bean, JsonGenerator gen, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serialize.

Main serialization method that will delegate actual output to configured BeanPropertyWriter instances.

Parameters
bean:Object

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

Value to serialize; can not be null.

gen:JsonGenerator

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

Generator used to output resulting Json content

provider:SerializerProvider

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

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

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
unwrappingSerializerback to summary
public JsonSerializer<Object> unwrappingSerializer(NameTransformer unwrapper)

Overrides com.fasterxml.jackson.databind.JsonSerializer.unwrappingSerializer.

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

Method that will return serializer instance that produces "unwrapped" serialization, if applicable for type being serialized (which is the case for some serializers that produce JSON Objects as output). If no unwrapped serializer can be constructed, will simply return serializer as-is.

Default implementation just returns serializer as-is, indicating that no unwrapped variant exists

Parameters
unwrapper:NameTransformer

Name transformation to use to convert between names of unwrapper properties

Annotations
@Override
withByNameInclusionback to summary
protected BeanSerializerBase withByNameInclusion(Set<String> toIgnore, Set<String> toInclude)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withByNameInclusion.

Doc from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withByNameInclusion.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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

Annotations
@Override
withFilterIdback to summary
public BeanSerializerBase withFilterId(Object filterId)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withFilterId.

Doc from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withFilterId.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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

Annotations
@Override
withIgnoredPropertiesback to summary
public JsonSerializer<?> withIgnoredProperties(Set<String> toIgnore)

Overrides com.fasterxml.jackson.databind.JsonSerializer.withIgnoredProperties.

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

Mutant factory method called to create a new instance after excluding specified set of properties by name, if there is any.

Parameters
toIgnore:Set<String>

Set of property names to ignore for serialization;

Returns:JsonSerializer<?>

Serializer instance that without specified set of properties to ignore (if any)

Annotations
@Override
withObjectIdWriterback to summary
public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withObjectIdWriter.

Doc from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withObjectIdWriter.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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

Annotations
@Override
withPropertiesback to summary
protected BeanSerializerBase withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withProperties.

Doc from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withProperties.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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)

Annotations
@Override