java.lang.Object
- com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase
- - com.fasterxml.jackson.databind.ser.PropertyWriter
  - - com.fasterxml.jackson.databind.ser.BeanPropertyWriter

All Implemented Interfaces:

BeanProperty, Named, Serializable

Direct Known Subclasses:

UnwrappingBeanPropertyWriter, VirtualBeanPropertyWriter
```
public class BeanPropertyWriter
extends PropertyWriter
implements Serializable
```
Base bean property handler class, which implements common parts of reflection-based functionality for accessing a property value and serializing it.
Note that current design tries to keep instances immutable (semi-functional style); mostly because these instances are exposed to application code and this is to reduce likelihood of data corruption and synchronization issues.

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
Modifier and Type Field Description

static Object MARKER_FOR_EMPTY
Marker object used to indicate "do not serialize if empty"
- Fields inherited from interface com.fasterxml.jackson.databind.BeanProperty
  EMPTY_FORMAT, EMPTY_INCLUDE

Constructor Summary

Constructors
Constructor	Description
`BeanPropertyWriter(BeanPropertyDefinition propDef, AnnotatedMember member, Annotations contextAnnotations, JavaType declaredType, JsonSerializer<?> ser, TypeSerializer typeSer, JavaType serType, boolean suppressNulls, Object suppressableValue)`	Deprecated.
`BeanPropertyWriter(BeanPropertyDefinition propDef, AnnotatedMember member, Annotations contextAnnotations, JavaType declaredType, JsonSerializer<?> ser, TypeSerializer typeSer, JavaType serType, boolean suppressNulls, Object suppressableValue, Class<?>[] includeInViews)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`assignNullSerializer(JsonSerializer<Object> nullSer)`	Method called to assign null value serializer for property
`void`	`assignSerializer(JsonSerializer<Object> ser)`	Method called to assign value serializer for property
`void`	`assignTypeSerializer(TypeSerializer typeSer)`	Method called to set, reset or clear the configured type serializer for property.
`void`	`depositSchemaProperty(JsonObjectFormatVisitor v, SerializerProvider provider)`	Traversal method used for things like JSON Schema generation, or POJO introspection.
`void`	`depositSchemaProperty(ObjectNode propertiesNode, SerializerProvider provider)`	Deprecated.
`void`	`fixAccess(SerializationConfig config)`	Method called to ensure that the mutator has proper access rights to be called, as per configuration.
`Object`	`get(Object bean)`	Method that can be used to access value of the property this Object describes, from given bean instance.
`<A extends Annotation> A`	`getAnnotation(Class<A> acls)`	Method for accessing annotations directly declared for property that this writer is associated with.
`<A extends Annotation> A`	`getContextAnnotation(Class<A> acls)`	Method for accessing annotations declared in context of the property that this writer is associated with; usually this means annotations on enclosing class for property.
`PropertyName`	`getFullName()`	Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
`Type`	`getGenericPropertyType()`	Deprecated. Since 2.7, to be removed from 2.9, use `getType()` instead.
`Object`	`getInternalSetting(Object key)`	Method for accessing value of specified internal setting.
`AnnotatedMember`	`getMember()`	Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
`String`	`getName()`	Method to get logical name of the property
`Class<?>`	`getPropertyType()`	Deprecated. Since 2.7, to be removed from 2.9, use `getType()` instead.
`Class<?>`	`getRawSerializationType()`	Deprecated.
`JavaType`	`getSerializationType()`
`SerializableString`	`getSerializedName()`
`JsonSerializer<Object>`	`getSerializer()`
`JavaType`	`getType()`	Method to get declared type of the property.
`TypeSerializer`	`getTypeSerializer()`
`Class<?>[]`	`getViews()`
`PropertyName`	`getWrapperName()`	If property is indicated to be wrapped, name of wrapper element to use.
`boolean`	`hasNullSerializer()`
`boolean`	`hasSerializer()`
`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).
`Object`	`removeInternalSetting(Object key)`	Method for removing entry for specified internal setting.
`BeanPropertyWriter`	`rename(NameTransformer transformer)`
`void`	`serializeAsElement(Object bean, JsonGenerator gen, SerializerProvider prov)`	Alternative to `serializeAsField(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)` that is used when a POJO is serialized as JSON Array; the difference is that no field names are written.
`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.
`void`	`serializeAsOmittedField(Object bean, JsonGenerator gen, SerializerProvider prov)`	Method called to indicate that serialization of a field was omitted due to filtering, in cases where backend data format does not allow basic omission.
`void`	`serializeAsPlaceholder(Object bean, JsonGenerator gen, SerializerProvider prov)`	Method called to serialize a placeholder used in tabular output when real value is not to be included (is filtered out), but when we need an entry so that field indexes will not be off.
`Object`	`setInternalSetting(Object key, Object value)`	Method for setting specific internal setting to given value
`void`	`setNonTrivialBaseType(JavaType t)`	Method called to define type to consider as "non-trivial" basetype, needed for dynamic serialization resolution for complex (usually container) types
`String`	`toString()`
`BeanPropertyWriter`	`unwrappingWriter(NameTransformer unwrapper)`	Method called create an instance that handles details of unwrapping contained value.
`boolean`	`willSuppressNulls()`
`boolean`	`wouldConflictWithName(PropertyName name)`	Method called to check to see if this property has a name that would conflict with a given name.

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

- Field Detail
  - MARKER_FOR_EMPTY
```
public static final Object MARKER_FOR_EMPTY
```
    Marker object used to indicate "do not serialize if empty"
- Constructor Detail
  - BeanPropertyWriter
```
public BeanPropertyWriter(BeanPropertyDefinition propDef,
                          AnnotatedMember member,
                          Annotations contextAnnotations,
                          JavaType declaredType,
                          JsonSerializer<?> ser,
                          TypeSerializer typeSer,
                          JavaType serType,
                          boolean suppressNulls,
                          Object suppressableValue,
                          Class<?>[] includeInViews)
