Class UnwrappingBeanSerializer
- 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.impl.UnwrappingBeanSerializer
-
- All Implemented Interfaces:
JsonFormatVisitable,SchemaAware,ContextualSerializer,ResolvableSerializer,Serializable
public class UnwrappingBeanSerializer extends BeanSerializerBase implements Serializable
- 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 NameTransformer_nameTransformerTransformer used to add prefix and/or suffix for properties of unwrapped POJO.-
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 UnwrappingBeanSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter)UnwrappingBeanSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter, Object filterId)protectedUnwrappingBeanSerializer(UnwrappingBeanSerializer src, Set<String> toIgnore)UnwrappingBeanSerializer(BeanSerializerBase src, NameTransformer transformer)Constructor used for creating unwrapping instance of a standardBeanSerializer
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected BeanSerializerBaseasArraySerializer()JSON Array output cannot be done if unwrapping operation is requested; so implementation will simply return 'this'.booleanisUnwrappingSerializer()Accessor for checking whether this serializer is an "unwrapping" serializer; this is necessary to know since it may also require caller to suppress writing of the leading property name.voidserialize(Object bean, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider)Main serialization method that will delegate actual output to configuredBeanPropertyWriterinstances.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.StringtoString()JsonSerializer<Object>unwrappingSerializer(NameTransformer transformer)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, 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, 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
-
-
-
-
Field Detail
-
_nameTransformer
protected final NameTransformer _nameTransformer
Transformer used to add prefix and/or suffix for properties of unwrapped POJO.
-
-
Constructor Detail
-
UnwrappingBeanSerializer
public UnwrappingBeanSerializer(BeanSerializerBase src, NameTransformer transformer)
Constructor used for creating unwrapping instance of a standardBeanSerializer
-
UnwrappingBeanSerializer
public UnwrappingBeanSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter)
-
UnwrappingBeanSerializer
public UnwrappingBeanSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter, Object filterId)
-
UnwrappingBeanSerializer
protected UnwrappingBeanSerializer(UnwrappingBeanSerializer src, Set<String> toIgnore)
-
-
Method Detail
-
unwrappingSerializer
public JsonSerializer<Object> unwrappingSerializer(NameTransformer transformer)
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:
transformer- Name transformation to use to convert between names of unwrapper properties
-
isUnwrappingSerializer
public boolean isUnwrappingSerializer()
Description copied from class:JsonSerializerAccessor for checking whether this serializer is an "unwrapping" serializer; this is necessary to know since it may also require caller to suppress writing of the leading property name.- Overrides:
isUnwrappingSerializerin classJsonSerializer<Object>
-
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()
JSON Array output cannot be done if unwrapping operation is requested; so implementation will simply return 'this'.- 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
-
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 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.typeSer- Type serializer to use for including type information- Throws:
IOException
-
-