org.apache.juneau.xml

Class XmlSerializerSession

java.lang.Object

org.apache.juneau.Session

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	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 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
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.
protected Namespace	getDefaultNamespace() Configuration property: Default namespace.
protected Namespace[]	getNamespaces() Configuration property: Default namespaces.
XmlWriter	getXmlWriter(SerializerPipe out) Converts the specified output target object to an XmlWriter.
protected Namespace	getXsNamespace() Configuration property: XMLSchema namespace.
protected boolean	isAddBeanTypes() Configuration property: Add "_type" properties when needed.
protected boolean	isAddNamespaceUrisToRoot() Configuration property: Add namespace URLs to the root element.
protected boolean	isAutoDetectNamespaces() Configuration property: Auto-detect namespace usage.
protected boolean	isEnableNamespaces() Configuration property: 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 elementName, Namespace elementNamespace, boolean addNamespaceUris, XmlFormat format, boolean isMixed, boolean preserveWhitespace, BeanPropertyMeta pMeta) Workhorse method.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

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

createPipe, getMaxIndent, getQuoteChar, isUseWhitespace, isWriterSerializer, serialize, serializeToString

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

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

Methods inherited from class org.apache.juneau.BeanTraverseSession

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

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getBpi, getBpro, getBpwo, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getExamples, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, 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, hasProperty, 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

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

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 elementName,
                                                               Namespace elementNamespace,
                                                               boolean addNamespaceUris,
                                                               XmlFormat format,
                                                               boolean isMixed,
                                                               boolean preserveWhitespace,
                                                               BeanPropertyMeta pMeta)
                                                        throws IOException,
                                                               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.

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:

IOException - Thrown by underlying stream.

SerializeException - General serialization error occurred.

isAddBeanTypes

protected boolean isAddBeanTypes()

Configuration property: 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.XML_addBeanTypes

isAddNamespaceUrisToRoot

protected final boolean isAddNamespaceUrisToRoot()

Configuration property: 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.XML_addNamespaceUrisToRoot

isAutoDetectNamespaces

protected final boolean isAutoDetectNamespaces()

Configuration property: Auto-detect namespace usage.

Returns:

true if namespace usage is detected before serialization.

See Also:

XmlSerializer.XML_autoDetectNamespaces

getDefaultNamespace

protected final Namespace getDefaultNamespace()

Configuration property: Default namespace.

Returns:

The default namespace URI for this document.

See Also:

XmlSerializer.XML_defaultNamespace

isEnableNamespaces

protected final boolean isEnableNamespaces()

Configuration property: Enable support for XML namespaces.

Returns:

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

See Also:

XmlSerializer.XML_enableNamespaces

getNamespaces

protected final Namespace[] getNamespaces()

Configuration property: Default namespaces.

Returns:

The default list of namespaces associated with this serializer.

See Also:

XmlSerializer.XML_namespaces

getXsNamespace

protected final Namespace getXsNamespace()

Configuration property: XMLSchema namespace.

Returns:

The namespace for the XMLSchema namespace, used by the schema generated by the XmlSchemaSerializer class.

See Also:

XmlSerializer.XML_xsNamespace

toMap

public ObjectMap toMap()

Description copied from class: Session

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

Overrides:

toMap in class WriterSerializerSession

Returns:

A new map containing the properties defined on this context.