Jackson 3.0.1 · tools.jackson.databind.ser.BeanPropertyWriter

Modifier and Type	Class and Description
pack-priv class	BeanPropertyWriter.GetterHolder

Field Summary

Modifier and Type	Field and Description
protected final BeanPropertyWriter.GetterHolder	_accessor Accessor method used to get property value.
protected final JavaType	_cfgSerializationType Type to use for locating serializer; normally same as return type of the accessor method, but may be overridden by annotations.
protected final transient Annotations	_contextAnnotations Annotations from context (most often, class that declares property, or in case of sub-class serializer, from that sub-class) Note transient just to support JDK serializability; Annotations do not serialize.
protected final JavaType	_declaredType Type property is declared to have, either in class definition or associated annotations.
protected transient PropertySerializerMap	_dynamicSerializers In case serializer is not known statically (i.e. `_serializer` is null), we will use a lookup structure for storing dynamically resolved mapping from type(s) to serializer(s).
protected final Class<?>[]	_includeInViews Alternate set of property writers used when view-based filtering is available for the Bean.
protected transient HashMap<Object, Object>	_internalSettings
protected final AnnotatedMember	_member Member (field, method) that represents property and allows access to associated annotations.
protected final SerializedString	_name Logical name of the property; will be used as the field name under which value for the property is written.
protected JavaType	_nonTrivialBaseType Base type of the property, if the declared type is "non-trivial"; meaning it is either a structured type (collection, map, array), or parameterized.
protected ValueSerializer<Object>	_nullSerializer Serializer used for writing out null values, if any: if null, null values are to be suppressed.
protected ValueSerializer<Object>	_serializer Serializer to use for writing out the value: null if it cannot be known statically; non-null if it can.
protected final Object	_suppressableValue Value that is considered default value of the property; used for default-value-suppression if enabled.
protected final boolean	_suppressNulls Whether null values are to be suppressed (nothing written out if value is null) or not.
protected TypeSerializer	_typeSerializer If property being serialized needs type information to be included this is the type serializer to use.
protected final PropertyName	_wrapperName Wrapper name to use for this element, if any
public static final Object	MARKER_FOR_EMPTY Marker object used to indicate "do not serialize if empty"

Constructor Summary

Access	Constructor and Description
public	BeanPropertyWriter(BeanPropertyDefinition propDef, AnnotatedMember member, Annotations contextAnnotations, JavaType declaredType, ValueSerializer<?> ser, TypeSerializer typeSer, JavaType serType, boolean suppressNulls, Object suppressableValue, Class<?>[] includeInViews)
protected	BeanPropertyWriter() Constructor that may be of use to virtual properties, when there is need for the zero-arg ("default") constructor, and actual initialization is done after constructor call.
protected	BeanPropertyWriter(BeanPropertyWriter base) "Copy constructor" to be used by filtering sub-classes
protected	BeanPropertyWriter(BeanPropertyWriter base, PropertyName name)
protected	BeanPropertyWriter(BeanPropertyWriter base, SerializedString name)

Method Summary

