Module tools.jackson.dataformat.xml

Package tools.jackson.dataformat.xml.ser

Class XmlBeanPropertyWriter

java.lang.Object

tools.jackson.databind.introspect.ConcreteBeanPropertyBase

tools.jackson.databind.ser.PropertyWriter

tools.jackson.databind.ser.BeanPropertyWriter

tools.jackson.dataformat.xml.ser.XmlBeanPropertyWriter

All Implemented Interfaces:

tools.jackson.core.util.Named, tools.jackson.databind.BeanProperty, tools.jackson.databind.util.FullyNamed

public class XmlBeanPropertyWriter
extends tools.jackson.databind.ser.BeanPropertyWriter

Property writer sub-class used for handling element wrapping needed for serializing collection (array, Collection; not Map) types.

Nested Class Summary

Nested classes/interfaces inherited from interface tools.jackson.databind.BeanProperty

tools.jackson.databind.BeanProperty.Bogus, tools.jackson.databind.BeanProperty.Std

Nested classes/interfaces inherited from interface tools.jackson.core.util.Named

tools.jackson.core.util.Named.StringAsNamed

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	_dynamicWrapping	Whether wrapping should be checked dynamically based on the runtime value type.
protected final QName	_wrappedQName	Element name used for items in the collection
protected final QName	_wrapperQName	Element name used as wrapper for collection.

Fields inherited from class tools.jackson.databind.ser.BeanPropertyWriter

_accessor, _applyView, _cfgSerializationType, _contextAnnotations, _declaredType, _dynamicSerializers, _includeInViews, _inclusion, _internalSettings, _member, _name, _nonTrivialBaseType, _nullSerializer, _serializer, _suppressableValue, _suppressNulls, _typeSerializer, _wrapperName, MARKER_FOR_EMPTY

Fields inherited from class tools.jackson.databind.introspect.ConcreteBeanPropertyBase

_aliases, _metadata

Fields inherited from interface tools.jackson.databind.BeanProperty

EMPTY_FORMAT, EMPTY_INCLUDE

Constructor Summary

Constructors

Constructor	Description
XmlBeanPropertyWriter(tools.jackson.databind.ser.BeanPropertyWriter wrapped, tools.jackson.databind.PropertyName wrapperName, tools.jackson.databind.PropertyName wrappedName)	Deprecated. Since 3.2
XmlBeanPropertyWriter(tools.jackson.databind.ser.BeanPropertyWriter wrapped, tools.jackson.databind.PropertyName wrapperName, tools.jackson.databind.PropertyName wrappedName, boolean dynamicWrapping)
XmlBeanPropertyWriter(tools.jackson.databind.ser.BeanPropertyWriter wrapped, tools.jackson.databind.PropertyName wrapperName, tools.jackson.databind.PropertyName wrappedName, tools.jackson.databind.ValueSerializer<Object> serializer)	Deprecated. Since 3.2

Method Summary

Modifier and Type	Method	Description
void	serializeAsProperty(Object bean, tools.jackson.core.JsonGenerator g, tools.jackson.databind.SerializationContext ctxt)	Overridden version so that we can wrap output within wrapper element if and as necessary.

Methods inherited from class tools.jackson.databind.ser.BeanPropertyWriter

_depositSchemaProperty, _findAndAddDynamic, _handleSelfReference, _new, assignNullSerializer, assignSerializer, assignTypeSerializer, depositSchemaProperty, findPropertyInclusion, fixAccess, get, getAnnotation, getContextAnnotation, getFullName, getInternalSetting, getMember, getName, getSerializationType, getSerializedName, getSerializer, getType, getTypeSerializer, getViews, getWrapperName, hasNullSerializer, hasSerializer, isUnwrapping, removeInternalSetting, rename, serializeAsElement, serializeAsOmittedElement, serializeAsOmittedProperty, setInternalSetting, setNonTrivialBaseType, toString, unwrappingWriter, willSuppressNulls, wouldConflictWithName

Methods inherited from class tools.jackson.databind.ser.PropertyWriter

findAnnotation

Methods inherited from class tools.jackson.databind.introspect.ConcreteBeanPropertyBase

findAliases, findFormatOverrides, findPropertyFormat, getMetadata, isRequired, isVirtual

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface tools.jackson.databind.util.FullyNamed

hasName

Field Details

_wrapperQName

protected final QName _wrapperQName

Element name used as wrapper for collection.

_wrappedQName

protected final QName _wrappedQName

Element name used for items in the collection

_dynamicWrapping

protected final boolean _dynamicWrapping

Whether wrapping should be checked dynamically based on the runtime value type. When true, wrapping is only applied if the runtime value is actually a Collection, Iterable, or array. Used for properties declared as Object that may or may not contain a collection at runtime.

Since:

3.2

Constructor Details

XmlBeanPropertyWriter

@Deprecated
public XmlBeanPropertyWriter(tools.jackson.databind.ser.BeanPropertyWriter wrapped,
 tools.jackson.databind.PropertyName wrapperName,
 tools.jackson.databind.PropertyName wrappedName)

Deprecated.

Since 3.2

XmlBeanPropertyWriter

@Deprecated
public XmlBeanPropertyWriter(tools.jackson.databind.ser.BeanPropertyWriter wrapped,
 tools.jackson.databind.PropertyName wrapperName,
 tools.jackson.databind.PropertyName wrappedName,
 tools.jackson.databind.ValueSerializer<Object> serializer)

Deprecated.

Since 3.2

XmlBeanPropertyWriter

public XmlBeanPropertyWriter(tools.jackson.databind.ser.BeanPropertyWriter wrapped,
 tools.jackson.databind.PropertyName wrapperName,
 tools.jackson.databind.PropertyName wrappedName,
 boolean dynamicWrapping)

Since:

3.2

Method Details

serializeAsProperty

public void serializeAsProperty(Object bean,
 tools.jackson.core.JsonGenerator g,
 tools.jackson.databind.SerializationContext ctxt)
                         throws Exception

Overridden version so that we can wrap output within wrapper element if and as necessary.

Overrides:

serializeAsProperty in class tools.jackson.databind.ser.BeanPropertyWriter

Throws:

Exception