com.phloc.commons.xml

Interface IXMLIterationHandler

All Known Implementing Classes:

DefaultXMLIterationHandler, XMLEmitterPhloc

public interface IXMLIterationHandler

Callback interface when iterating XML nodes.

Author:

Philip Helger

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.

Method Detail

onDocumentStart

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

At the very beginning of the document.

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

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

On XML document type.

Parameters:

sQualifiedElementName - Qualified name of the root element.

sPublicID - Document type public ID

sSystemID - Document type system ID

onProcessingInstruction

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

On processing instruction

Parameters:

sTarget - The target

sData - The data (attributes as a string)

onEntityReference

void onEntityReference(@Nonnull
                     String sEntityRef)

On entity reference.

Parameters:

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

onContentElementWhitespace

void onContentElementWhitespace(@Nullable
                              CharSequence aWhitespaces)

Ignorable whitespace characters.

Parameters:

aWhitespaces - The whitespace character sequence

onComment

void onComment(@Nullable
             String sComment)

Comment node.

Parameters:

sComment - The comment text

onText

void onText(@Nullable
          String sText,
          boolean bEscape)

Text node.

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

void onCDATA(@Nullable
           String sText)

CDATA node.

Parameters:

sText - The contained text

onElementStart

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

Start of an element.

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

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

End of an element.

Parameters:

sNamespacePrefix - Optional namespace prefix. May be null.

sTagName - Tag name

bHasChildren - true if the current element has children