SerialParameters (EXPath 0.4.0)

java.lang.Object
- org.expath.tools.serial.SerialParameters

public class SerialParameters
extends java.lang.Object

A set of serialization parameters.

Author:: Florent Georges

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SerialParameters.Standalone

class SerialParameters.UseChar

Nested Classes
Modifier and Type	Class and Description
`static class`	`SerialParameters.Standalone`
`class`	`SerialParameters.UseChar`

Constructor Summary

Constructors
Constructor and Description

SerialParameters()

Constructors
Constructor and Description
`SerialParameters()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCdataSectionElements(java.lang.Iterable<javax.xml.namespace.QName> v)` Set the output property `cdata-section-elements`.
`void`	`addCdataSectionElements(java.lang.String v, Element scope)` Set the output property `cdata-section-elements`.
`void`	`addSuppressIndentation(java.lang.Iterable<javax.xml.namespace.QName> v)` Set the output property `suppress-indentation`.
`void`	`addSuppressIndentation(java.lang.String v, Element scope)` Set the output property `suppress-indentation`.
`void`	`addUseCharacterMaps(java.lang.Iterable<SerialParameters.UseChar> v)` Set the output property `use-character-maps`.
`void`	`addUseCharacterMaps(java.lang.String v, Element scope)` Set the output property `use-character-maps`.
`java.lang.Boolean`	`getByteOrderMark()` Get the output property `byte-order-mark`.
`java.lang.Iterable<javax.xml.namespace.QName>`	`getCdataSectionElements()` Get the output property `cdata-section-elements`.
`java.lang.String`	`getDoctypePublic()` Get the output property `doctype-public`.
`java.lang.String`	`getDoctypeSystem()` Get the output property `doctype-system`.
`java.lang.String`	`getEncoding()` Get the output property `encoding`.
`java.lang.Boolean`	`getEscapeUriAttributes()` Get the output property `escape-uri-attributes`.
`java.lang.String`	`getExtension(javax.xml.namespace.QName n)` Get an extension output property.
`java.lang.Double`	`getHtmlVersion()` Get the output property `html-version`.
`java.lang.Boolean`	`getIncludeContentType()` Get the output property `include-content-type`.
`java.lang.Boolean`	`getIndent()` Get the output property `indent`.
`java.lang.String`	`getItemSeparator()` Get the output property `item-separator`.
`java.lang.String`	`getMediaType()` Get the output property `media-type`.
`javax.xml.namespace.QName`	`getMethod()` Get the output property `method`.
`java.lang.String`	`getNormalizationForm()` Get the output property `normalization-form`.
`java.lang.Boolean`	`getOmitXmlDeclaration()` Get the output property `omit-xml-declaration`.
`SerialParameters.Standalone`	`getStandalone()` Get the output property `standalone`.
`java.lang.Iterable<javax.xml.namespace.QName>`	`getSuppressIndentation()` Get the output property `suppress-indentation`.
`java.lang.Boolean`	`getUndeclarePrefixes()` Get the output property `undeclare-prefixes`.
`java.lang.Iterable<SerialParameters.UseChar>`	`getUseCharacterMaps()` Get the output property `use-character-maps`.
`java.lang.String`	`getVersion()` Get the output property `version`.
`static SerialParameters`	`parse(Element elem)`
`void`	`setByteOrderMark(java.lang.Boolean v)` Set the output property `byte-order-mark`.
`void`	`setByteOrderMark(java.lang.String v)` Set the output property `byte-order-mark`.
`void`	`setDoctypePublic(java.lang.String v)` Set the output property `doctype-public`.
`void`	`setDoctypeSystem(java.lang.String v)` Set the output property `doctype-system`.
`void`	`setEncoding(java.lang.String v)` Set the output property `encoding`.
`void`	`setEscapeUriAttributes(java.lang.Boolean v)` Set the output property `escape-uri-attributes`.
`void`	`setEscapeUriAttributes(java.lang.String v)` Set the output property `escape-uri-attributes`.
`void`	`setExtension(javax.xml.namespace.QName n, java.lang.String v)` Set an extension output property.
`void`	`setExtensionHandler(ExtensionHandler handler)` Set an extension handler.
`void`	`setHtmlVersion(java.lang.Double v)` Set the output property `html-version`.
`void`	`setHtmlVersion(java.lang.String v)` Set the output property `html-version`.
`void`	`setIncludeContentType(java.lang.Boolean v)` Set the output property `include-content-type`.
`void`	`setIncludeContentType(java.lang.String v)` Set the output property `include-content-type`.
`void`	`setIndent(java.lang.Boolean v)` Set the output property `indent`.
`void`	`setIndent(java.lang.String v)` Set the output property `indent`.
`void`	`setItemSeparator(java.lang.String v)` Set the output property `item-separator`.
`void`	`setMediaType(java.lang.String v)` Set the output property `media-type`.
`void`	`setMethod(javax.xml.namespace.QName v)` Set the output property `method`.
`void`	`setNormalizationForm(java.lang.String v)` Set the output property `normalization-form`.
`void`	`setOmitXmlDeclaration(java.lang.Boolean v)` Set the output property `omit-xml-declaration`.
`void`	`setOmitXmlDeclaration(java.lang.String v)` Set the output property `omit-xml-declaration`.
`void`	`setStandalone(SerialParameters.Standalone v)` Set the output property `standalone`.
`void`	`setStandalone(java.lang.String v)` Set the output property `standalone`.
`void`	`setUndeclarePrefixes(java.lang.Boolean v)` Set the output property `undeclare-prefixes`.
`void`	`setUndeclarePrefixes(java.lang.String v)` Set the output property `undeclare-prefixes`.
`void`	`setVersion(java.lang.String v)` Set the output property `version`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SerialParameters
```
public SerialParameters()
```
- Method Detail
  - parse
