Package com.helger.xml.serialize.write

Class AbstractXMLSerializer<NODETYPE>

java.lang.Object

com.helger.xml.serialize.write.AbstractXMLSerializer<NODETYPE>

Type Parameters:

NODETYPE - The DOM node type to use

Direct Known Subclasses:

MicroSerializer, XMLSerializer

public abstract class AbstractXMLSerializer<NODETYPE>
extends Object

Abstract XML serializer implementation that works with IMicroNode and org.w3c.dom.Node objects.

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractXMLSerializer.NamespaceLevel	Contains the XML namespace definitions for a single element.
protected static class	AbstractXMLSerializer.NamespaceStack	Contains the hierarchy of XML namespaces within a document structure.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_NAMESPACE_PREFIX_PREFIX	The prefix to be used for created namespace prefixes :) (e.g. for "ns0" or "ns1")
protected StringBuilder	m_aIndent	helper variable: current indentation.
protected AbstractXMLSerializer.NamespaceStack	m_aNSStack	Current stack of namespaces.
protected IXMLWriterSettings	m_aSettings	The serialization settings

Constructor Summary

Constructors

Constructor	Description
AbstractXMLSerializer(IXMLWriterSettings aSettings)

Method Summary

Modifier and Type	Method	Description
protected XMLEmitter	createXMLEmitter(Writer aWriter, IXMLWriterSettings aSettings)
protected abstract void	emitNode(XMLEmitter aXMLWriter, NODETYPE aParentNode, NODETYPE aPrevSibling, NODETYPE aNode, NODETYPE aNextSibling)
IXMLWriterSettings	getSettings()
protected void	handlePutNamespaceContextPrefixInRoot(Map<QName,String> aAttrMap)	This method handles the case, if all namespace context entries should be emitted on the root element.
String	toString()
void	write(NODETYPE aNode, XMLEmitter aXMLEmitter)
void	write(NODETYPE aNode, OutputStream aOS)	Write the specified node to the specified OutputStream.
void	write(NODETYPE aNode, Writer aWriter)	Write the specified node to the specified Writer.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAMESPACE_PREFIX_PREFIX

public static final String DEFAULT_NAMESPACE_PREFIX_PREFIX

The prefix to be used for created namespace prefixes :) (e.g. for "ns0" or "ns1")

See Also:

Constant Field Values

m_aSettings

protected final IXMLWriterSettings m_aSettings

The serialization settings

m_aIndent

protected final StringBuilder m_aIndent

helper variable: current indentation.

m_aNSStack

protected final AbstractXMLSerializer.NamespaceStack m_aNSStack

Current stack of namespaces.

Constructor Detail

AbstractXMLSerializer

public AbstractXMLSerializer(@Nonnull
                             IXMLWriterSettings aSettings)

Method Detail

getSettings

@Nonnull
public final IXMLWriterSettings getSettings()

handlePutNamespaceContextPrefixInRoot

protected final void handlePutNamespaceContextPrefixInRoot(@Nonnull
                                                           Map<QName,String> aAttrMap)

This method handles the case, if all namespace context entries should be emitted on the root element.

Parameters:

aAttrMap - the attribute map to be filled. May not be null.

emitNode

protected abstract void emitNode(@Nonnull
                                 XMLEmitter aXMLWriter,
                                 @Nullable
                                 NODETYPE aParentNode,
                                 @Nullable
                                 NODETYPE aPrevSibling,
                                 @Nonnull
                                 NODETYPE aNode,
                                 @Nullable
                                 NODETYPE aNextSibling)

createXMLEmitter

@Nonnull
@OverrideOnDemand
protected XMLEmitter createXMLEmitter(@Nonnull @WillNotClose
                                      Writer aWriter,
                                      @Nonnull
                                      IXMLWriterSettings aSettings)

write

public final void write(@Nonnull
                        NODETYPE aNode,
                        @Nonnull
                        XMLEmitter aXMLEmitter)

write

public final void write(@Nonnull
                        NODETYPE aNode,
                        @Nonnull @WillNotClose
                        OutputStream aOS)

Write the specified node to the specified OutputStream.

Parameters:

aNode - The node to write. May not be null.

aOS - The stream to serialize onto. May not be null.

write

public final void write(@Nonnull
                        NODETYPE aNode,
                        @Nonnull @WillNotClose
                        Writer aWriter)

Write the specified node to the specified Writer.

Parameters:

aNode - The node to write. May not be null.

aWriter - The writer to serialize onto. May not be null.

toString

public String toString()

Overrides:

toString in class Object