```
    Since:
    
    2.9 (added `includeInViews` since 2.8)
  - BeanPropertyWriter
```
@Deprecated
public BeanPropertyWriter(BeanPropertyDefinition propDef,
                          AnnotatedMember member,
                          Annotations contextAnnotations,
                          JavaType declaredType,
                          JsonSerializer<?> ser,
                          TypeSerializer typeSer,
                          JavaType serType,
                          boolean suppressNulls,
                          Object suppressableValue)
```
    Deprecated.
- Method Detail
  - rename
```
public BeanPropertyWriter rename(NameTransformer transformer)
```
  - assignTypeSerializer
```
public void assignTypeSerializer(TypeSerializer typeSer)
```
    Method called to set, reset or clear the configured type serializer for property.
    
    Since:
    
    2.6
  - assignSerializer
```
public void assignSerializer(JsonSerializer<Object> ser)
```
    Method called to assign value serializer for property
  - assignNullSerializer
```
public void assignNullSerializer(JsonSerializer<Object> nullSer)
```
    Method called to assign null value serializer for property
  - unwrappingWriter
```
public BeanPropertyWriter unwrappingWriter(NameTransformer unwrapper)
```
    Method called create an instance that handles details of unwrapping contained value.
  - setNonTrivialBaseType
```
public void setNonTrivialBaseType(JavaType t)
```
    Method called to define type to consider as "non-trivial" basetype, needed for dynamic serialization resolution for complex (usually container) types
  - fixAccess
```
public void fixAccess(SerializationConfig config)
```
    Method called to ensure that the mutator has proper access rights to be called, as per configuration. Overridden by implementations that have mutators that require access, fields and setters.
    
    Since:
    
    2.8.3
  - getName
```
public String getName()
```
    Description copied from interface: BeanProperty
    
    Method to get logical name of the property
    
    Specified by:
    
    getName in interface BeanProperty
    
    Specified by:
    
    getName in interface Named
    
    Specified by:
    
    getName in class PropertyWriter
  - getFullName
```
public PropertyName getFullName()
```
    Description copied from interface: BeanProperty
    
    Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
    
    Specified by:
    
    getFullName in interface BeanProperty
    
    Specified by:
    
    getFullName in class PropertyWriter
  - getType
```
public JavaType getType()
```
    Description copied from interface: BeanProperty
    
    Method to get declared type of the property.
    
    Specified by:
    
    getType in interface BeanProperty
  - getWrapperName
```
public PropertyName getWrapperName()
```
    Description copied from interface: BeanProperty
    
    If property is indicated to be wrapped, name of wrapper element to use.
    
    Specified by:
    
    getWrapperName in interface BeanProperty
  - getAnnotation
```
public <A extends Annotation> A getAnnotation(Class<A> acls)
```
    Description copied from class: PropertyWriter
    
    Method for accessing annotations directly declared for property that this writer is associated with.
    
    Specified by:
    
    getAnnotation in interface BeanProperty
    
    Specified by:
    
    getAnnotation in class PropertyWriter
  - getContextAnnotation
```
public <A extends Annotation> A getContextAnnotation(Class<A> acls)
```
    Description copied from class: PropertyWriter
    
    Method for accessing annotations declared in context of the property that this writer is associated with; usually this means annotations on enclosing class for property.
    
    Specified by:
    
    getContextAnnotation in interface BeanProperty
    
    Specified by:
    
    getContextAnnotation in class PropertyWriter
  - getMember
```
public AnnotatedMember getMember()
```
    Description copied from interface: BeanProperty
    
    Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
    
    Specified by:
    
    getMember in interface BeanProperty
  - getInternalSetting
```
public Object getInternalSetting(Object key)
```
    Method for accessing value of specified internal setting.
    
    Returns:
    
    Value of the setting, if any; null if none.
  - setInternalSetting
```
public Object setInternalSetting(Object key,
                                 Object value)
```
    Method for setting specific internal setting to given value
    
    Returns:
    
    Old value of the setting, if any (null if none)
  - removeInternalSetting
```
public Object removeInternalSetting(Object key)
```
    Method for removing entry for specified internal setting.
    
    Returns:
    
    Existing value of the setting, if any (null if none)
  - getSerializedName
```
public SerializableString getSerializedName()
```
  - hasSerializer
```
public boolean hasSerializer()
```
  - hasNullSerializer
```
public boolean hasNullSerializer()
```
  - getTypeSerializer
```
public TypeSerializer getTypeSerializer()
```
    Since:
    
    2.6
  - isUnwrapping
```
public 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).
    Default implementation simply returns false.
    
    Since:
    
    2.3
  - willSuppressNulls
