Package org.apache.juneau.xml

Class XmlSerializerSession

java.lang.Object

org.apache.juneau.ContextSession

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.WriterSerializerSession

org.apache.juneau.xml.XmlSerializerSession

Direct Known Subclasses:

HtmlSerializerSession, SoapXmlSerializerSession, XmlDocSerializerSession

public class XmlSerializerSession
extends WriterSerializerSession

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 Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlSerializerSession.Builder	Builder class.
static enum	XmlSerializerSession.ContentResult	Identifies what the contents were of a serialized bean.

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

indent

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	doSerialize(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 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.
protected 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.
protected XmlSerializerSession.ContentResult	serializeAnything(XmlWriter out, Object o, ClassMeta<?> eType, String keyName, String elementName, Namespace elementNamespace, boolean addNamespaceUris, XmlFormat format, boolean isMixedOrText, boolean preserveWhitespace, BeanPropertyMeta pMeta)	Workhorse method.

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

create, createPipe, getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, properties, serialize, serializeToString

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

addVarBean, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, forEachEntry, forEachEntry, generalize, getBeanTypeName, getExpectedRootType, getJavaMethod, getListener, getListener, getResponseHeaders, getSchema, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, serialize, sort, sort, sort, swap, toList, toString, trim

Methods inherited from class org.apache.juneau.BeanTraverseSession

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

Methods inherited from class org.apache.juneau.BeanSession

_class, addWarning, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, create, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMediaType, getNamePropertyName, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newGenericMap, object, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

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.

Returns:

A new builder.

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.

getXmlWriter

public final XmlWriter getXmlWriter(SerializerPipe out)
                             throws IOException

Converts the specified output target object to an XmlWriter.

Parameters:

out - The output target object.

Returns:

The output target object wrapped in an XmlWriter.

Throws:

IOException - Thrown by underlying stream.

doSerialize

protected void doSerialize(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.doSerialize(SerializerSession,SerializerPipe,Object).

Overrides:

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

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.

serializeAnything

protected XmlSerializerSession.ContentResult serializeAnything(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.

o - The object to serialize.

eType - The expected type if this is a bean property value being serialized.

keyName - The property name or map key name.

elementName - The root element name.

elementNamespace - The namespace of the element.

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

format - The format to serialize the output to.

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.

Returns:

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

Throws:

SerializeException - General serialization error occurred.

isAddBeanTypes

protected boolean isAddBeanTypes()

Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class SerializerSession

Returns:

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

See Also:

• XmlSerializer.Builder.addBeanTypesXml()

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

getDefaultNamespace

protected final Namespace getDefaultNamespace()

Default namespace.

Returns:

The default namespace URI for this document.

See Also:

• XmlSerializer.Builder.defaultNamespace(Namespace)

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

getNamespaces

protected final Namespace[] getNamespaces()

Default namespaces.

Returns:

The default list of namespaces associated with this serializer.

See Also:

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

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.

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.

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