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 Description protected AnyGetterWriter_anyGetterWriterHandler forJsonAnyGetterannotated propertiesprotected JavaType_beanTypeprotected BeanPropertyWriter[]_filteredPropsOptional filters used to suppress output of properties that are only to be included in certain viewsprotected ObjectIdWriter_objectIdWriterIf 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_propertyFilterIdId of the bean property filter to use, if any; null if none.protected BeanPropertyWriter[]_propsWriters used for outputting actual property valuesprotected com.fasterxml.jackson.annotation.JsonFormat.Shape_serializationShapeRequested shape from bean class annotations.protected AnnotatedMember_typeIdIf using custom type ids (usually via getter, or field), this is the reference to that member.protected static PropertyNameNAME_FOR_OBJECT_REFprotected static BeanPropertyWriter[]NO_PROPS-
Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedBeanSerializerBase(JavaType type, BeanSerializerBuilder builder, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)Constructor used byBeanSerializerBuilderto create an instanceprotectedBeanSerializerBase(BeanSerializerBase src)Copy-constructor that is useful for sub-classes that just want to copy all super-class properties without modifications.BeanSerializerBase(BeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)protectedBeanSerializerBase(BeanSerializerBase src, ObjectIdWriter objectIdWriter)protectedBeanSerializerBase(BeanSerializerBase src, ObjectIdWriter objectIdWriter, Object filterId)protectedBeanSerializerBase(BeanSerializerBase src, NameTransformer unwrapper)Copy-constructor that will also rename properties with given prefix (if it's non-empty)protectedBeanSerializerBase(BeanSerializerBase src, String[] toIgnore)Deprecated.protectedBeanSerializerBase(BeanSerializerBase src, Set<String> toIgnore)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected String_customTypeId(Object bean)Deprecated.protected void_serializeObjectId(Object bean, com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer, WritableObjectId objectId)protected void_serializeWithObjectId(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, boolean startEndObject)protected void_serializeWithObjectId(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer)protected com.fasterxml.jackson.core.type.WritableTypeId_typeIdDef(TypeSerializer typeSer, Object bean, com.fasterxml.jackson.core.JsonToken valueShape)voidacceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)Default implementation specifies no format.protected abstract BeanSerializerBaseasArraySerializer()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).JsonNodegetSchema(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.voidresolve(SerializerProvider provider)We need to implementResolvableSerializerto be able to properly handle cyclic type references.abstract voidserialize(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider)Method that can be called to ask implementation to serialize values of type this serializer handles.protected voidserializeFields(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider)protected voidserializeFieldsFiltered(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider)Alternative serialization method that gets called when there is aPropertyFilterthat needs to be called to determine which properties are to be serialized (and possibly how)voidserializeWithType(Object bean, com.fasterxml.jackson.core.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.booleanusesObjectId()Method that can be called to see whether this serializer instance will use Object Id to handle cyclic references.abstract BeanSerializerBasewithFilterId(Object filterId)Mutant factory used for creating a new instance with different filter id (used withJsonFilterannotation)protected BeanSerializerBasewithIgnorals(String[] toIgnore)Deprecated.since 2.8protected abstract 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)abstract BeanSerializerBasewithObjectIdWriter(ObjectIdWriter objectIdWriter)Mutant factory used for creating a new instance with differentObjectIdWriter.-
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 forJsonAnyGetterannotated 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 com.fasterxml.jackson.annotation.JsonFormat.Shape _serializationShape
Requested shape from bean class annotations.
-
-
Constructor Detail
-
BeanSerializerBase
protected BeanSerializerBase(JavaType type, BeanSerializerBuilder builder, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
Constructor used byBeanSerializerBuilderto create an instance- Parameters:
type- Nominal type of values handled by this serializerbuilder- Builder for accessing other collected information
-
BeanSerializerBase
public 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
protected BeanSerializerBase(BeanSerializerBase src, Set<String> toIgnore)
-
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 differentObjectIdWriter.- Since:
- 2.0
-
withIgnorals
protected abstract BeanSerializerBase withIgnorals(Set<String> toIgnore)
Mutant factory used for creating a new instance with additional set of properties to ignore (from properties this instance otherwise has)- Since:
- 2.8
-
withIgnorals
@Deprecated protected BeanSerializerBase withIgnorals(String[] toIgnore)
Deprecated.since 2.8Mutant 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 withJsonFilterannotation)- Overrides:
withFilterIdin classJsonSerializer<Object>- Since:
- 2.3
-
resolve
public void resolve(SerializerProvider provider) throws JsonMappingException
We need to implementResolvableSerializerto be able to properly handle cyclic type references.- Specified by:
resolvein interfaceResolvableSerializer- 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:ContextualSerializerMethod 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:
createContextualin interfaceContextualSerializer- Parameters:
provider- Serializer provider to use for accessing config, other serializersproperty- 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:JsonSerializerAccessor for iterating over logical properties that the type handled by this serializer has, from serialization perspective. Actual type of properties, if any, will beBeanPropertyWriter. Of standard Jackson serializers, onlyBeanSerializerexposes properties.- Overrides:
propertiesin classJsonSerializer<Object>
-
usesObjectId
public boolean usesObjectId()
Description copied from class:JsonSerializerMethod that can be called to see whether this serializer instance will use Object Id to handle cyclic references.- Overrides:
usesObjectIdin classJsonSerializer<Object>
-
serialize
public abstract void serialize(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws IOException
Description copied from class:JsonSerializerMethod that can be called to ask implementation to serialize values of type this serializer handles.- Specified by:
serializein classStdSerializer<Object>- 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
-
serializeWithType
public void serializeWithType(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOException
Description copied from class:JsonSerializerMethod 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
UnsupportedOperationExceptionto 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, asSTART-ARRAY/END-ARRAYandSTART-OBJECT/END-OBJECTpairs need to be properly handled with respect to serializing of contents.- Overrides:
serializeWithTypein classJsonSerializer<Object>- 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.typeSer- Type serializer to use for including type information- Throws:
IOException
-
_serializeWithObjectId
protected final void _serializeWithObjectId(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, boolean startEndObject) throws IOException
- Throws:
IOException
-
_serializeWithObjectId
protected final void _serializeWithObjectId(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOException
- Throws:
IOException
-
_serializeObjectId
protected void _serializeObjectId(Object bean, com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer, WritableObjectId objectId) throws IOException
- Throws:
IOException
-
_typeIdDef
protected final com.fasterxml.jackson.core.type.WritableTypeId _typeIdDef(TypeSerializer typeSer, Object bean, com.fasterxml.jackson.core.JsonToken valueShape)
- Since:
- 2.9
-
_customTypeId
@Deprecated protected final String _customTypeId(Object bean)
Deprecated.
-
serializeFields
protected void serializeFields(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws IOException
- Throws:
IOException
-
serializeFieldsFiltered
protected void serializeFieldsFiltered(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws IOException, com.fasterxml.jackson.core.JsonGenerationException
Alternative serialization method that gets called when there is aPropertyFilterthat needs to be called to determine which properties are to be serialized (and possibly how)- Throws:
IOExceptioncom.fasterxml.jackson.core.JsonGenerationException
-
getSchema
@Deprecated public JsonNode getSchema(SerializerProvider provider, Type typeHint) throws JsonMappingException
Deprecated.Description copied from class:StdSerializerDefault implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchemain interfaceSchemaAware- Overrides:
getSchemain classStdSerializer<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:StdSerializerDefault implementation specifies no format. This behavior is usually overriden by custom serializers.- Specified by:
acceptJsonFormatVisitorin interfaceJsonFormatVisitable- Overrides:
acceptJsonFormatVisitorin classStdSerializer<Object>typeHint- Type of element (entity like property) being visited- Throws:
JsonMappingException
-
-