com.phloc.commons.xml

Class DefaultXMLIterationHandler

java.lang.Object

com.phloc.commons.xml.DefaultXMLIterationHandler

All Implemented Interfaces:

IXMLIterationHandler

Direct Known Subclasses:

XMLEmitterPhloc

public class DefaultXMLIterationHandler
extends Object
implements IXMLIterationHandler

Empty implementation of IXMLIterationHandler that does nothing.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
DefaultXMLIterationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	onCDATA(String sText) CDATA node.
void	onComment(String sComment) Comment node.
void	onContentElementWhitespace(CharSequence aWhitespaces) Ignorable whitespace characters.
void	onDocumentStart(EXMLVersion eVersion, String sEncoding, boolean bStandalone) At the very beginning of the document.
void	onDocumentType(String sQualifiedElementName, String sPublicID, String sSystemID) On XML document type.
void	onElementEnd(String sNamespacePrefix, String sTagName, boolean bHasChildren) End of an element.
void	onElementStart(String sNamespacePrefix, String sTagName, Map<String,String> aAttrs, boolean bHasChildren) Start of an element.
void	onEntityReference(String sEntityRef) On entity reference.
void	onProcessingInstruction(String sTarget, String sData) On processing instruction
void	onText(String sText, boolean bEscape) Text node.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultXMLIterationHandler

public DefaultXMLIterationHandler()

Method Detail

onDocumentStart

public void onDocumentStart(@Nullable
                   EXMLVersion eVersion,
                   @Nullable
                   String sEncoding,
                   boolean bStandalone)

Description copied from interface: IXMLIterationHandler

At the very beginning of the document.

Specified by:

onDocumentStart in interface IXMLIterationHandler

Parameters:

eVersion - The XML version to use. If null is passed, EXMLVersion.DEFAULT will be used.

sEncoding - The encoding to be used for this document. It may be null but it is strongly recommended to write a correct charset.

bStandalone - if true this is a standalone XML document without a connection to an existing DTD or XML schema

onDocumentType

public void onDocumentType(@Nonnull
                  String sQualifiedElementName,
                  @Nullable
                  String sPublicID,
                  @Nullable
                  String sSystemID)

Description copied from interface: IXMLIterationHandler

On XML document type.

Specified by:

onDocumentType in interface IXMLIterationHandler

Parameters:

sQualifiedElementName - Qualified name of the root element.

sPublicID - Document type public ID

sSystemID - Document type system ID

onProcessingInstruction

public void onProcessingInstruction(@Nonnull
                           String sTarget,
                           @Nullable
                           String sData)

Description copied from interface: IXMLIterationHandler

On processing instruction

Specified by:

onProcessingInstruction in interface IXMLIterationHandler

Parameters:

sTarget - The target

sData - The data (attributes as a string)

onEntityReference

public void onEntityReference(@Nonnull
                     String sEntityRef)

Description copied from interface: IXMLIterationHandler

On entity reference.

Specified by:

onEntityReference in interface IXMLIterationHandler

Parameters:

sEntityRef - The reference (without '&' and ';' !!)

onContentElementWhitespace

public void onContentElementWhitespace(@Nullable
                              CharSequence aWhitespaces)

Description copied from interface: IXMLIterationHandler

Ignorable whitespace characters.

Specified by:

onContentElementWhitespace in interface IXMLIterationHandler

Parameters:

aWhitespaces - The whitespace character sequence

onComment

public void onComment(@Nullable
             String sComment)

Description copied from interface: IXMLIterationHandler

Comment node.

Specified by:

onComment in interface IXMLIterationHandler

Parameters:

sComment - The comment text

onText

public void onText(@Nullable
          String sText,
          boolean bEscape)

Description copied from interface: IXMLIterationHandler

Text node.

Specified by:

onText in interface IXMLIterationHandler

Parameters:

sText - The contained text

bEscape - If true the text should be XML masked, false if not. The false case is especially interesting for HTML inline JS and CSS code.

onCDATA

public void onCDATA(@Nullable
           String sText)

Description copied from interface: IXMLIterationHandler

CDATA node.

Specified by:

onCDATA in interface IXMLIterationHandler

Parameters:

sText - The contained text

onElementStart

public void onElementStart(@Nullable
                  String sNamespacePrefix,
                  @Nonnull
                  String sTagName,
                  @Nullable
                  Map<String,String> aAttrs,
                  boolean bHasChildren)

Description copied from interface: IXMLIterationHandler

Start of an element.

Specified by:

onElementStart in interface IXMLIterationHandler

Parameters:

sNamespacePrefix - Optional namespace prefix. May be null.

sTagName - Tag name

aAttrs - Optional set of attributes.

bHasChildren - true if the current element has children

onElementEnd

public void onElementEnd(@Nullable
                String sNamespacePrefix,
                @Nonnull
                String sTagName,
                boolean bHasChildren)

Description copied from interface: IXMLIterationHandler

End of an element.

Specified by:

onElementEnd in interface IXMLIterationHandler

Parameters:

sNamespacePrefix - Optional namespace prefix. May be null.

sTagName - Tag name

bHasChildren - true if the current element has children