com.phloc.commons.xml.serialize

Class XMLEmitterPhloc

java.lang.Object

com.phloc.commons.xml.DefaultXMLIterationHandler

com.phloc.commons.xml.serialize.XMLEmitterPhloc

All Implemented Interfaces:

IXMLIterationHandler

@NotThreadSafe
public class XMLEmitterPhloc
extends DefaultXMLIterationHandler

Converts XML constructs into a string representation.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDATA_END
static String	CDATA_START
static String	COMMENT_END
static String	COMMENT_START
static boolean	DEFAULT_THROW_EXCEPTION_ON_NESTED_COMMENTS By default an exception is thrown for nested comments
static char	ER_END
static char	ER_START
static String	PI_END
static String	PI_START

Constructor Summary

Constructors

Constructor and Description
XMLEmitterPhloc(Writer aWriter, IXMLWriterSettings aSettings)

Method Summary

Methods

Modifier and Type	Method and Description
static String	getDocTypeHTMLRepresentation(EXMLSerializeVersion eXMLVersion, EXMLIncorrectCharacterHandling eIncorrectCharHandling, IMicroDocumentType aDocType) Get the XML representation of a document type.
static String	getDocTypeHTMLRepresentation(EXMLSerializeVersion eXMLVersion, EXMLIncorrectCharacterHandling eIncorrectCharHandling, String sQualifiedName, String sPublicID, String sSystemID) Get the XML representation of a document type.
static boolean	isThrowExceptionOnNestedComments()
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.
static void	setThrowExceptionOnNestedComments(boolean bThrowExceptionOnNestedComments) Define whether nested XML comments throw an exception or not.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_THROW_EXCEPTION_ON_NESTED_COMMENTS

public static final boolean DEFAULT_THROW_EXCEPTION_ON_NESTED_COMMENTS

By default an exception is thrown for nested comments

See Also:

Constant Field Values

CDATA_START

public static final String CDATA_START

See Also:

Constant Field Values

CDATA_END

public static final String CDATA_END

See Also:

Constant Field Values

COMMENT_START

public static final String COMMENT_START

See Also:

Constant Field Values

COMMENT_END

public static final String COMMENT_END

See Also:

Constant Field Values

ER_START

public static final char ER_START

See Also:

Constant Field Values

ER_END

public static final char ER_END

See Also:

Constant Field Values

PI_START

public static final String PI_START

See Also:

Constant Field Values

PI_END

public static final String PI_END

See Also:

Constant Field Values

Constructor Detail

XMLEmitterPhloc

public XMLEmitterPhloc(@Nonnull@WillNotClose
               Writer aWriter,
               @Nonnull
               IXMLWriterSettings aSettings)

Method Detail

setThrowExceptionOnNestedComments

public static void setThrowExceptionOnNestedComments(boolean bThrowExceptionOnNestedComments)

Define whether nested XML comments throw an exception or not.

Parameters:

bThrowExceptionOnNestedComments - true to throw an exception, false to ignore nested comments.

isThrowExceptionOnNestedComments

public static boolean isThrowExceptionOnNestedComments()

Returns:

true if nested XML comments will throw an error. Default is true.

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

Overrides:

onDocumentStart in class DefaultXMLIterationHandler

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

getDocTypeHTMLRepresentation

@Nonnull
public static String getDocTypeHTMLRepresentation(@Nonnull
                                          EXMLSerializeVersion eXMLVersion,
                                          @Nonnull
                                          EXMLIncorrectCharacterHandling eIncorrectCharHandling,
                                          @Nonnull
                                          IMicroDocumentType aDocType)

Get the XML representation of a document type.

Parameters:

eXMLVersion - The XML version to use. May not be null.

eIncorrectCharHandling - The incorrect character handling. May not be null.

aDocType - The structure document type. May not be null.

Returns:

The string DOCTYPE representation.

getDocTypeHTMLRepresentation

@Nonnull
public static String getDocTypeHTMLRepresentation(@Nonnull
                                          EXMLSerializeVersion eXMLVersion,
                                          @Nonnull
                                          EXMLIncorrectCharacterHandling eIncorrectCharHandling,
                                          @Nonnull
                                          String sQualifiedName,
                                          @Nullable
                                          String sPublicID,
                                          @Nullable
                                          String sSystemID)

Get the XML representation of a document type.

Parameters:

eXMLVersion - The XML version to use. May not be null.

eIncorrectCharHandling - The incorrect character handling. May not be null.

sQualifiedName - The qualified element name. May not be null.

sPublicID - The optional public ID. May be null. If the public ID is not null the system ID must also be set!

sSystemID - The optional system ID. May be null.

Returns:

The string DOCTYPE representation.

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

Overrides:

onDocumentType in class DefaultXMLIterationHandler

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

Overrides:

onProcessingInstruction in class DefaultXMLIterationHandler

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

Overrides:

onEntityReference in class DefaultXMLIterationHandler

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

Overrides:

onContentElementWhitespace in class DefaultXMLIterationHandler

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

Overrides:

onComment in class DefaultXMLIterationHandler

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

Overrides:

onText in class DefaultXMLIterationHandler

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

Overrides:

onCDATA in class DefaultXMLIterationHandler

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

Overrides:

onElementStart in class DefaultXMLIterationHandler

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

Overrides:

onElementEnd in class DefaultXMLIterationHandler

Parameters:

sNamespacePrefix - Optional namespace prefix. May be null.

sTagName - Tag name

bHasChildren - true if the current element has children

toString

public String toString()

Overrides:

toString in class Object