Class BeanSerializer
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.StdSerializer<Object>
-
- com.fasterxml.jackson.databind.ser.std.BeanSerializerBase
-
- com.fasterxml.jackson.databind.ser.BeanSerializer
-
- All Implemented Interfaces:
JsonFormatVisitable,SchemaAware,ContextualSerializer,ResolvableSerializer,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 ofBeanPropertyWriters 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)protectedBeanSerializer(BeanSerializerBase src)Alternate copy constructor that can be used to construct standardBeanSerializerpassing an instance of "compatible enough" source serializer.protectedBeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter)protectedBeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter, Object filterId)protectedBeanSerializer(BeanSerializerBase src, Set<String> toIgnore)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected BeanSerializerBaseasArraySerializer()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 BeanSerializercreateDummy(JavaType forType)Deprecated.Since 2.10static BeanSerializercreateDummy(JavaType forType, BeanSerializerBuilder builder)Method for constructing dummy bean serializer; one that never outputs any propertiesvoidserialize(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider)Main serialization method that will delegate actual output to configuredBeanPropertyWriterinstances.StringtoString()JsonSerializer<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).BeanSerializerBasewithFilterId(Object filterId)Mutant factory used for creating a new instance with different filter id (used withJsonFilterannotation)protected BeanSerializerBasewithIgnorals(Set<String> toIgnore)Mutant factory used for creating a new instance with additional set of properties to ignore (from properties this instance otherwise has)BeanSerializerBasewithObjectIdWriter(ObjectIdWriter objectIdWriter)Mutant factory used for creating a new instance with differentObjectIdWriter.-
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
-
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 standardBeanSerializerpassing an instance of "compatible enough" source serializer.
-
BeanSerializer
protected BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter)
-
BeanSerializer
protected BeanSerializer(BeanSerializerBase src, ObjectIdWriter objectIdWriter, Object filterId)
-
BeanSerializer
protected BeanSerializer(BeanSerializerBase src, Set<String> toIgnore)
-
-
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<Object> unwrappingSerializer(NameTransformer unwrapper)
Description copied from class:JsonSerializerMethod 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:
unwrappingSerializerin classJsonSerializer<Object>- Parameters:
unwrapper- Name transformation to use to convert between names of unwrapper properties
-
withObjectIdWriter
public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)
Description copied from class:BeanSerializerBaseMutant factory used for creating a new instance with differentObjectIdWriter.- Specified by:
withObjectIdWriterin classBeanSerializerBase
-
withFilterId
public BeanSerializerBase withFilterId(Object filterId)
Description copied from class:BeanSerializerBaseMutant factory used for creating a new instance with different filter id (used withJsonFilterannotation)- Specified by:
withFilterIdin classBeanSerializerBase
-
withIgnorals
protected BeanSerializerBase withIgnorals(Set<String> toIgnore)
Description copied from class:BeanSerializerBaseMutant factory used for creating a new instance with additional set of properties to ignore (from properties this instance otherwise has)- Specified by:
withIgnoralsin 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:
asArraySerializerin classBeanSerializerBase
-
serialize
public final void serialize(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws IOException
Main serialization method that will delegate actual output to configuredBeanPropertyWriterinstances.- Specified by:
serializein 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:
IOException
-
-