```
public static SerialParameters parse(Element elem)
                              throws ToolsException
```
    Throws:
    
    ToolsException
  - setExtensionHandler
```
public void setExtensionHandler(ExtensionHandler handler)
                         throws ToolsException
```
    Set an extension handler.
    
    Parameters:
    
    handler - the extension handler
    
    Throws:
    
    ToolsException - if an error occurs whilst setting the handler
  - getExtension
```
public java.lang.String getExtension(javax.xml.namespace.QName n)
                              throws ToolsException
```
    Get an extension output property. If the property is not known by the specific implementation, it must raise a technical exception.
    
    Parameters:
    
    n - the qualified name of the property
    
    Returns:
    
    the value of the property
    
    Throws:
    
    ToolsException - if an error occurs whilst retrieving the property
  - setExtension
```
public void setExtension(javax.xml.namespace.QName n,
                         java.lang.String v)
                  throws ToolsException
```
    Set an extension output property. If the property is not known by the specific implementation, it must raise a technical exception.
    
    Parameters:
    
    n - the qualified name of the property
    
    v - the value of the property
    
    Throws:
    
    ToolsException - if an error occurs whilst setting the property
  - getByteOrderMark
```
public java.lang.Boolean getByteOrderMark()
```
    Get the output property byte-order-mark.
    
    Returns:
    
    true if a byte-order-mark is present
  - setByteOrderMark
```
public void setByteOrderMark(java.lang.Boolean v)
```
    Set the output property byte-order-mark.
    
    Parameters:
    
    v - the byte-order-mark flag
  - setByteOrderMark
```
public void setByteOrderMark(java.lang.String v)
                      throws ToolsException
```
    Set the output property byte-order-mark.
    
    Parameters:
    
    v - the byte-order-mark flag
    
    Throws:
    
    ToolsException - if the string cannot be parsed correctly
  - getCdataSectionElements
```
public java.lang.Iterable<javax.xml.namespace.QName> getCdataSectionElements()
```
    Get the output property cdata-section-elements.
    
    Returns:
    
    the iterable
  - addCdataSectionElements
```
public void addCdataSectionElements(java.lang.Iterable<javax.xml.namespace.QName> v)
```
    Set the output property cdata-section-elements.
    
    Parameters:
    
    v - the iterable
  - addCdataSectionElements
```
public void addCdataSectionElements(java.lang.String v,
                                    Element scope)
                             throws ToolsException
```
    Set the output property cdata-section-elements.
    
    Parameters:
    
    v - the qualified name
    
    scope - the element scope
    
    Throws:
    
    ToolsException - if the qualified name cannot be parsed correctly
  - getDoctypePublic
```
public java.lang.String getDoctypePublic()
```
    Get the output property doctype-public.
    
    Returns:
    
    the public doc-type
  - setDoctypePublic
```
public void setDoctypePublic(java.lang.String v)
```
    Set the output property doctype-public.
    
    Parameters:
    
    v - the public doc-type
  - getDoctypeSystem
```
public java.lang.String getDoctypeSystem()
```
    Get the output property doctype-system.
    
    Returns:
    
    the system doc-type
  - setDoctypeSystem
```
public void setDoctypeSystem(java.lang.String v)
```
    Set the output property doctype-system.
    
    Parameters:
    
    v - the system doc-type
  - getEncoding