Modifier and Type	Method and Description
protected void	_depositSchemaProperty(ObjectNode propertiesNode, JsonNode schemaNode)
protected ValueSerializer<Object>	_findAndAddDynamic(PropertySerializerMap map, Class<?> rawType, SerializationContext provider)
protected boolean	Returns: True if method fully handled self-referential value; false if not (caller is to handle it) or `DatabindException` if there is no way handle it _handleSelfReference(Object bean, JsonGenerator g, SerializationContext ctxt, ValueSerializer<?> ser) Method called to handle a direct self-reference through this property.
private boolean	_isThrowableFieldCause(SerializationContext ctxt, Object bean)
protected BeanPropertyWriter	_new(PropertyName newName) Overridable factory method used by sub-classes
public void	assignNullSerializer(ValueSerializer<Object> nullSer) Method called to assign null value serializer for property
public void	assignSerializer(ValueSerializer<Object> ser) Method called to assign value serializer for property
public void	assignTypeSerializer(TypeSerializer typeSer) Method called to set, reset or clear the configured type serializer for property.
public void	depositSchemaProperty(JsonObjectFormatVisitor v, SerializationContext provider) Implements abstract tools.jackson.databind.ser.PropertyWriter.depositSchemaProperty. Implements tools.jackson.databind.BeanProperty.depositSchemaProperty. Traversal method used for things like JSON Schema generation, or POJO introspection.
public void	fixAccess(SerializationConfig config) Method called to ensure that the mutator has proper access rights to be called, as per configuration.
public final Object	get(Object bean) Method that can be used to access value of the property this Object describes, from given bean instance.
public <A extends Annotation> A	getAnnotation(Class<A> acls) Implements abstract tools.jackson.databind.ser.PropertyWriter.getAnnotation. Implements tools.jackson.databind.BeanProperty.getAnnotation. Method for accessing annotations directly declared for property that this writer is associated with.
public <A extends Annotation> A	getContextAnnotation(Class<A> acls) Implements abstract tools.jackson.databind.ser.PropertyWriter.getContextAnnotation. Implements tools.jackson.databind.BeanProperty.getContextAnnotation. 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.
public PropertyName	getFullName() Implements abstract tools.jackson.databind.ser.PropertyWriter.getFullName. Implements tools.jackson.databind.util.FullyNamed.getFullName.
public Object	Returns: Value of the setting, if any; null if none. getInternalSetting(Object key) Method for accessing value of specified internal setting.
public AnnotatedMember	getMember() Implements tools.jackson.databind.BeanProperty.getMember. Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
public String	getName() Implements abstract tools.jackson.databind.ser.PropertyWriter.getName. Implements tools.jackson.core.util.Named.getName.
public JavaType	getSerializationType()
public SerializableString	getSerializedName()
public ValueSerializer<Object>	getSerializer()
public JavaType	getType() Implements tools.jackson.databind.BeanProperty.getType. Method to get declared type of the property.
public TypeSerializer	getTypeSerializer()
public Class<?>[]	getViews()
public PropertyName	getWrapperName() Implements tools.jackson.databind.BeanProperty.getWrapperName. If property is indicated to be wrapped, name of wrapper element to use.
public boolean	hasNullSerializer()
public boolean	hasSerializer()
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).
public Object	Returns: Existing value of the setting, if any (null if none) removeInternalSetting(Object key) Method for removing entry for specified internal setting.
public BeanPropertyWriter	rename(NameTransformer transformer)
public void	serializeAsElement(Object bean, JsonGenerator g, SerializationContext ctxt) Implements abstract tools.jackson.databind.ser.PropertyWriter.serializeAsElement. Alternative to `serializeAsProperty` that is used when a POJO is serialized as JSON Array (usually when "Shape" is forced as 'Array'): the difference is that no property names are written.
public void	serializeAsOmittedElement(Object bean, JsonGenerator g, SerializationContext prov) Implements abstract tools.jackson.databind.ser.PropertyWriter.serializeAsOmittedElement. 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.
public void	serializeAsOmittedProperty(Object bean, JsonGenerator g, SerializationContext ctxt) Implements abstract tools.jackson.databind.ser.PropertyWriter.serializeAsOmittedProperty. 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.
public void	serializeAsProperty(Object bean, JsonGenerator g, SerializationContext ctxt) Implements abstract tools.jackson.databind.ser.PropertyWriter.serializeAsProperty. 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.
public Object	Returns: Old value of the setting, if any (null if none) setInternalSetting(Object key, Object value) Method for setting specific internal setting to given value
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
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public BeanPropertyWriter	unwrappingWriter(NameTransformer unwrapper) Method called create an instance that handles details of unwrapping contained value.
public boolean	willSuppressNulls()
public boolean	wouldConflictWithName(PropertyName name) Method called to check to see if this property has a name that would conflict with a given name.

Inherited from tools.jackson.databind.ser.PropertyWriter:: findAnnotation

Field Detail

_accessor	back to summary
protected final BeanPropertyWriter.GetterHolder _accessor Accessor method used to get property value. Wrapped in a holder since MethodHandle is not serializable.

_cfgSerializationType	back to summary
protected final JavaType _cfgSerializationType Type to use for locating serializer; normally same as return type of the accessor method, but may be overridden by annotations.

_contextAnnotations	back to summary
protected final transient Annotations _contextAnnotations Annotations from context (most often, class that declares property, or in case of sub-class serializer, from that sub-class) Note transient just to support JDK serializability; Annotations do not serialize. At all.

_declaredType	back to summary
protected final JavaType _declaredType Type property is declared to have, either in class definition or associated annotations.

_dynamicSerializers	back to summary
protected transient PropertySerializerMap _dynamicSerializers In case serializer is not known statically (i.e. `_serializer` is null), we will use a lookup structure for storing dynamically resolved mapping from type(s) to serializer(s).

_includeInViews	back to summary
protected final Class<?>[] _includeInViews Alternate set of property writers used when view-based filtering is available for the Bean.

_internalSettings	back to summary
protected transient HashMap<Object, Object> _internalSettings

_member	back to summary
protected final AnnotatedMember _member Member (field, method) that represents property and allows access to associated annotations.

_name	back to summary
protected final SerializedString _name Logical name of the property; will be used as the field name under which value for the property is written. Note do NOT change name of this field; it is accessed by Afterburner module (until 2.4; not directly from 2.5) ALSO NOTE: ... and while it really ought to be `SerializableString`, changing that is also binary-incompatible change. So nope.

_nonTrivialBaseType	back to summary
protected JavaType _nonTrivialBaseType Base type of the property, if the declared type is "non-trivial"; meaning it is either a structured type (collection, map, array), or parameterized. Used to retain type information about contained type, which is mostly necessary if type meta-data is to be included.

