XMLWriterSettings (ph-xml 9.0.1 API)

java.lang.Object
- com.helger.xml.serialize.write.XMLWriterSettings

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<XMLWriterSettings>, IXMLWriterSettings, Serializable
```
@NotThreadSafe
public class XMLWriterSettings
extends Object
implements IXMLWriterSettings, com.helger.commons.lang.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

See Also:

Serialized Form

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 boolean`	`DEFAULT_PUT_NAMESPACE_CONTEXT_PREFIXES_IN_ROOT` By default namespace context prefixes are put inside the root element
`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 version 1.0 with XML declaration 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static XMLWriterSettings`	`createForHTML4()`
`static XMLWriterSettings`	`createForHTML5()`
`static XMLWriterSettings`	`createForXHTML()`
`boolean`	`equals(Object o)`
`IXMLBracketModeDeterminator`	`getBracketModeDeterminator()`
`Charset`	`getCharset()`
`XMLWriterSettings`	`getClone()`
`EXMLIncorrectCharacterHandling`	`getIncorrectCharacterHandling()`
`EXMLSerializeIndent`	`getIndent()`
`String`	`getIndentationString()`
`IXMLIndentDeterminator`	`getIndentDeterminator()`
`INamespaceContext`	`getNamespaceContext()`
`com.helger.commons.system.ENewLineMode`	`getNewLineMode()`
`String`	`getNewLineString()`
`EXMLSerializeComments`	`getSerializeComments()`
`EXMLSerializeDocType`	`getSerializeDocType()`
`EXMLSerializeVersion`	`getSerializeVersion()`
`EXMLSerializeXMLDeclaration`	`getSerializeXMLDeclaration()`
`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`	`setBracketModeDeterminator(IXMLBracketModeDeterminator aBracketModeDeterminator)`
`XMLWriterSettings`	`setCharset(Charset aCharset)` Set the serialization charset.
`XMLWriterSettings`	`setEmitNamespaces(boolean bEmitNamespaces)`
`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`	`setIndentDeterminator(IXMLIndentDeterminator aIndentDeterminator)` Set the dynamic (per-element) indent determinator to be used.
`XMLWriterSettings`	`setNamespaceContext(INamespaceContext aNamespaceContext)` Set the namespace context to be used.
`XMLWriterSettings`	`setNewLineMode(com.helger.commons.system.ENewLineMode eNewLineMode)`
`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`	`setSerializeVersion(EXMLSerializeVersion eSerializeVersion)` Set the preferred XML version to use.
`XMLWriterSettings`	`setSerializeXMLDeclaration(EXMLSerializeXMLDeclaration eSerializeXMLDecl)` Set the way how to handle the XML declaration.
`XMLWriterSettings`	`setSpaceOnSelfClosedElement(boolean bSpaceOnSelfClosedElement)`
`XMLWriterSettings`	`setUseDoubleQuotesForAttributes(boolean bUseDoubleQuotesForAttributes)`
`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
  - 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_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 put inside the root element
    
    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 version 1.0
    - with XML declaration
    - 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
  - getXMLVersion
```
@Nonnull
public EXMLVersion getXMLVersion()
```
    Specified by:
    
    getXMLVersion in interface IXMLWriterSettings
    
    Returns:
    
    The XML version to use. Default is 1.0
  - setSerializeVersion
```
@Nonnull
public final XMLWriterSettings setSerializeVersion(@Nonnull
                                                             EXMLSerializeVersion eSerializeVersion)
```
    Set the preferred XML version to use.
    
    Parameters:
    
    eSerializeVersion - The XML serialize version. May not be null.
    
    Returns:
    
    this
  - getSerializeVersion
```
@Nonnull
public EXMLSerializeVersion getSerializeVersion()
```
    Specified by:
    
    getSerializeVersion in interface IXMLWriterSettings
    
    Returns:
    
    The XML serialize version to use. Default is XML 1.0
  - setSerializeXMLDeclaration
```
@Nonnull
public final XMLWriterSettings setSerializeXMLDeclaration(@Nonnull
                                                                    EXMLSerializeXMLDeclaration eSerializeXMLDecl)
```
    Set the way how to handle the XML declaration.
    
    Parameters:
    
    eSerializeXMLDecl - XML declaration handling. May not be null.
    
    Returns:
    
    this
  - getSerializeXMLDeclaration
```
@Nonnull
public EXMLSerializeXMLDeclaration getSerializeXMLDeclaration()
```
    Specified by:
    
    getSerializeXMLDeclaration in interface IXMLWriterSettings
    
    Returns:
    
    Write XML declaration? Default is true.
  - 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 and/or align code? Default is indent and aligned.
  - setIndentDeterminator
```
@Nonnull
public final XMLWriterSettings setIndentDeterminator(@Nonnull
                                                               IXMLIndentDeterminator aIndentDeterminator)