```
public java.lang.String getEncoding()
```
    Get the output property encoding.
    
    Returns:
    
    the encoding
  - setEncoding
```
public void setEncoding(java.lang.String v)
```
    Set the output property encoding.
    
    Parameters:
    
    v - the encoding
  - getEscapeUriAttributes
```
public java.lang.Boolean getEscapeUriAttributes()
```
    Get the output property escape-uri-attributes.
    
    Returns:
    
    the escape-uri-attributes flag
  - setEscapeUriAttributes
```
public void setEscapeUriAttributes(java.lang.Boolean v)
```
    Set the output property escape-uri-attributes.
    
    Parameters:
    
    v - the escape-uri-attributes flag
  - setEscapeUriAttributes
```
public void setEscapeUriAttributes(java.lang.String v)
                            throws ToolsException
```
    Set the output property escape-uri-attributes.
    
    Parameters:
    
    v - the escape-uri-attributes flag
    
    Throws:
    
    ToolsException - if the string cannot be parsed correctly
  - getHtmlVersion
```
public java.lang.Double getHtmlVersion()
```
    Get the output property html-version.
    
    Returns:
    
    the html version
  - setHtmlVersion
```
public void setHtmlVersion(java.lang.Double v)
```
    Set the output property html-version.
    
    Parameters:
    
    v - the html version
  - setHtmlVersion
```
public void setHtmlVersion(java.lang.String v)
                    throws ToolsException
```
    Set the output property html-version.
    
    Parameters:
    
    v - the html version
    
    Throws:
    
    ToolsException - if the string cannot be parsed correctly
  - getIncludeContentType
```
public java.lang.Boolean getIncludeContentType()
```
    Get the output property include-content-type.
    
    Returns:
    
    the include-content-type flag
  - setIncludeContentType
```
public void setIncludeContentType(java.lang.Boolean v)
```
    Set the output property include-content-type.
    
    Parameters:
    
    v - the include-content-type flag
  - setIncludeContentType
```
public void setIncludeContentType(java.lang.String v)
                           throws ToolsException
```
    Set the output property include-content-type.
    
    Parameters:
    
    v - the include-content-type flag
    
    Throws:
    
    ToolsException - if the string cannot be parsed correctly
  - getIndent
```
public java.lang.Boolean getIndent()
```
    Get the output property indent.
    
    Returns:
    
    the indent flag
  - setIndent
```
public void setIndent(java.lang.Boolean v)
```
    Set the output property indent.
    
    Parameters:
    
    v - the indent flag
  - setIndent
```
public void setIndent(java.lang.String v)
               throws ToolsException
```
    Set the output property indent.
    
    Parameters:
    
    v - the indent flag
    
    Throws:
    
    ToolsException - if the string cannot be parsed correctly
  - getItemSeparator
```
public java.lang.String getItemSeparator()
```
    Get the output property item-separator.
    
    Returns:
    
    the item separator
  - setItemSeparator
```
public void setItemSeparator(java.lang.String v)
```
    Set the output property item-separator.
    
    Parameters:
    
    v - the item separator
  - getMediaType
```
public java.lang.String getMediaType()
```
    Get the output property media-type.
    
    Returns:
    
    the media-type
  - setMediaType
```
public void setMediaType(java.lang.String v)
```
    Set the output property media-type.
    
    Parameters:
    
    v - the media-type
  - getMethod
```
public javax.xml.namespace.QName getMethod()
```
    Get the output property method.
    
    Returns:
    
    the output method
  - setMethod
```
public void setMethod(javax.xml.namespace.QName v)
```
    Set the output property method.
    
    Parameters:
    
    v - the output method
  - getNormalizationForm
```
public java.lang.String getNormalizationForm()
```
    Get the output property normalization-form.
    
    Returns:
    
    the normalized-form
  - setNormalizationForm
```
public void setNormalizationForm(java.lang.String v)
```
    Set the output property normalization-form.
    
    Parameters:
    
    v - the normalized-form
  - getOmitXmlDeclaration
```
public java.lang.Boolean getOmitXmlDeclaration()
```
    Get the output property omit-xml-declaration.
    
    Returns:
    
    the omit-xml-declaration flag
  - setOmitXmlDeclaration
```
public void setOmitXmlDeclaration(java.lang.Boolean v)
```
    Set the output property omit-xml-declaration.
    
    Parameters:
    
    v - the omit-xml-declaration flag
  - setOmitXmlDeclaration
