com.helger.xml.serialize.write

Class XMLEmitter

java.lang.Object

com.helger.xml.serialize.write.XMLEmitter

All Implemented Interfaces:

Flushable, AutoCloseable

@NotThreadSafe
public class XMLEmitter
extends Object
implements AutoCloseable, Flushable

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
XMLEmitter(Writer aWriter, IXMLWriterSettings aSettings)

Method Summary

Modifier and Type	Method and Description
void	close()
void	elementAttr(String sAttrNamespacePrefix, String sAttrName, String sAttrValue)
void	elementStartClose(EXMLSerializeBracketMode eBracketMode)
void	elementStartOpen(String sNamespacePrefix, String sTagName)
void	flush()
static String	getDocTypeHTMLRepresentation(EXMLSerializeVersion eXMLVersion, EXMLIncorrectCharacterHandling eIncorrectCharHandling, IMicroDocumentType aDocType) Get the XML representation of a document type.
static String	getDocTypeXMLRepresentation(EXMLSerializeVersion eXMLVersion, EXMLIncorrectCharacterHandling eIncorrectCharHandling, String sQualifiedName, String sPublicID, String sSystemID) Get the XML representation of a document type.
IXMLWriterSettings	getXMLWriterSettings()
static boolean	isThrowExceptionOnNestedComments()
XMLEmitter	newLine()
void	onCDATA(String sText) CDATA node.
void	onComment(String sComment) Comment node.
void	onContentElementWhitespace(CharSequence aWhitespaces) Ignorable whitespace characters.
void	onDocumentType(String sQualifiedElementName, String sPublicID, String sSystemID) On XML document type.
void	onDTD(String sDTD) Write a DTD section.
void	onElementEnd(String sNamespacePrefix, String sTagName, EXMLSerializeBracketMode eBracketMode) End of an element.
void	onElementStart(String sNamespacePrefix, String sTagName, Map<QName,String> aAttrs, EXMLSerializeBracketMode eBracketMode) Start of an element.
void	onEntityReference(String sEntityRef) On entity reference.
void	onProcessingInstruction(String sTarget, String sData) On processing instruction
void	onText(char[] aText, int nOfs, int nLen) XML text node.
void	onText(char[] aText, int nOfs, int nLen, boolean bEscape) Text node.
void	onText(String sText) XML text node.
void	onText(String sText, boolean bEscape) Text node.
void	onXMLDeclaration(EXMLVersion eXMLVersion, String sEncoding, com.helger.commons.state.ETriState eStandalone) Deprecated.
void	onXMLDeclaration(EXMLVersion eXMLVersion, String sEncoding, com.helger.commons.state.ETriState eStandalone, boolean bWithNewLine) At the very beginning of the document (XML declaration).
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

XMLEmitter

public XMLEmitter(@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.

getXMLWriterSettings

@Nonnull
public IXMLWriterSettings getXMLWriterSettings()

Returns:

The XML writer settings as provided in the constructor. Never null.

newLine

@Nonnull
public XMLEmitter newLine()

onXMLDeclaration

@Deprecated
public void onXMLDeclaration(@Nullable
                                          EXMLVersion eXMLVersion,
                                          @Nullable
                                          String sEncoding,
                                          @Nonnull
                                          com.helger.commons.state.ETriState eStandalone)

Deprecated.

At the very beginning of the document (XML declaration).

Parameters:

eXMLVersion - The XML version to use. If null is passed, EXMLVersion.XML_10 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.

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

onXMLDeclaration

public void onXMLDeclaration(@Nullable
                             EXMLVersion eXMLVersion,
                             @Nullable
                             String sEncoding,
                             @Nonnull
                             com.helger.commons.state.ETriState eStandalone,
                             boolean bWithNewLine)

At the very beginning of the document (XML declaration).

Parameters:

eXMLVersion - The XML version to use. If null is passed, EXMLVersion.XML_10 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.

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

bWithNewLine - true to add a newline, false if not

Since:

9.2.1

onDTD

public void onDTD(@Nonnull
                  String sDTD)

Write a DTD section. This string represents the entire doctypedecl production from the XML 1.0 specification.

Parameters:

sDTD - the DTD to be written. May not be null.

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.

getDocTypeXMLRepresentation

@Nonnull
public static String getDocTypeXMLRepresentation(@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)

On XML document type.

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)

On processing instruction

Parameters:

sTarget - The target

sData - The data (attributes as a string)

onEntityReference

public void onEntityReference(@Nonnull
                              String sEntityRef)

On entity reference.

Parameters:

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

onContentElementWhitespace

public void onContentElementWhitespace(@Nullable
                                       CharSequence aWhitespaces)

Ignorable whitespace characters.

Parameters:

aWhitespaces - The whitespace character sequence

onComment

public void onComment(@Nullable
                      String sComment)

Comment node.

Parameters:

sComment - The comment text

onText

public void onText(@Nullable
                   String sText)

XML text node.

Parameters:

sText - The contained text

onText

public void onText(@Nonnull
                   char[] aText,
                   @Nonnegative
                   int nOfs,
                   @Nonnegative
                   int nLen)

XML text node.

Parameters:

aText - The contained text array

nOfs - Offset into the array where to start

nLen - Number of chars to use, starting from the provided offset.

onText

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

Text node.

Parameters:

sText - The contained text

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

onText

public void onText(@Nonnull
                   char[] aText,
                   @Nonnegative
                   int nOfs,
                   @Nonnegative
                   int nLen,
                   boolean bEscape)

Text node.

Parameters:

aText - The contained text array

nOfs - Offset into the array where to start

nLen - Number of chars to use, starting from the provided offset.

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

onCDATA

public void onCDATA(@Nullable
                    String sText)

CDATA node.

Parameters:

sText - The contained text

elementStartOpen

public void elementStartOpen(@Nullable
                             String sNamespacePrefix,
                             @Nonnull
                             String sTagName)

elementAttr

public void elementAttr(@Nullable
                        String sAttrNamespacePrefix,
                        @Nonnull
                        String sAttrName,
                        @Nonnull
                        String sAttrValue)

elementStartClose

public void elementStartClose(@Nonnull
                              EXMLSerializeBracketMode eBracketMode)

onElementStart

public void onElementStart(@Nullable
                           String sNamespacePrefix,
                           @Nonnull
                           String sTagName,
                           @Nullable
                           Map<QName,String> aAttrs,
                           @Nonnull
                           EXMLSerializeBracketMode eBracketMode)

Start of an element.

Parameters:

sNamespacePrefix - Optional namespace prefix. May be null.

sTagName - Tag name

aAttrs - Optional set of attributes.

eBracketMode - Bracket mode to use. Never null.

onElementEnd

public void onElementEnd(@Nullable
                         String sNamespacePrefix,
                         @Nonnull
                         String sTagName,
                         @Nonnull
                         EXMLSerializeBracketMode eBracketMode)

End of an element.

Parameters:

sNamespacePrefix - Optional namespace prefix. May be null.

sTagName - Tag name

eBracketMode - Bracket mode to use. Never null.

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object