```
    Set the dynamic (per-element) indent determinator to be used.
    
    Parameters:
    
    aIndentDeterminator - The object to use. May not be null.
    
    Returns:
    
    this
  - getIndentDeterminator
```
@Nonnull
public IXMLIndentDeterminator getIndentDeterminator()
```
    Specified by:
    
    getIndentDeterminator in interface IXMLWriterSettings
    
    Returns:
    
    The dynamic (per-element) indentation determinator. This must be changed when e.g. serializing HTML. Never null.
  - 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
  - getCharset
```
@Nonnull
public Charset getCharset()
```
    Specified by:
    
    getCharset in interface IXMLWriterSettings
    
    Returns:
    
    The charset to use. May never be null.
  - setNamespaceContext
```
@Nonnull
public final XMLWriterSettings setNamespaceContext(@Nullable
                                                             INamespaceContext aNamespaceContext)
```
    Set the namespace context to be used.
    
    Parameters:
    
    aNamespaceContext - The namespace context to be used. May be null.
    
    Returns:
    
    this
  - getNamespaceContext
```
@Nonnull
public INamespaceContext getNamespaceContext()
```
    Specified by:
    
    getNamespaceContext in interface IXMLWriterSettings
    
    Returns:
    
    The namespace context to be used. Never null.
  - 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.
  - setBracketModeDeterminator
```
@Nonnull
public final XMLWriterSettings setBracketModeDeterminator(@Nonnull
                                                                    IXMLBracketModeDeterminator aBracketModeDeterminator)
```
  - getBracketModeDeterminator
```
@Nonnull
public IXMLBracketModeDeterminator getBracketModeDeterminator()
```
    Specified by:
    
    getBracketModeDeterminator in interface IXMLWriterSettings
    
    Returns:
    
    The dynamic (per-element) bracket mode determinator to use. This must be changed when e.g. serializing HTML. Never null .
  - 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.
  - setNewLineMode
```
@Nonnull
public final XMLWriterSettings setNewLineMode(@Nonnull
                                                        com.helger.commons.system.ENewLineMode eNewLineMode)
```
  - getNewLineMode
```
@Nonnull
public com.helger.commons.system.ENewLineMode getNewLineMode()
```
    Specified by:
    
    getNewLineMode in interface IXMLWriterSettings
    
    Returns:
    
    The newline mode to be used. By default it is the platform specific new line mode. Never null.
  - getNewLineString
```
@Nonnull
 @Nonempty
public String getNewLineString()
```
    Specified by:
    
    getNewLineString in interface IXMLWriterSettings
    
    Returns:
    
    The string representing the new line mode. A shortcut for getNewLineMode ().getText().
  - 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 of a single level. 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 com.helger.commons.lang.ICloneable<XMLWriterSettings>
  - 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
  - createForHTML4
```
@Nonnull
 @ReturnsMutableCopy
public static XMLWriterSettings createForHTML4()
```
  - createForXHTML
```
@Nonnull
 @ReturnsMutableCopy
public static XMLWriterSettings createForXHTML()
```
  - createForHTML5
```
@Nonnull
 @ReturnsMutableCopy
public static XMLWriterSettings createForHTML5()
```

Class XMLWriterSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_XML_CHARSET

DEFAULT_XML_CHARSET_OBJ

DEFAULT_USE_DOUBLE_QUOTES_FOR_ATTRIBUTES

DEFAULT_SPACE_ON_SELF_CLOSED_ELEMENT

DEFAULT_INDENTATION_STRING

DEFAULT_EMIT_NAMESPACES

DEFAULT_PUT_NAMESPACE_CONTEXT_PREFIXES_IN_ROOT

DEFAULT_XML_SETTINGS

Constructor Detail

XMLWriterSettings

XMLWriterSettings

Method Detail

getXMLVersion

setSerializeVersion

getSerializeVersion

setSerializeXMLDeclaration

getSerializeXMLDeclaration

setSerializeDocType

getSerializeDocType

setSerializeComments

getSerializeComments

setIndent

getIndent

setIndentDeterminator

getIndentDeterminator

setIncorrectCharacterHandling

getIncorrectCharacterHandling

setCharset

getCharset

setNamespaceContext

getNamespaceContext

setUseDoubleQuotesForAttributes

isUseDoubleQuotesForAttributes

setBracketModeDeterminator

getBracketModeDeterminator

setSpaceOnSelfClosedElement

isSpaceOnSelfClosedElement

setNewLineMode

getNewLineMode

getNewLineString

setIndentationString

getIndentationString

setEmitNamespaces

isEmitNamespaces

setPutNamespaceContextPrefixesInRoot

isPutNamespaceContextPrefixesInRoot

getClone

equals

hashCode

toString

createForHTML4

createForXHTML

createForHTML5