Package com.fasterxml.jackson.dataformat.xml.ser

Class XmlBeanSerializerBase

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<Object>

com.fasterxml.jackson.databind.ser.std.StdSerializer<Object>

com.fasterxml.jackson.databind.ser.std.BeanSerializerBase

com.fasterxml.jackson.dataformat.xml.ser.XmlBeanSerializerBase

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, ResolvableSerializer, Serializable

Direct Known Subclasses:

UnwrappingXmlBeanSerializer, XmlBeanSerializer

public abstract class XmlBeanSerializerBase
extends BeanSerializerBase

Specific sub-class of BeanSerializerBase needed to take care of some xml-specific aspects, such as distinction between attributes and elements.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer

JsonSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_XML_INFO	Marker used for storing associated internal data with BeanPropertyWriter instances; to mark instances that are to be written out as attributes.

Constructor Summary

Constructors

Constructor	Description
XmlBeanSerializerBase(BeanSerializerBase src)
XmlBeanSerializerBase(XmlBeanSerializerBase src, NameTransformer transformer)

Method Summary

Modifier and Type	Method	Description
void	serializeWithType(Object bean, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer)	Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

Methods inherited from class com.fasterxml.jackson.databind.ser.std.BeanSerializerBase

acceptJsonFormatVisitor, createContextual, getSchema, properties, resolve, serialize, usesObjectId, withFilterId, withObjectIdWriter

Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

getSchema, handledType, wrapAndThrow, wrapAndThrow

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer

getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, replaceDelegatee, unwrappingSerializer, withIgnoredProperties

Methods inherited from class java.lang.Object

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

Field Details

KEY_XML_INFO

public static final String KEY_XML_INFO

Marker used for storing associated internal data with BeanPropertyWriter instances; to mark instances that are to be written out as attributes. Created as separate non-interned String to ensure there are no collisions.

Constructor Details

XmlBeanSerializerBase

public XmlBeanSerializerBase(BeanSerializerBase src)

XmlBeanSerializerBase

public XmlBeanSerializerBase(XmlBeanSerializerBase src,
 NameTransformer transformer)

Method Details

serializeWithType

public void serializeWithType(Object bean,
 JsonGenerator gen,
 SerializerProvider provider,
 TypeSerializer typeSer)
                       throws IOException

Description copied from class: JsonSerializer

Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

Default implementation will throw UnsupportedOperationException to indicate that proper type handling needs to be implemented.

For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like:

  // note: method to call depends on whether this type is serialized as JSON scalar, object or Array!
  typeSer.writeTypePrefixForScalar(value, gen);
  serialize(value, gen, provider);
  typeSer.writeTypeSuffixForScalar(value, gen);

and implementations for type serialized as JSON Arrays or Objects would differ slightly, as START-ARRAY/END-ARRAY and START-OBJECT/END-OBJECT pairs need to be properly handled with respect to serializing of contents.

Overrides:

serializeWithType in class BeanSerializerBase

Parameters:

bean - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

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

typeSer - Type serializer to use for including type information

Throws:

IOException