```
public void setOmitXmlDeclaration(java.lang.String v)
                           throws ToolsException
```
    Set the output property omit-xml-declaration.
    
    Parameters:
    
    v - the omit-xml-declaration flag
    
    Throws:
    
    ToolsException - if the string cannot be parsed correctly
  - getStandalone
```
public SerialParameters.Standalone getStandalone()
```
    Get the output property standalone.
    
    Returns:
    
    standalone
  - setStandalone
```
public void setStandalone(SerialParameters.Standalone v)
```
    Set the output property standalone.
    
    Parameters:
    
    v - standalone
  - setStandalone
```
public void setStandalone(java.lang.String v)
                   throws ToolsException
```
    Set the output property standalone.
    
    Parameters:
    
    v - standalone
    
    Throws:
    
    ToolsException - if the string cannot be parsed correctly
  - getSuppressIndentation
```
public java.lang.Iterable<javax.xml.namespace.QName> getSuppressIndentation()
```
    Get the output property suppress-indentation.
    
    Returns:
    
    suppress indentation iterable
  - addSuppressIndentation
```
public void addSuppressIndentation(java.lang.Iterable<javax.xml.namespace.QName> v)
```
    Set the output property suppress-indentation.
    
    Parameters:
    
    v - suppress indentation iterable
  - addSuppressIndentation
```
public void addSuppressIndentation(java.lang.String v,
                                   Element scope)
                            throws ToolsException
```
    Set the output property suppress-indentation.
    
    Parameters:
    
    v - the qualified name
    
    scope - the element scope
    
    Throws:
    
    ToolsException - if the qualified name cannot be parsed correctly
  - getUndeclarePrefixes
```
public java.lang.Boolean getUndeclarePrefixes()
```
    Get the output property undeclare-prefixes.
    
    Returns:
    
    undeclare-prefixes flag
  - setUndeclarePrefixes
```
public void setUndeclarePrefixes(java.lang.Boolean v)
```
    Set the output property undeclare-prefixes.
    
    Parameters:
    
    v - undeclare-prefixes flag
  - setUndeclarePrefixes
```
public void setUndeclarePrefixes(java.lang.String v)
                          throws ToolsException
```
    Set the output property undeclare-prefixes.
    
    Parameters:
    
    v - undeclare-prefixes flag
    
    Throws:
    
    ToolsException - if the string cannot be parsed correctly
  - getUseCharacterMaps
```
public java.lang.Iterable<SerialParameters.UseChar> getUseCharacterMaps()
```
    Get the output property use-character-maps.
    
    Returns:
    
    use-character-maps iterable
  - addUseCharacterMaps
```
public void addUseCharacterMaps(java.lang.Iterable<SerialParameters.UseChar> v)
```
    Set the output property use-character-maps.
    
    Parameters:
    
    v - use-character-maps iterable
  - addUseCharacterMaps
```
public void addUseCharacterMaps(java.lang.String v,
                                Element scope)
                         throws ToolsException
```
    Set the output property use-character-maps.
    
    Parameters:
    
    v - the qualified name
    
    scope - the element scope
    
    Throws:
    
    ToolsException - if the qualified name cannot be parsed correctly
  - getVersion
```
public java.lang.String getVersion()
```
    Get the output property version.
    
    Returns:
    
    the version
  - setVersion
```
public void setVersion(java.lang.String v)
```
    Set the output property version.
    
    Parameters:
    
    v - the version

Class SerialParameters

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SerialParameters

Method Detail

parse

setExtensionHandler

getExtension

setExtension

getByteOrderMark

setByteOrderMark

setByteOrderMark

getCdataSectionElements

addCdataSectionElements

addCdataSectionElements

getDoctypePublic

setDoctypePublic

getDoctypeSystem

setDoctypeSystem

getEncoding

setEncoding

getEscapeUriAttributes

setEscapeUriAttributes

setEscapeUriAttributes

getHtmlVersion

setHtmlVersion

setHtmlVersion

getIncludeContentType

setIncludeContentType

setIncludeContentType

getIndent

setIndent

setIndent

getItemSeparator

setItemSeparator

getMediaType

setMediaType

getMethod

setMethod

getNormalizationForm

setNormalizationForm

getOmitXmlDeclaration

setOmitXmlDeclaration

setOmitXmlDeclaration

getStandalone

setStandalone

setStandalone

getSuppressIndentation

addSuppressIndentation

addSuppressIndentation

getUndeclarePrefixes

setUndeclarePrefixes

setUndeclarePrefixes

getUseCharacterMaps

addUseCharacterMaps

addUseCharacterMaps

getVersion

setVersion