public class SerializeOptions
extends Object
Options for controlling XML serialization via XmlUtil.serialize.
All options have sensible defaults matching the existing behaviour of
XmlUtil.serialize(), so only options that need to differ from
the defaults need to be specified:
// Groovy named parameters:
XmlUtil.serialize(node, new SerializeOptions(encoding: 'ISO-8859-1', indent: 4))
| Constructor and description |
|---|
SerializeOptions()Creates a new options instance using the default serialization settings. |
| Type Params | Return Type | Name and description |
|---|---|---|
|
public Charset |
getCharset()The character encoding as a Charset. |
|
public String |
getEncoding()The character encoding for the XML output. |
|
public int |
getIndent()The number of spaces to use for indentation. |
|
public boolean |
isAllowDocTypeDeclaration()Whether to allow DOCTYPE declarations during serialization. |
|
public boolean |
isAllowExternalResources()Whether the underlying TransformerFactory may resolve external DTDs and stylesheets (e.g. via <xsl:import>
or <xsl:include>).
|
|
public void |
setAllowDocTypeDeclaration(boolean allowDocTypeDeclaration)Sets whether DOCTYPE declarations are allowed during serialization. |
|
public void |
setAllowExternalResources(boolean allowExternalResources)Sets whether external DTDs and stylesheets may be resolved during serialization. |
|
public void |
setEncoding(String encoding)Sets the character encoding for the XML output. |
|
public void |
setIndent(int indent)Sets the number of spaces to use for indentation. |
Creates a new options instance using the default serialization settings.
The character encoding as a Charset.
The character encoding for the XML output.
Default is "UTF-8".
The number of spaces to use for indentation.
Default is 2.
Whether to allow DOCTYPE declarations during serialization.
Default is false.
Whether the underlying TransformerFactory
may resolve external DTDs and stylesheets (e.g. via <xsl:import>
or <xsl:include>).
Default is false; set to true when serializing XSLT
documents that legitimately reference external resources.
true if external resource resolution is allowedSets whether DOCTYPE declarations are allowed during serialization.
allowDocTypeDeclaration - true to allow DOCTYPE declarationsSets whether external DTDs and stylesheets may be resolved during serialization.
allowExternalResources - true to allow external resource resolutionSets the character encoding for the XML output.
encoding - the encoding name to useSets the number of spaces to use for indentation.
indent - the indent amountCopyright © 2003-2026 The Apache Software Foundation. All rights reserved.