org.apache.juneau.xml

Class XmlSerializerSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.WriterSerializerSession

org.apache.juneau.xml.XmlSerializerSession

Direct Known Subclasses:

HtmlSerializerSession, SoapXmlSerializerSession, XmlDocSerializerSession, XmlSchemaSerializerSession

public class XmlSerializerSession
extends WriterSerializerSession

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

This class is NOT thread safe. It is typically discarded after one-time use although it can be reused within the same thread.

Field Summary

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

indent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlSerializerSession(XmlSerializer ctx, SerializerSessionArgs args) Create a new session using properties specified in the context.

Method Summary

Modifier and Type	Method and Description
ObjectMap	asMap() Returns the properties defined on this bean context as a simple map for debugging purposes.
protected void	doSerialize(SerializerPipe out, Object o) Serializes a POJO to the specified output stream or writer.
protected void	findNsfMappings(Object o) Recursively searches for the XML namespaces on the specified POJO and adds them to the serializer context object.
XmlWriter	getXmlWriter(SerializerPipe out) Converts the specified output target object to an XmlWriter.
protected boolean	isAddBeanTypeProperties() Returns the XmlSerializer.XML_addBeanTypeProperties setting value for this session.
protected boolean	isHtmlMode() Returns true if we're serializing HTML.
protected XmlWriter	serializeAnything(XmlWriter out, Object o, ClassMeta<?> eType, String elementName, Namespace elementNamespace, boolean addNamespaceUris, XmlFormat format, boolean isMixed, boolean preserveWhitespace, BeanPropertyMeta pMeta) Workhorse method.

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

isWriterSerializer, serialize

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

canIgnoreValue, createBeanTypeNameProperty, createPipe, generalize, getBeanTypeName, getExpectedRootType, getInitialDepth, getJavaMethod, getLastLocation, getListener, getListener, getMaxDepth, getMaxIndent, getQuoteChar, getResponseHeaders, getUriResolver, isDetectRecursions, isIgnoreRecursions, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimNulls, isTrimStrings, isUseWhitespace, onBeanGetterException, onError, pop, push, relativizeUri, resolveUri, serialize, setCurrentClass, setCurrentProperty, sort, sort, toList, toString, trim, willRecurse

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getLocale, getMediaType, getStringBuilder, getTimeZone, isBean, isBean, isDebug, isIgnoreUnknownBeanProperties, newBean, newBean, newBeanMap, newBeanMap, newInstance, newInstance, newInstanceFromOuter, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.Session

addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasWarnings, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlSerializerSession

protected XmlSerializerSession(XmlSerializer ctx,
                               SerializerSessionArgs args)

Create a new session using properties specified in the context.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime arguments. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.

Method Detail

asMap

public ObjectMap asMap()

Description copied from class: Session

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

asMap in class SerializerSession

Returns:

A new map containing the properties defined on this context.

isAddBeanTypeProperties

protected boolean isAddBeanTypeProperties()

Returns the XmlSerializer.XML_addBeanTypeProperties setting value for this session.

Overrides:

isAddBeanTypeProperties in class SerializerSession

Returns:

The XmlSerializer.XML_addBeanTypeProperties setting value for this session.

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 Exception

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:

Exception

doSerialize

protected void doSerialize(SerializerPipe out,
                           Object o)
                    throws Exception

Description copied from class: SerializerSession

Serializes a POJO to the specified output stream or writer.

This method should NOT close the context object.

Specified by:

doSerialize in class SerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

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

serializeAnything

protected XmlWriter serializeAnything(XmlWriter out,
                                      Object o,
                                      ClassMeta<?> eType,
                                      String elementName,
                                      Namespace elementNamespace,
                                      boolean addNamespaceUris,
                                      XmlFormat format,
                                      boolean isMixed,
                                      boolean preserveWhitespace,
                                      BeanPropertyMeta pMeta)
                               throws Exception

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.

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.

isMixed - 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:

Exception - If a problem occurred trying to convert the output.