Class BeanSerializer
- 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
-
- com.fasterxml.jackson.databind.ser.BeanSerializer
-
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,ContextualSerializer
,ResolvableSerializer
,java.io.Serializable
public class BeanSerializer extends BeanSerializerBase
Serializer class that can serialize Java objects that map to JSON Object output. Internally handling is mostly dealt with by a sequence ofBeanPropertyWriter
s 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
BeanSerializerBase.resolve(com.fasterxml.jackson.databind.SerializerProvider)
method, and NOT from constructor; otherwise we could end up with an infinite loop.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer
JsonSerializer.None
-
-
Field Summary
-
Fields inherited from class com.fasterxml.jackson.databind.ser.std.BeanSerializerBase
_anyGetterWriter, _beanType, _filteredProps, _objectIdWriter, _propertyFilterId, _props, _serializationShape, _typeId, NAME_FOR_OBJECT_REF, NO_PROPS
-
Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
-
Constructor Summary
Constructors Modifier Constructor Description BeanSerializer(JavaType type, BeanSerializerBuilder builder, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
protected
BeanSerializer(BeanSerializerBase src)
Alternate copy constructor that can be used to construct standardBeanSerializer
passing an instance of "compatible enough" source serializer.protected
BeanSerializer(BeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
protected
BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter)
protected
BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter, java.lang.Object filterId)
protected
BeanSerializer(BeanSerializerBase src, java.util.Set<java.lang.String> toIgnore, java.util.Set<java.lang.String> toInclude)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected BeanSerializerBase
asArraySerializer()
Implementation has to check whether as-array serialization is possible reliably; if (and only if) so, will construct aBeanAsArraySerializer
, otherwise will return this serializer as is.static BeanSerializer
createDummy(JavaType forType)
Deprecated.Since 2.10static BeanSerializer
createDummy(JavaType forType, BeanSerializerBuilder builder)
Method for constructing dummy bean serializer; one that never outputs any propertiesvoid
serialize(java.lang.Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider)
Main serialization method that will delegate actual output to configuredBeanPropertyWriter
instances.java.lang.String
toString()
JsonSerializer<java.lang.Object>
unwrappingSerializer(NameTransformer unwrapper)
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(java.util.Set<java.lang.String> toIgnore, java.util.Set<java.lang.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)BeanSerializerBase
withFilterId(java.lang.Object filterId)
Mutant factory used for creating a new instance with different filter id (used withJsonFilter
annotation)BeanSerializerBase
withObjectIdWriter(ObjectIdWriter objectIdWriter)
Mutant factory used for creating a new instance with differentObjectIdWriter
.protected 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.BeanSerializerBase
_customTypeId, _serializeObjectId, _serializeWithObjectId, _serializeWithObjectId, _typeIdDef, acceptJsonFormatVisitor, createContextual, findConvertingSerializer, getSchema, properties, resolve, serializeFields, serializeFieldsFiltered, serializeWithType, usesObjectId, withIgnorals, withIgnorals
-
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
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.fasterxml.jackson.databind.jsonschema.SchemaAware
getSchema
-
-
-
-
Constructor Detail
-
BeanSerializer
public BeanSerializer(JavaType type, BeanSerializerBuilder builder, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
- Parameters:
builder
- Builder object that contains collected information that may be needed for serializerproperties
- Property writers used for actual serialization
-
BeanSerializer
protected BeanSerializer(BeanSerializerBase src)
Alternate copy constructor that can be used to construct standardBeanSerializer
passing an instance of "compatible enough" source serializer.
-
BeanSerializer
protected BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter)
-
BeanSerializer
protected BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter, java.lang.Object filterId)
-
BeanSerializer
protected BeanSerializer(BeanSerializerBase src, java.util.Set<java.lang.String> toIgnore, java.util.Set<java.lang.String> toInclude)
-
BeanSerializer
protected BeanSerializer(BeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
-
-
Method Detail
-
createDummy
@Deprecated public static BeanSerializer createDummy(JavaType forType)
Deprecated.Since 2.10
-
createDummy
public static BeanSerializer createDummy(JavaType forType, BeanSerializerBuilder builder)
Method for constructing dummy bean serializer; one that never outputs any properties- Since:
- 2.10
-
unwrappingSerializer
public JsonSerializer<java.lang.Object> unwrappingSerializer(NameTransformer unwrapper)
Description copied from class:JsonSerializer
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
- Overrides:
unwrappingSerializer
in classJsonSerializer<java.lang.Object>
- Parameters:
unwrapper
- Name transformation to use to convert between names of unwrapper properties
-
withObjectIdWriter
public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)
Description copied from class:BeanSerializerBase
Mutant factory used for creating a new instance with differentObjectIdWriter
.- Specified by:
withObjectIdWriter
in classBeanSerializerBase
-
withFilterId
public BeanSerializerBase withFilterId(java.lang.Object filterId)
Description copied from class:BeanSerializerBase
Mutant factory used for creating a new instance with different filter id (used withJsonFilter
annotation)- Specified by:
withFilterId
in classBeanSerializerBase
-
withByNameInclusion
protected BeanSerializerBase withByNameInclusion(java.util.Set<java.lang.String> toIgnore, java.util.Set<java.lang.String> toInclude)
Description copied from class:BeanSerializerBase
Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)- Specified by:
withByNameInclusion
in classBeanSerializerBase
-
withProperties
protected BeanSerializerBase withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
Description copied from class:BeanSerializerBase
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)
- Specified by:
withProperties
in classBeanSerializerBase
-
asArraySerializer
protected BeanSerializerBase asArraySerializer()
Implementation has to check whether as-array serialization is possible reliably; if (and only if) so, will construct aBeanAsArraySerializer
, otherwise will return this serializer as is.- Specified by:
asArraySerializer
in classBeanSerializerBase
-
serialize
public final void serialize(java.lang.Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws java.io.IOException
Main serialization method that will delegate actual output to configuredBeanPropertyWriter
instances.- Specified by:
serialize
in classBeanSerializerBase
- Parameters:
bean
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for serializing Objects value contains, if any.- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-