Top Description Fields Constructors Methods
com.fasterxml.jackson.dataformat.xml.ser

public Class XmlBeanSerializer

extends XmlBeanSerializerBase
Class Inheritance
Imports
java.io.IOException, java.util.Set, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.JsonSerializer, .SerializerProvider, com.fasterxml.jackson.databind.ser.BeanPropertyWriter, .BeanSerializer, com.fasterxml.jackson.databind.ser.impl.BeanAsArraySerializer, .ObjectIdWriter, com.fasterxml.jackson.databind.ser.std.BeanSerializerBase, com.fasterxml.jackson.databind.util.NameTransformer

References Deprecated

XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Variant of BeanSerializer for XML handling.
Author
Pascal Gélinas

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

Inherited from com.fasterxml.jackson.dataformat.xml.ser.XmlBeanSerializerBase:
_attributeCount_cdata_textPropertyIndex_xmlNamesKEY_XML_INFO

Constructor Summary

AccessConstructor and Description
public
XmlBeanSerializer(BeanSerializerBase src)
References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

public
XmlBeanSerializer(XmlBeanSerializerBase src, ObjectIdWriter objectIdWriter, Object filterId)
References Deprecated XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

public
XmlBeanSerializer(XmlBeanSerializerBase src, ObjectIdWriter objectIdWriter)
References Deprecated XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

public
XmlBeanSerializer(XmlBeanSerializerBase src, Set<String> toIgnore, Set<String> toInclude)
References Deprecated XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

protected
XmlBeanSerializer(XmlBeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
References Deprecated XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Method Summary

Modifier and TypeMethod and Description
protected BeanSerializerBase
asArraySerializer()

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.asArraySerializer.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Implementation has to check whether as-array serialization is possible reliably; if (and only if) so, will construct a BeanAsArraySerializer, otherwise will return this serializer as is.

public void
serialize(Object
Value to serialize; can not be null.
bean, JsonGenerator
Generator used to output resulting Json content
g, SerializerProvider
Provider that can be used to get serializers for serializing Objects value contains, if any.
provider)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serialize.

Main serialization method that will delegate actual output to configured BeanPropertyWriter instances.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public JsonSerializer<Object>
unwrappingSerializer(NameTransformer
Name transformation to use to convert between names of unwrapper properties
unwrapper)

Overrides com.fasterxml.jackson.databind.JsonSerializer.unwrappingSerializer.

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).

protected BeanSerializerBase
withByNameInclusion(Set<String> toIgnore, Set<String> toInclude)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withByNameInclusion.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)

public BeanSerializerBase
withFilterId(Object filterId)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withFilterId.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Mutant factory used for creating a new instance with different filter id (used with JsonFilter annotation)

public BeanSerializerBase
withObjectIdWriter(ObjectIdWriter objectIdWriter)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withObjectIdWriter.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Mutant factory used for creating a new instance with different ObjectIdWriter.

protected BeanSerializerBase
withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withProperties.

References Deprecated BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

Mutant factory used for creating a new instance with modified set of properties.

Inherited from com.fasterxml.jackson.dataformat.xml.ser.XmlBeanSerializerBase:
_isAttribute_isCData_orderAttributesFirst_serializeObjectIdserializeFieldsserializeFieldsFilteredserializeWithType

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

Constructor Detail

XmlBeanSerializerback to summary
public XmlBeanSerializer(BeanSerializerBase src)

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

XmlBeanSerializerback to summary
public XmlBeanSerializer(XmlBeanSerializerBase src, ObjectIdWriter objectIdWriter, Object filterId)

References Deprecated

XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

XmlBeanSerializerback to summary
public XmlBeanSerializer(XmlBeanSerializerBase src, ObjectIdWriter objectIdWriter)

References Deprecated

XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

XmlBeanSerializerback to summary
public XmlBeanSerializer(XmlBeanSerializerBase src, Set<String> toIgnore, Set<String> toInclude)

References Deprecated

XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

XmlBeanSerializerback to summary
protected XmlBeanSerializer(XmlBeanSerializerBase src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

References Deprecated

XmlBeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Method Detail

asArraySerializerback to summary
protected BeanSerializerBase asArraySerializer()

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.asArraySerializer.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Implementation has to check whether as-array serialization is possible reliably; if (and only if) so, will construct a BeanAsArraySerializer, otherwise will return this serializer as is.

Annotations
@Override
serializeback to summary
public void serialize(Object bean, JsonGenerator g, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serialize.

Main serialization method that will delegate actual output to configured BeanPropertyWriter instances.

Parameters
bean:Object

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

Value to serialize; can not be null.

g:JsonGenerator

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

Generator used to output resulting Json content

provider:SerializerProvider

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

Provider that can be used to get serializers for serializing Objects value contains, if any.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
unwrappingSerializerback to summary
public JsonSerializer<Object> unwrappingSerializer(NameTransformer unwrapper)

Overrides com.fasterxml.jackson.databind.JsonSerializer.unwrappingSerializer.

Doc from com.fasterxml.jackson.databind.JsonSerializer.unwrappingSerializer.

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). 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

Parameters
unwrapper:NameTransformer

Name transformation to use to convert between names of unwrapper properties

Annotations
@Override
withByNameInclusionback to summary
protected BeanSerializerBase withByNameInclusion(Set<String> toIgnore, Set<String> toInclude)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withByNameInclusion.

Doc from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withByNameInclusion.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)

Annotations
@Override
withFilterIdback to summary
public BeanSerializerBase withFilterId(Object filterId)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withFilterId.

Doc from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withFilterId.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Mutant factory used for creating a new instance with different filter id (used with JsonFilter annotation)

Annotations
@Override
withObjectIdWriterback to summary
public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withObjectIdWriter.

Doc from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withObjectIdWriter.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Mutant factory used for creating a new instance with different ObjectIdWriter.

Annotations
@Override
withPropertiesback to summary
protected BeanSerializerBase withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

Implements abstract com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withProperties.

Doc from com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.withProperties.

References Deprecated

BeanSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Mutant factory used for creating a new instance with modified set of properties.

Note

in 2.11.x, need to keep non-abstract for slightly better compatibility (XML module extends)

Annotations
@Override