com.helger.commons.xml.serialize

Interface IXMLWriterSettings

All Known Implementing Classes:

XMLWriterSettings

public interface IXMLWriterSettings

Interface for the settings to be used for serializing XML nodes.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
String	getCharset()
Charset	getCharsetObj()
EXMLSerializeFormat	getFormat()
EXMLIncorrectCharacterHandling	getIncorrectCharacterHandling()
EXMLSerializeIndent	getIndent()
String	getIndentationString()
NamespaceContext	getNamespaceContext()
ENewLineMode	getNewLineMode()
String	getNewlineString() Deprecated.
String	getNewLineString()
EXMLSerializeComments	getSerializeComments()
EXMLSerializeDocType	getSerializeDocType()
EXMLVersion	getXMLVersion()
boolean	isEmitNamespaces() Determine if namespaces should be emitted or not.
boolean	isPutNamespaceContextPrefixesInRoot() Check if the flag for putting all namespace prefixes specified in the namespace context should be put in the root document.
boolean	isSpaceOnSelfClosedElement() Determine if a self closed element (an element having no children) should be emitted with a space at the end (<br />) or not ( <br/>)
boolean	isUseDoubleQuotesForAttributes()

Method Detail

getFormat

@Nonnull
EXMLSerializeFormat getFormat()

Returns:

Create XML or HTML? Default is XML.

getXMLVersion

@Nonnull
EXMLVersion getXMLVersion()

Returns:

The XML version to use. Default is 1.0

getSerializeDocType

@Nonnull
EXMLSerializeDocType getSerializeDocType()

Returns:

Write document type? Default is true.

getSerializeComments

@Nonnull
EXMLSerializeComments getSerializeComments()

Returns:

Write comments? Default is true.

getIndent

@Nonnull
EXMLSerializeIndent getIndent()

Returns:

Indent code? Default is indent and aligned.

getIncorrectCharacterHandling

@Nonnull
EXMLIncorrectCharacterHandling getIncorrectCharacterHandling()

Returns:

The incorrect character handling to be used. May not be null.

getCharset

@Nonnull
String getCharset()

Returns:

The charset name to use. May never be null.

getCharsetObj

@Nonnull
Charset getCharsetObj()

Returns:

The charset to use. May never be null.

getNamespaceContext

@Nonnull
NamespaceContext getNamespaceContext()

Returns:

The namespace context to be used. Never null.

isUseDoubleQuotesForAttributes

boolean isUseDoubleQuotesForAttributes()

Returns:

true if attribute values should be enclosed in double quotes, false if single quotes should be used.

isSpaceOnSelfClosedElement

boolean isSpaceOnSelfClosedElement()

Determine if a self closed element (an element having no children) should be emitted with a space at the end (<br />) or not ( <br/>)

Returns:

true if a space should be emitted, false if no space should be emitted.

getNewlineString

@Nonnull
 @Nonempty
 @Deprecated
String getNewlineString()

Deprecated.

Returns:

The newline string to be used. By default it is the platform specific newline string. Never null nor empty.

getNewLineMode

@Nonnull
ENewLineMode getNewLineMode()

Returns:

The newline mode to be used. By default it is the platform specific new line mode. Never null.

getNewLineString

@Nonnull
 @Nonempty
String getNewLineString()

Returns:

The string representing the new line mode. A shortcut for getNewLineMode ().getText().

getIndentationString

@Nonnull
 @Nonempty
String getIndentationString()

Returns:

The string to be used for indentation. By default it is 2 spaces.

isEmitNamespaces

boolean isEmitNamespaces()

Determine if namespaces should be emitted or not.

Returns:

true if namespaces should be emitted, false if all created elements should reside in the default namespace.

isPutNamespaceContextPrefixesInRoot

boolean isPutNamespaceContextPrefixesInRoot()

Check if the flag for putting all namespace prefixes specified in the namespace context should be put in the root document. This setting only has an effect if a namespace context is defined and if it implements the IIterableNamespaceContext interface!

Returns:

true if it is enabled, false if not.