Package org.apache.juneau.marshall.xml

Class XmlSerializerSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.MarshallingTraverseSession

org.apache.juneau.marshall.serializer.SerializerSession

org.apache.juneau.marshall.serializer.WriterSerializerSession

org.apache.juneau.marshall.xml.XmlSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, RecordWritable

Direct Known Subclasses:

HtmlSerializerSession, SoapXmlSerializerSession, XmlDocSerializerSession

public class XmlSerializerSession
extends WriterSerializerSession
implements RecordWritable

Session object that lives for the duration of a single use of XmlSerializer.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• XML

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlSerializerSession.Builder<SELF extends XmlSerializerSession.Builder<SELF>>	Builder class.
static enum	XmlSerializerSession.ContentResult	Identifies what the contents were of a serialized bean.
static final class	XmlSerializerSession.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() path (CRTP terminal).

Field Summary

Fields inherited from class org.apache.juneau.marshall.MarshallingTraverseSession

indent

Fields inherited from class org.apache.juneau.marshall.MarshallingSession

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlSerializerSession(XmlSerializerSession.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static XmlSerializerSession.Builder<?>	create(XmlSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
protected final void	findNsfMappings(Object o)	Recursively searches for the XML namespaces on the specified POJO and adds them to the serializer context object.
protected final Namespace	getDefaultNamespace()	Default namespace.
protected final List<Namespace>	getNamespaces()	Default namespaces.
XmlBeanMeta	getXmlBeanMeta(BeanMeta<?> bm)	Returns the language-specific metadata on the specified bean.
XmlBeanPropertyMeta	getXmlBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
XmlClassMeta	getXmlClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
final XmlWriter<?>	getXmlWriter(SerializerPipe out)	Converts the specified output target object to an XmlWriter.
boolean	isAddBeanTypes()	Add "_type" properties when needed.
protected final boolean	isAddJsonTags()	Add JSON type tags.
protected final boolean	isAddNamespaceUrisToRoot()	Add namespace URLs to the root element.
protected final boolean	isAutoDetectNamespaces()	Auto-detect namespace usage.
protected final boolean	isEnableNamespaces()	Enable support for XML namespaces.
protected boolean	isHtmlMode()	Returns true if we're serializing HTML.
boolean	isRecordStreaming()	The XML record writer is buffered/RecordAdapter-backed, not O(1) streaming.
protected XmlSerializerSession.ContentResult	writeAnything(XmlWriter<?> out, Object o, ClassMeta<?> eType, String keyName, String elementName, Namespace elementNamespace, boolean addNamespaceUris, XmlFormat format, boolean isMixedOrText, boolean preserveWhitespace, BeanPropertyMeta pMeta)	Workhorse method.
RecordWriter	writeRecords(Object output)	Opens a whole-value push generator targeting XML output, bound to this live session.

Methods inherited from class org.apache.juneau.marshall.serializer.WriterSerializerSession

create, createPipe, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, properties, write, writeToString

Methods inherited from class org.apache.juneau.marshall.serializer.SerializerSession

addVarBean, canIgnoreValue, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, forEachEntry, forEachEntry, forEachStreamableEntry, generalize, getBeanTypeName, getCalendarFormat, getDateFormat, getDurationFormat, getExpectedRootType, getJavaMethod, getListener, getListener, getLocaleFormat, getPeriodFormat, getResponseHeaders, getSchema, getTemporalFormat, getTimeZoneFormat, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, sort, sort, sort, swap, toList, toListFromStreamable, toString, trim, unwrapSupplier, write, writeCalendar, writeDate, writeDuration, writePeriod, writeTemporal

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseSession

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, isRoot, pop, push, setCurrentClass, setCurrentProperty, willExceedDepth, willRecurse

Methods inherited from class org.apache.juneau.marshall.MarshallingSession

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.marshall.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

Constructor Details

XmlSerializerSession

protected XmlSerializerSession(XmlSerializerSession.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static XmlSerializerSession.Builder<?> create(XmlSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

Returns:

A new builder.

getXmlBeanMeta

public XmlBeanMeta getXmlBeanMeta(BeanMeta<?> bm)

Returns the language-specific metadata on the specified bean.

Parameters:

bm - The bean to return the metadata on.

Returns:

The metadata.

getXmlBeanPropertyMeta

public XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm)

Returns the language-specific metadata on the specified bean property.

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getXmlClassMeta

public XmlClassMeta getXmlClassMeta(ClassMeta<?> cm)

Returns the language-specific metadata on the specified class.

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getXmlWriter

public final XmlWriter<?> getXmlWriter(SerializerPipe out)

Converts the specified output target object to an XmlWriter.

Parameters:

out - The output target object.
Must not be null.

Returns:

The output target object wrapped in an XmlWriter.

doWrite

protected void doWrite(SerializerPipe out,
 Object o)
                throws IOException,
SerializeException

Description copied from class: SerializerSession

Serializes a POJO to the specified pipe.

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doWrite(SerializerSession,SerializerPipe,Object).

Overrides:

doWrite in class SerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.

writeRecords

public RecordWriter writeRecords(Object output)
                          throws IOException

Opens a whole-value push generator targeting XML output, bound to this live session.

Because XML's wire format (attributes, namespaces, mixed content) is non-trivial to expose as a fine-grained token writer, this implementation supports only the cursor-level POJO bridge — write(Object) delegates to SerializerSession.write(Object, Object).

Specified by:

writeRecords in interface RecordWritable

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

isRecordStreaming

public boolean isRecordStreaming()

The XML record writer is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isRecordStreaming in interface RecordWritable

Returns:

Always false.

findNsfMappings

protected final void findNsfMappings(Object o)
                              throws SerializeException

Recursively searches for the XML namespaces on the specified POJO and adds them to the serializer context object.

Parameters:

o - The POJO to check.

Throws:

SerializeException - Thrown if bean recursion occurred.

getDefaultNamespace

protected final Namespace getDefaultNamespace()

Default namespace.

Returns:

The default namespace URI for this document.

See Also:

• XmlSerializer.Builder.defaultNamespace(Namespace)

getNamespaces

protected final List<Namespace> getNamespaces()

Default namespaces.

Returns:

The default list of namespaces associated with this serializer.
Never null.
List is modifiable (namespaces can be added during serialization).

See Also:

• XmlSerializer.Builder.namespaces(Namespace...)

isAddBeanTypes

public boolean isAddBeanTypes()

Description copied from class: SerializerSession

Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class SerializerSession

Returns:

true if "_type" properties added to beans if their type cannot be inferred through reflection.

See Also:

• Serializer.Builder.addBeanTypes()

isAddJsonTags

protected final boolean isAddJsonTags()

Add JSON type tags.

Returns:

true if plain strings will be wrapped in <string> tags when serialized as root elements.

See Also:

• XmlSerializer.Builder.disableJsonTags()

isAddNamespaceUrisToRoot

protected final boolean isAddNamespaceUrisToRoot()

Add namespace URLs to the root element.

Returns:

true if xmlns:x attributes are added to the root element for the default and all mapped namespaces.

See Also:

• XmlSerializer.Builder.addNamespaceUrisToRoot()

isAutoDetectNamespaces

protected final boolean isAutoDetectNamespaces()

Auto-detect namespace usage.

Returns:

true if namespace usage is detected before serialization.

See Also:

• XmlSerializer.Builder.disableAutoDetectNamespaces()

isEnableNamespaces

protected final boolean isEnableNamespaces()

Enable support for XML namespaces.

Returns:

false if XML output will not contain any namespaces regardless of any other settings.

See Also:

• XmlSerializer.Builder.enableNamespaces()

isHtmlMode

protected boolean isHtmlMode()

Returns true if we're serializing HTML.

The difference in behavior is how empty non-void elements are handled. The XML serializer will produce a collapsed tag, whereas the HTML serializer will produce a start and end tag.

Returns:

true if we're generating HTML.

writeAnything

protected XmlSerializerSession.ContentResult writeAnything(XmlWriter<?> out,
 Object o,
 ClassMeta<?> eType,
 String keyName,
 String elementName,
 Namespace elementNamespace,
 boolean addNamespaceUris,
 XmlFormat format,
 boolean isMixedOrText,
 boolean preserveWhitespace,
 BeanPropertyMeta pMeta)
                                                    throws SerializeException

Workhorse method.

Parameters:

out - The writer to send the output to.
Must not be null.

o - The object to serialize.
Can be null (written as the XML null representation, e.g. type='null').

eType - The expected type if this is a bean property value being serialized.
Can be null (treated as the generic Object type).

keyName - The property name or map key name.
Can be null (the element is written without a separate property/key name).

elementName - The root element name.
Can be null (falls back to the bean dictionary name, then keyName, then the JSON type name).

elementNamespace - The namespace of the element.
Can be null (resolved from the serialized type's, then the actual type's, then the session's default namespace).

addNamespaceUris - Flag indicating that namespace URIs need to be added.

format - The format to serialize the output to.
Must not be null.

isMixedOrText - We're serializing mixed content, so don't use whitespace.

preserveWhitespace - true if we're serializing XmlFormat.MIXED_PWS or XmlFormat.TEXT_PWS.

pMeta - The bean property metadata if this is a bean property being serialized.
Can be null (no bean-property-level URI/child-name/namespace metadata is applied).

Returns:

The same writer passed in so that calls to the writer can be chained.

Throws:

SerializeException - General serialization error occurred.