_nullSerializer	back to summary
protected ValueSerializer<Object> _nullSerializer Serializer used for writing out null values, if any: if null, null values are to be suppressed.

_serializer	back to summary
protected ValueSerializer<Object> _serializer Serializer to use for writing out the value: null if it cannot be known statically; non-null if it can.

_suppressableValue	back to summary
protected final Object _suppressableValue Value that is considered default value of the property; used for default-value-suppression if enabled.

_suppressNulls	back to summary
protected final boolean _suppressNulls Whether null values are to be suppressed (nothing written out if value is null) or not. Note that this is a configuration value during construction, and actual handling relies on setting (or not) of `_nullSerializer`.

_typeSerializer	back to summary
protected TypeSerializer _typeSerializer If property being serialized needs type information to be included this is the type serializer to use. Declared type (possibly augmented with annotations) of property is used for determining exact mechanism to use (compared to actual runtime type used for serializing actual state).

_wrapperName	back to summary
protected final PropertyName _wrapperName Wrapper name to use for this element, if any

MARKER_FOR_EMPTY	back to summary
public static final Object MARKER_FOR_EMPTY Marker object used to indicate "do not serialize if empty"

Constructor Detail

BeanPropertyWriter	back to summary
public BeanPropertyWriter(BeanPropertyDefinition propDef, AnnotatedMember member, Annotations contextAnnotations, JavaType declaredType, ValueSerializer<?> ser, TypeSerializer typeSer, JavaType serType, boolean suppressNulls, Object suppressableValue, Class<?>[] includeInViews) Annotations @SuppressWarnings:unchecked

BeanPropertyWriter	back to summary
protected BeanPropertyWriter() Constructor that may be of use to virtual properties, when there is need for the zero-arg ("default") constructor, and actual initialization is done after constructor call.

BeanPropertyWriter	back to summary
protected BeanPropertyWriter(BeanPropertyWriter base) "Copy constructor" to be used by filtering sub-classes

BeanPropertyWriter	back to summary
protected BeanPropertyWriter(BeanPropertyWriter base, PropertyName name)

BeanPropertyWriter	back to summary
protected BeanPropertyWriter(BeanPropertyWriter base, SerializedString name)

Method Detail

_depositSchemaProperty	back to summary
protected void _depositSchemaProperty(ObjectNode propertiesNode, JsonNode schemaNode)

_findAndAddDynamic	back to summary
protected ValueSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, Class<?> rawType, SerializationContext provider)

_handleSelfReference back to summary

_handleSelfReference	back to summary
protected boolean _handleSelfReference(Object bean, JsonGenerator g, SerializationContext ctxt, ValueSerializer<?> ser) throws JacksonException Method called to handle a direct self-reference through this property. Method can choose to indicate an error by throwing `DatabindException`; fully handle serialization (and return true); or indicate that it should be serialized normally (return false). Default implementation will throw `DatabindException` if `SerializationFeature#FAIL_ON_SELF_REFERENCES` is enabled; or return `false` if it is disabled. Returns:boolean True if method fully handled self-referential value; false if not (caller is to handle it) or `DatabindException` if there is no way handle it

protected boolean _handleSelfReference(Object bean, JsonGenerator g, SerializationContext ctxt, ValueSerializer<?> ser) throws JacksonException

Method called to handle a direct self-reference through this property. Method can choose to indicate an error by throwing DatabindException; fully handle serialization (and return true); or indicate that it should be serialized normally (return false).

Default implementation will throw DatabindException if SerializationFeature#FAIL_ON_SELF_REFERENCES is enabled; or return false if it is disabled.

Returns:boolean: True if method fully handled self-referential value; false if not (caller is to handle it) or DatabindException if there is no way handle it

_isThrowableFieldCause	back to summary
private boolean _isThrowableFieldCause(SerializationContext ctxt, Object bean)

_new	back to summary
protected BeanPropertyWriter _new(PropertyName newName) Overridable factory method used by sub-classes

assignNullSerializer	back to summary
public void assignNullSerializer(ValueSerializer<Object> nullSer) Method called to assign null value serializer for property

assignSerializer	back to summary
public void assignSerializer(ValueSerializer<Object> ser) Method called to assign value serializer for property

assignTypeSerializer	back to summary
public void assignTypeSerializer(TypeSerializer typeSer) Method called to set, reset or clear the configured type serializer for property.

depositSchemaProperty	back to summary
public void depositSchemaProperty(JsonObjectFormatVisitor v, SerializationContext provider) Implements abstract tools.jackson.databind.ser.PropertyWriter.depositSchemaProperty. Implements tools.jackson.databind.BeanProperty.depositSchemaProperty. Doc from tools.jackson.databind.ser.PropertyWriter.depositSchemaProperty. Traversal method used for things like JSON Schema generation, or POJO introspection. Annotations @Override

depositSchemaProperty

public Class BeanPropertyWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class BeanPropertyWriter.GetterHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail