com.phloc.commons.xml.serialize

Class XMLWriterSettings

java.lang.Object

com.phloc.commons.xml.serialize.XMLWriterSettings

All Implemented Interfaces:

ICloneable<XMLWriterSettings>, IXMLWriterSettings

@NotThreadSafe
public class XMLWriterSettings
extends Object
implements IXMLWriterSettings, ICloneable<XMLWriterSettings>

Default implementation of the IXMLWriterSettings interface.
Describes the export settings for the MicroWriter. Defaults to indented and aligned XML in the UTF-8 charset.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_EMIT_NAMESPACES By default namespaces are written.
static String	DEFAULT_INDENTATION_STRING By default indentation happens with 2 spaces
static String	DEFAULT_NEWLINE_STRING By default the platform newline string is used.
static boolean	DEFAULT_PUT_NAMESPACE_CONTEXT_PREFIXES_IN_ROOT By default namespace context prefixes are not put inside the root element (for backwards compatibility)
static boolean	DEFAULT_SPACE_ON_SELF_CLOSED_ELEMENT By default a leading space is inserted before a self closed element (e.g.
static boolean	DEFAULT_USE_DOUBLE_QUOTES_FOR_ATTRIBUTES By default double quotes are used to wrap attribute values
static String	DEFAULT_XML_CHARSET The default charset is UTF-8
static Charset	DEFAULT_XML_CHARSET_OBJ The default charset is UTF-8
static IXMLWriterSettings	DEFAULT_XML_SETTINGS The default settings to use

Constructor Summary

Constructors

Constructor and Description
XMLWriterSettings() Creates a default settings object with the following settings: XML output XML version 1.0 with document type with comments Indented and aligned Writing invalid characters to the file as is - may result in invalid XML files Default character set UTF-8 No namespace context
XMLWriterSettings(IXMLWriterSettings aOther) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCharset()
Charset	getCharsetObj()
XMLWriterSettings	getClone()
EXMLSerializeFormat	getFormat()
EXMLIncorrectCharacterHandling	getIncorrectCharacterHandling()
EXMLSerializeIndent	getIndent()
String	getIndentationString()
NamespaceContext	getNamespaceContext()
String	getNewlineString()
EXMLSerializeComments	getSerializeComments()
EXMLSerializeDocType	getSerializeDocType()
EXMLVersion	getXMLVersion()
int	hashCode()
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()
XMLWriterSettings	setCharset(Charset aCharset) Set the serialization charset.
XMLWriterSettings	setCharset(String sCharset) Deprecated.
XMLWriterSettings	setEmitNamespaces(boolean bEmitNamespaces)
XMLWriterSettings	setFormat(EXMLSerializeFormat eFormat) Set the XML serialization format to use.
XMLWriterSettings	setIncorrectCharacterHandling(EXMLIncorrectCharacterHandling eIncorrectCharacterHandling) Set the way how to handle invalid characters.
XMLWriterSettings	setIndent(EXMLSerializeIndent eIndent) Set the way how to indent/align
XMLWriterSettings	setIndentationString(String sIndentationString)
XMLWriterSettings	setNamespaceContext(NamespaceContext aNamespaceContext) Set the namespace context to be used.
XMLWriterSettings	setNewlineString(ENewLineMode eNewlineMode)
XMLWriterSettings	setNewlineString(String sNewlineString)
XMLWriterSettings	setPutNamespaceContextPrefixesInRoot(boolean bPutNamespaceContextPrefixesInRoot)
XMLWriterSettings	setSerializeComments(EXMLSerializeComments eSerializeComments) Set the way how comments should be handled.
XMLWriterSettings	setSerializeDocType(EXMLSerializeDocType eSerializeDocType) Set the way how to handle the doc type.
XMLWriterSettings	setSpaceOnSelfClosedElement(boolean bSpaceOnSelfClosedElement)
XMLWriterSettings	setUseDoubleQuotesForAttributes(boolean bUseDoubleQuotesForAttributes)
XMLWriterSettings	setXMLVersion(EXMLVersion eVersion) Set the preferred XML version to use.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_XML_CHARSET

public static final String DEFAULT_XML_CHARSET

The default charset is UTF-8

See Also:

Constant Field Values

DEFAULT_XML_CHARSET_OBJ

public static final Charset DEFAULT_XML_CHARSET_OBJ

The default charset is UTF-8

DEFAULT_USE_DOUBLE_QUOTES_FOR_ATTRIBUTES

public static final boolean DEFAULT_USE_DOUBLE_QUOTES_FOR_ATTRIBUTES

By default double quotes are used to wrap attribute values

See Also:

Constant Field Values

DEFAULT_SPACE_ON_SELF_CLOSED_ELEMENT

public static final boolean DEFAULT_SPACE_ON_SELF_CLOSED_ELEMENT

By default a leading space is inserted before a self closed element (e.g. <b /> in contrast to <b/>).

See Also:

Constant Field Values

DEFAULT_NEWLINE_STRING

public static final String DEFAULT_NEWLINE_STRING

By default the platform newline string is used.

DEFAULT_INDENTATION_STRING

public static final String DEFAULT_INDENTATION_STRING

By default indentation happens with 2 spaces

See Also:

Constant Field Values

DEFAULT_EMIT_NAMESPACES

public static final boolean DEFAULT_EMIT_NAMESPACES

By default namespaces are written.

See Also:

Constant Field Values

DEFAULT_PUT_NAMESPACE_CONTEXT_PREFIXES_IN_ROOT

public static final boolean DEFAULT_PUT_NAMESPACE_CONTEXT_PREFIXES_IN_ROOT

By default namespace context prefixes are not put inside the root element (for backwards compatibility)

See Also:

Constant Field Values

DEFAULT_XML_SETTINGS

public static final IXMLWriterSettings DEFAULT_XML_SETTINGS

The default settings to use

Constructor Detail

XMLWriterSettings

public XMLWriterSettings()

Creates a default settings object with the following settings:

• XML output
• XML version 1.0
• with document type
• with comments
• Indented and aligned
• Writing invalid characters to the file as is - may result in invalid XML files
• Default character set UTF-8
• No namespace context

XMLWriterSettings

public XMLWriterSettings(@Nonnull
                 IXMLWriterSettings aOther)

Copy constructor.

Parameters:

aOther - The object to copy the settings from. May not be null.

Method Detail

setFormat

@Nonnull
public final XMLWriterSettings setFormat(@Nonnull
                                  EXMLSerializeFormat eFormat)

Set the XML serialization format to use.

Parameters:

eFormat - The new format. May not be null.

Returns:

this

getFormat

@Nonnull
public EXMLSerializeFormat getFormat()

Specified by:

getFormat in interface IXMLWriterSettings

Returns:

Create XML or HTML? Default is XML.

setXMLVersion

@Nonnull
public final XMLWriterSettings setXMLVersion(@Nonnull
                                      EXMLVersion eVersion)

Set the preferred XML version to use.

Parameters:

eVersion - The XML version. May not be null.

Returns:

this

getXMLVersion

@Nonnull
public EXMLVersion getXMLVersion()

Specified by:

getXMLVersion in interface IXMLWriterSettings

Returns:

The XML version to use. Default is 1.0

setSerializeDocType

@Nonnull
public final XMLWriterSettings setSerializeDocType(@Nonnull
                                            EXMLSerializeDocType eSerializeDocType)

Set the way how to handle the doc type.

Parameters:

eSerializeDocType - Doc type handling. May not be null.

Returns:

this

getSerializeDocType

@Nonnull
public EXMLSerializeDocType getSerializeDocType()

Specified by:

getSerializeDocType in interface IXMLWriterSettings

Returns:

Write document type? Default is true.

setSerializeComments

@Nonnull
public final XMLWriterSettings setSerializeComments(@Nonnull
                                             EXMLSerializeComments eSerializeComments)

Set the way how comments should be handled.

Parameters:

eSerializeComments - The comment handling. May not be null.

Returns:

this

getSerializeComments

@Nonnull
public EXMLSerializeComments getSerializeComments()

Specified by:

getSerializeComments in interface IXMLWriterSettings

Returns:

Write comments? Default is true.

setIndent

@Nonnull
public final XMLWriterSettings setIndent(@Nonnull
                                  EXMLSerializeIndent eIndent)

Set the way how to indent/align

Parameters:

eIndent - Indent and align definition. May not be null.

Returns:

this

getIndent

@Nonnull
public EXMLSerializeIndent getIndent()

Specified by:

getIndent in interface IXMLWriterSettings

Returns:

Indent code? Default is indent and aligned.

setIncorrectCharacterHandling

@Nonnull
public final XMLWriterSettings setIncorrectCharacterHandling(@Nonnull
                                                      EXMLIncorrectCharacterHandling eIncorrectCharacterHandling)

Set the way how to handle invalid characters.

Parameters:

eIncorrectCharacterHandling - The invalid character handling. May not be null.

Returns:

this

getIncorrectCharacterHandling

@Nonnull
public EXMLIncorrectCharacterHandling getIncorrectCharacterHandling()

Specified by:

getIncorrectCharacterHandling in interface IXMLWriterSettings

Returns:

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

setCharset

@Nonnull
public final XMLWriterSettings setCharset(@Nonnull
                                   Charset aCharset)

Set the serialization charset.

Parameters:

aCharset - The charset to be used. May not be null.

Returns:

this

setCharset

@Nonnull
@Deprecated
public final XMLWriterSettings setCharset(@Nonnull@Nonempty
                                              String sCharset)

Deprecated.

Set the serialization charset.

Parameters:

sCharset - The charset to be used. May not be null.

Returns:

this

getCharset

@Nonnull
public String getCharset()

Specified by:

getCharset in interface IXMLWriterSettings

Returns:

The charset name to use. May never be null.

getCharsetObj

@Nonnull
public Charset getCharsetObj()

Specified by:

getCharsetObj in interface IXMLWriterSettings

Returns:

The charset to use. May never be null.

setNamespaceContext

@Nonnull
public final XMLWriterSettings setNamespaceContext(@Nullable
                                            NamespaceContext aNamespaceContext)

Set the namespace context to be used.

Parameters:

aNamespaceContext - The namespace context to be used. May be null.

Returns:

this

getNamespaceContext

@Nullable
public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface IXMLWriterSettings

Returns:

The namespace context to be used. May be null to dynamically create the namespace prefixes.

setUseDoubleQuotesForAttributes

@Nonnull
public final XMLWriterSettings setUseDoubleQuotesForAttributes(boolean bUseDoubleQuotesForAttributes)

isUseDoubleQuotesForAttributes

public boolean isUseDoubleQuotesForAttributes()

Specified by:

isUseDoubleQuotesForAttributes in interface IXMLWriterSettings

Returns:

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

setSpaceOnSelfClosedElement

@Nonnull
public final XMLWriterSettings setSpaceOnSelfClosedElement(boolean bSpaceOnSelfClosedElement)

isSpaceOnSelfClosedElement

public boolean isSpaceOnSelfClosedElement()

Description copied from interface: IXMLWriterSettings

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

Specified by:

isSpaceOnSelfClosedElement in interface IXMLWriterSettings

Returns:

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

setNewlineString

@Nonnull
public final XMLWriterSettings setNewlineString(@Nonnull@Nonempty
                                         ENewLineMode eNewlineMode)

setNewlineString

@Nonnull
public final XMLWriterSettings setNewlineString(@Nonnull@Nonempty
                                         String sNewlineString)

getNewlineString

@Nonnull
@Nonempty
public String getNewlineString()

Specified by:

getNewlineString in interface IXMLWriterSettings

Returns:

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

setIndentationString

@Nonnull
public final XMLWriterSettings setIndentationString(@Nonnull@Nonempty
                                             String sIndentationString)

getIndentationString

@Nonnull
@Nonempty
public String getIndentationString()

Specified by:

getIndentationString in interface IXMLWriterSettings

Returns:

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

setEmitNamespaces

@Nonnull
public final XMLWriterSettings setEmitNamespaces(boolean bEmitNamespaces)

isEmitNamespaces

public boolean isEmitNamespaces()

Description copied from interface: IXMLWriterSettings

Determine if namespaces should be emitted or not.

Specified by:

isEmitNamespaces in interface IXMLWriterSettings

Returns:

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

setPutNamespaceContextPrefixesInRoot

@Nonnull
public final XMLWriterSettings setPutNamespaceContextPrefixesInRoot(boolean bPutNamespaceContextPrefixesInRoot)

isPutNamespaceContextPrefixesInRoot

public boolean isPutNamespaceContextPrefixesInRoot()

Description copied from interface: IXMLWriterSettings

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!

Specified by:

isPutNamespaceContextPrefixesInRoot in interface IXMLWriterSettings

Returns:

true if it is enabled, false if not.

getClone

@Nonnull
public XMLWriterSettings getClone()

Specified by:

getClone in interface ICloneable<XMLWriterSettings>

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object