com.phloc.commons.xml.serialize

Class AbstractSerializerPhloc<NODETYPE>

java.lang.Object

com.phloc.commons.xml.serialize.AbstractSerializerPhloc<NODETYPE>

Type Parameters:

NODETYPE - The DOM node type to use

All Implemented Interfaces:

IXMLSerializer<NODETYPE>

Direct Known Subclasses:

MicroSerializer, XMLSerializerPhloc

public abstract class AbstractSerializerPhloc<NODETYPE>
extends Object
implements IXMLSerializer<NODETYPE>

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 and Description
protected static class	AbstractSerializerPhloc.NamespaceLevel Contains the XML namespace definitions for a single element.
protected static class	AbstractSerializerPhloc.NamespaceStack Contains the hierarchy of XML namespaces within a document structure.

Field Summary

Fields

Modifier and Type	Field and 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 AbstractSerializerPhloc.NamespaceStack	m_aNSStack Current stack of namespaces.
protected IXMLWriterSettings	m_aSettings The serialization settings

Constructor Summary

Constructors

Constructor and Description
AbstractSerializerPhloc(IXMLWriterSettings aSettings)

Method Summary

Methods

Modifier and Type	Method and Description
protected XMLEmitterPhloc	createXMLEmitter(Writer aWriter, IXMLWriterSettings aSettings)
protected abstract void	emitNode(IXMLIterationHandler aXMLWriter, NODETYPE aPrevSibling, NODETYPE aNode, NODETYPE aNextSibling)
IXMLWriterSettings	getSettings()
protected void	handlePutNamespaceContextPrefixInRoot(Map<String,String> aAttrMap)
String	toString()
void	write(NODETYPE aNode, IXMLIterationHandler 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 AbstractSerializerPhloc.NamespaceStack m_aNSStack

Current stack of namespaces.

Constructor Detail

AbstractSerializerPhloc

public AbstractSerializerPhloc(@Nonnull
                       IXMLWriterSettings aSettings)

Method Detail

getSettings

@Nonnull
public final IXMLWriterSettings getSettings()

handlePutNamespaceContextPrefixInRoot

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

emitNode

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

createXMLEmitter

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

write

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

Description copied from interface: IXMLSerializer

Write the specified node to the specified Writer.

Specified by:

write in interface IXMLSerializer<NODETYPE>

Parameters:

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

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

write

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

write

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

Description copied from interface: IXMLSerializer

Write the specified node to the specified OutputStream.

Specified by:

write in interface IXMLSerializer<NODETYPE>

Parameters:

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

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

toString

public String toString()

Overrides:

toString in class Object