```
public boolean willSuppressNulls()
```
  - wouldConflictWithName
```
public boolean wouldConflictWithName(PropertyName name)
```
    Method called to check to see if this property has a name that would conflict with a given name.
    
    Since:
    
    2.6
  - getSerializer
```
public JsonSerializer<Object> getSerializer()
```
  - getSerializationType
```
public JavaType getSerializationType()
```
  - getRawSerializationType
```
@Deprecated
public Class<?> getRawSerializationType()
```
    Deprecated.
  - getPropertyType
```
@Deprecated
public Class<?> getPropertyType()
```
    Deprecated.
    Since 2.7, to be removed from 2.9, use getType() instead.
  - getGenericPropertyType
```
@Deprecated
public Type getGenericPropertyType()
```
    Deprecated.
    Since 2.7, to be removed from 2.9, use getType() instead.
    
    Get the generic property type of this property writer.
    
    Returns:
    
    The property type, or null if not found.
  - getViews
```
public Class<?>[] getViews()
```
  - serializeAsField
```
public void serializeAsField(Object bean,
                             JsonGenerator gen,
                             SerializerProvider prov)
                      throws Exception
```
    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.
    
    Specified by:
    
    serializeAsField in class PropertyWriter
    
    Throws:
    
    Exception
  - serializeAsOmittedField
```
public void serializeAsOmittedField(Object bean,
                                    JsonGenerator gen,
                                    SerializerProvider prov)
                             throws Exception
```
    Method called to indicate that serialization of a field was omitted due to filtering, in cases where backend data format does not allow basic omission.
    
    Specified by:
    
    serializeAsOmittedField in class PropertyWriter
    
    Throws:
    
    Exception
    
    Since:
    
    2.3
  - serializeAsElement
```
public void serializeAsElement(Object bean,
                               JsonGenerator gen,
                               SerializerProvider prov)
                        throws Exception
```
    Alternative to serializeAsField(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider) that is used when a POJO is serialized as JSON Array; the difference is that no field names are written.
    
    Specified by:
    
    serializeAsElement in class PropertyWriter
    
    Throws:
    
    Exception
    
    Since:
    
    2.3
  - serializeAsPlaceholder
```
public void serializeAsPlaceholder(Object bean,
                                   JsonGenerator gen,
                                   SerializerProvider prov)
                            throws Exception
```
    Method called to serialize a placeholder used in tabular output when real value is not to be included (is filtered out), but when we need an entry so that field indexes will not be off. Typically this should output null or empty String, depending on datatype.
    
    Specified by:
    
    serializeAsPlaceholder in class PropertyWriter
    
    Throws:
    
    Exception
    
    Since:
    
    2.1
  - depositSchemaProperty
```
public void depositSchemaProperty(JsonObjectFormatVisitor v,
                                  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
    
    Specified by:
    
    depositSchemaProperty in class PropertyWriter
    
    Parameters:
    
    v - Visitor to used as the callback handler
    
    Throws:
    
    JsonMappingException
  - depositSchemaProperty
```
@Deprecated
public void depositSchemaProperty(ObjectNode propertiesNode,
                                  SerializerProvider provider)
                           throws JsonMappingException
```
    Deprecated.
    
    Attempt to add the output of the given BeanPropertyWriter in the given ObjectNode. Otherwise, add the default schema JsonNode in place of the writer's output
    
    Specified by:
    
    depositSchemaProperty in class PropertyWriter
    
    Parameters:
    
    propertiesNode - Node which the given property would exist within
    
    provider - Provider that can be used for accessing dynamic aspects of serialization processing
    
    Throws:
    
    JsonMappingException
  - get
```
public final Object get(Object bean)
                 throws Exception
```
    Method that can be used to access value of the property this Object describes, from given bean instance.
    Note: method is final as it should not need to be overridden -- rather, calling method(s) (serializeAsField(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)) should be overridden to change the behavior
    
    Throws:
    
    Exception
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BeanPropertyWriter

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

MARKER_FOR_EMPTY

Constructor Detail

BeanPropertyWriter

BeanPropertyWriter

Method Detail

rename

assignTypeSerializer

assignSerializer

assignNullSerializer

unwrappingWriter

setNonTrivialBaseType

fixAccess

getName

getFullName

getType

getWrapperName

getAnnotation

getContextAnnotation

getMember

getInternalSetting

setInternalSetting

removeInternalSetting

getSerializedName

hasSerializer

hasNullSerializer

getTypeSerializer

isUnwrapping

willSuppressNulls

wouldConflictWithName

getSerializer

getSerializationType

getRawSerializationType

getPropertyType

getGenericPropertyType

getViews

serializeAsField

serializeAsOmittedField

serializeAsElement

serializeAsPlaceholder

depositSchemaProperty

depositSchemaProperty

get

toString