Package com.fasterxml.jackson.databind.ser.impl

Class UnwrappingBeanPropertyWriter

java.lang.Object

com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase

com.fasterxml.jackson.databind.ser.PropertyWriter

com.fasterxml.jackson.databind.ser.BeanPropertyWriter

com.fasterxml.jackson.databind.ser.impl.UnwrappingBeanPropertyWriter

All Implemented Interfaces:

BeanProperty, Named, Serializable

public class UnwrappingBeanPropertyWriter
extends BeanPropertyWriter
implements Serializable

Variant of BeanPropertyWriter which will handle unwrapping of JSON Object (including of properties of Object within surrounding JSON object, and not as sub-object).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.BeanProperty

BeanProperty.Bogus, BeanProperty.Std

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.ser.BeanPropertyWriter

MARKER_FOR_EMPTY

Fields inherited from interface com.fasterxml.jackson.databind.BeanProperty

EMPTY_FORMAT, EMPTY_INCLUDE

Constructor Summary

Constructors

Constructor	Description
UnwrappingBeanPropertyWriter(BeanPropertyWriter base, NameTransformer unwrapper)

Method Summary

Modifier and Type	Method	Description
void	assignSerializer(JsonSerializer<Object> ser)	Method called to assign value serializer for property
void	depositSchemaProperty(JsonObjectFormatVisitor visitor, SerializerProvider provider)	Traversal method used for things like JSON Schema generation, or POJO introspection.
boolean	isUnwrapping()	Accessor that will return true if this bean property has to support "unwrapping"; ability to replace POJO structural wrapping with optional name prefix and/or suffix (or in some cases, just removal of wrapper name).
UnwrappingBeanPropertyWriter	rename(NameTransformer transformer)
void	serializeAsField(Object bean, JsonGenerator gen, SerializerProvider prov)	Method called to access property that this bean stands for, from within given bean, and to serialize it as a JSON Object field using appropriate serializer.

Methods inherited from class com.fasterxml.jackson.databind.ser.BeanPropertyWriter

assignNullSerializer, assignTypeSerializer, depositSchemaProperty, fixAccess, get, getAnnotation, getContextAnnotation, getFullName, getGenericPropertyType, getInternalSetting, getMember, getName, getPropertyType, getRawSerializationType, getSerializationType, getSerializedName, getSerializer, getType, getTypeSerializer, getViews, getWrapperName, hasNullSerializer, hasSerializer, removeInternalSetting, serializeAsElement, serializeAsOmittedField, serializeAsPlaceholder, setInternalSetting, setNonTrivialBaseType, toString, unwrappingWriter, willSuppressNulls, wouldConflictWithName

Methods inherited from class com.fasterxml.jackson.databind.ser.PropertyWriter

findAnnotation

Methods inherited from class com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase

findAliases, findFormatOverrides, findPropertyFormat, findPropertyInclusion, getMetadata, isRequired, isVirtual

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UnwrappingBeanPropertyWriter

public UnwrappingBeanPropertyWriter(BeanPropertyWriter base,
 NameTransformer unwrapper)

Method Details

rename

public UnwrappingBeanPropertyWriter rename(NameTransformer transformer)

Overrides:

rename in class BeanPropertyWriter

isUnwrapping

public boolean isUnwrapping()

Description copied from class: BeanPropertyWriter

Accessor that will return true if this bean property has to support "unwrapping"; ability to replace POJO structural wrapping with optional name prefix and/or suffix (or in some cases, just removal of wrapper name).

Default implementation simply returns false.

Overrides:

isUnwrapping in class BeanPropertyWriter

serializeAsField

public void serializeAsField(Object bean,
 JsonGenerator gen,
 SerializerProvider prov)
                      throws Exception

Description copied from class: BeanPropertyWriter

Method called to access property that this bean stands for, from within given bean, and to serialize it as a JSON Object field using appropriate serializer.

Overrides:

serializeAsField in class BeanPropertyWriter

Throws:

Exception

assignSerializer

public void assignSerializer(JsonSerializer<Object> ser)

Description copied from class: BeanPropertyWriter

Method called to assign value serializer for property

Overrides:

assignSerializer in class BeanPropertyWriter

depositSchemaProperty

public void depositSchemaProperty(JsonObjectFormatVisitor visitor,
 SerializerProvider provider)
                           throws JsonMappingException

Description copied from class: PropertyWriter

Traversal method used for things like JSON Schema generation, or POJO introspection.

Specified by:

depositSchemaProperty in interface BeanProperty

Overrides:

depositSchemaProperty in class BeanPropertyWriter

Parameters:

visitor - Visitor to used as the callback handler

Throws:

JsonMappingException