Package org.apache.juneau.xml

Class XmlDocSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.xml.XmlSerializer

org.apache.juneau.xml.XmlDocSerializer

All Implemented Interfaces:

XmlMetaProvider

Direct Known Subclasses:

XmlDocSerializer.Ns

public class XmlDocSerializer
extends XmlSerializer

Serializes POJOs to HTTP responses as XML.

Media types

Handles Accept types: text/xml

Produces Content-Type types: text/xml

Description

Same as XmlSerializer, except prepends <?xml version='1.0' encoding='UTF-8'?> to the response to make it a valid XML document.

Notes:

• This class is thread safe and reusable.

See Also:

• XML Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlDocSerializer.Ns	Default serializer without namespaces.

Nested classes/interfaces inherited from class org.apache.juneau.xml.XmlSerializer

XmlSerializer.Builder, XmlSerializer.NsSq, XmlSerializer.NsSqReadable, XmlSerializer.Sq, XmlSerializer.SqReadable

Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer

Serializer.Null

Field Summary

Fields inherited from class org.apache.juneau.xml.XmlSerializer

addBeanTypesXml, addJsonTags, addNamespaceUrlsToRoot, autoDetectNamespaces, DEFAULT, DEFAULT_JUNEAU_NAMESPACE, DEFAULT_NS, DEFAULT_NS_SQ, DEFAULT_NS_SQ_READABLE, DEFAULT_SQ, DEFAULT_SQ_READABLE, DEFAULT_XS_NAMESPACE, enableNamespaces

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

maxIndent, quoteChar, quoteCharOverride, useWhitespace

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

accept, addRootType, keepNullProperties, listener, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

Fields inherited from class org.apache.juneau.BeanContextable

beanContext

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
XmlDocSerializer(XmlSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
XmlSerializer.Builder	copy()	Creates a builder from this context object.
static XmlSerializer.Builder	create()	Creates a new builder for this object.
XmlDocSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
XmlDocSerializerSession	getSession()	Returns a session to use for this context.

Methods inherited from class org.apache.juneau.xml.XmlSerializer

getDefaultNamespace, getNamespaces, getTextNodeDelimiter, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, isAddBeanTypes, isAddNamespaceUrlsToRoot, isAutoDetectNamespaces, isEnableNamespaces, properties

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

getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, serialize, toString

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

createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Constructor Details

XmlDocSerializer

public XmlDocSerializer(XmlSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.
Cannot be null.

Method Details

create

public static XmlSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public XmlSerializer.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class XmlSerializer

Returns:

A new Builder object.

createSession

public XmlDocSerializerSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class XmlSerializer

Returns:

A new session builder.

getSession

public XmlDocSerializerSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class XmlSerializer

Returns:

A new session object.