net.sf.saxon.s9api

Class Serializer.Property

public static class Serializer.Property extends Enum<Serializer.Property>

Field Summary
static Serializer.PropertyBYTE_ORDER_MARK
Set to "yes" or "no" to indicate whether a byte order mark is to be written
static Serializer.PropertyCDATA_SECTION_ELEMENTS
Space-separated list of QNames (in Clark form) of elements whose content is to be wrapped in CDATA sections
static Serializer.PropertyDOCTYPE_PUBLIC
Set to any string to indicate that the output is to include a DOCTYPE declaration with this public id
static Serializer.PropertyDOCTYPE_SYSTEM
Set to any string to indicate that the output is to include a DOCTYPE declaration with this system id
static Serializer.PropertyENCODING
Character encoding of output stream
static Serializer.PropertyESCAPE_URI_ATTRIBUTES
Set to "yes" or "no" to indicate (for HTML and XHTML) whether URI-valued attributes should be percent-encoded
static Serializer.PropertyINCLUDE_CONTENT_TYPE
For HTML and XHTML, set to "yes" or "no" to indicate whether a <meta> element is to be written to indicate the content type and encoding
static Serializer.PropertyINDENT
Set to "yes" or "no" to indicate whether indentation is required
static Serializer.PropertyMEDIA_TYPE
Set to indicate the media type (MIME type) of the output
static Serializer.PropertyMETHOD
Serialization method: xml, html, xhtml, or text
static Serializer.PropertyNORMALIZATION_FORM
Set to the name of a Unicode normalization form: "NFC", "NFD", "NFKC", or "NFKD", or "none" to indicate no normalization
static Serializer.PropertyOMIT_XML_DECLARATION
Set to "yes" if the XML declaration is to be omitted from the output file
static Serializer.PropertySAXON_CHARACTER_REPRESENTATION
Saxon extension to indicate how characters outside the encoding should be represented, for example "hex" for hexadecimal character references, "decimal" for decimal character references
static Serializer.PropertySAXON_DOUBLE_SPACE
Saxon extension: set to a space-separated list of element names, in Clark notation, representing elements that will be preceded by an extra blank line in the output in addition to normal indentation.
static Serializer.PropertySAXON_IMPLICIT_RESULT_DOCUMENT
Saxon extension for internal use in XSLT, indicates that this output document is the implicitly created result tree as distinct from a tree created using <xsl:result-document>
static Serializer.PropertySAXON_INDENT_SPACES
Saxon extension: set to an integer (represented as a string) giving the number of spaces by which each level of nesting should be indented.
static Serializer.PropertySAXON_NEXT_IN_CHAIN
Saxon extension to indicate that output should not be serialized, but should be further transformed.
static Serializer.PropertySAXON_NEXT_IN_CHAIN_BASE_URI
Saxon extension, indicate the base URI against which SAXON_NEXT_IN_CHAIN should be resolved.
static Serializer.PropertySAXON_RECOGNIZE_BINARY
Saxon extension for use when writing to the text output method; this option causes the processing instructions hex and b64 to be recognized containing hexBinary or base64 data respectively.
static Serializer.PropertySAXON_REQUIRE_WELL_FORMED
Saxon extension for use when output is sent to a SAX ContentHandler: indicates that the output is required to be well-formed (exactly one top-level element)
static Serializer.PropertySAXON_STYLESHEET_VERSION
Saxon extension for internal use: used in XSLT to tell the serializer whether the stylesheet used version="1.0" or version="2.0"
static Serializer.PropertySAXON_SUPPLY_SOURCE_LOCATOR
Saxon extension for interfacing with debuggers; indicates that the location information is available for events in this output stream
static Serializer.PropertySAXON_SUPPRESS_INDENTATION
Saxon extension: set to a space-separated list of element names, in Clark notation, within which no content is to be indented.
static Serializer.PropertySAXON_WRAP
Saxon extension, indicates that the output of a query is to be wrapped before serialization, such that each item in the result sequence is enclosed in an element indicating its type
static Serializer.PropertySTANDALONE
Set to "yes", "no", or "omit" to indicate the required value of the standalone attribute in the XML declaration of the output file
static Serializer.PropertyUNDECLARE_PREFIXES
Set to "yes" or "no" to indicate (for XML 1.1) whether namespace that go out of scope should be undeclared
static Serializer.PropertyUSE_CHARACTER_MAPS
List of names of character maps to be used.
static List<Serializer.Property>VALUES
An immutable list containing the values comprising this enum class in the order they're declared.
static Serializer.PropertyVERSION
Version of output method, for example "1.0" or "1.1" for XML
Method Summary
List<Serializer.Property>family()
Returns an immutable list containing the values comprising this enum class in the order they're declared.
StringtoString()
Get the name of the property expressed as a QName in Clark notation.
static Serializer.PropertyvalueOf(String name)
Static factory to return the enum constant pertaining to the given string name.

Field Detail

BYTE_ORDER_MARK

public static final Serializer.Property BYTE_ORDER_MARK
Set to "yes" or "no" to indicate whether a byte order mark is to be written

CDATA_SECTION_ELEMENTS

public static final Serializer.Property CDATA_SECTION_ELEMENTS
Space-separated list of QNames (in Clark form) of elements whose content is to be wrapped in CDATA sections

DOCTYPE_PUBLIC

public static final Serializer.Property DOCTYPE_PUBLIC
Set to any string to indicate that the output is to include a DOCTYPE declaration with this public id

DOCTYPE_SYSTEM

public static final Serializer.Property DOCTYPE_SYSTEM
Set to any string to indicate that the output is to include a DOCTYPE declaration with this system id

ENCODING

public static final Serializer.Property ENCODING
Character encoding of output stream

ESCAPE_URI_ATTRIBUTES

public static final Serializer.Property ESCAPE_URI_ATTRIBUTES
Set to "yes" or "no" to indicate (for HTML and XHTML) whether URI-valued attributes should be percent-encoded

INCLUDE_CONTENT_TYPE

public static final Serializer.Property INCLUDE_CONTENT_TYPE
For HTML and XHTML, set to "yes" or "no" to indicate whether a <meta> element is to be written to indicate the content type and encoding

INDENT

public static final Serializer.Property INDENT
Set to "yes" or "no" to indicate whether indentation is required

MEDIA_TYPE

public static final Serializer.Property MEDIA_TYPE
Set to indicate the media type (MIME type) of the output

METHOD

public static final Serializer.Property METHOD
Serialization method: xml, html, xhtml, or text

NORMALIZATION_FORM

public static final Serializer.Property NORMALIZATION_FORM
Set to the name of a Unicode normalization form: "NFC", "NFD", "NFKC", or "NFKD", or "none" to indicate no normalization

OMIT_XML_DECLARATION

public static final Serializer.Property OMIT_XML_DECLARATION
Set to "yes" if the XML declaration is to be omitted from the output file

SAXON_CHARACTER_REPRESENTATION

public static final Serializer.Property SAXON_CHARACTER_REPRESENTATION
Saxon extension to indicate how characters outside the encoding should be represented, for example "hex" for hexadecimal character references, "decimal" for decimal character references

SAXON_DOUBLE_SPACE

public static final Serializer.Property SAXON_DOUBLE_SPACE
Saxon extension: set to a space-separated list of element names, in Clark notation, representing elements that will be preceded by an extra blank line in the output in addition to normal indentation.

SAXON_IMPLICIT_RESULT_DOCUMENT

public static final Serializer.Property SAXON_IMPLICIT_RESULT_DOCUMENT
Saxon extension for internal use in XSLT, indicates that this output document is the implicitly created result tree as distinct from a tree created using <xsl:result-document>

SAXON_INDENT_SPACES

public static final Serializer.Property SAXON_INDENT_SPACES
Saxon extension: set to an integer (represented as a string) giving the number of spaces by which each level of nesting should be indented. Default is 3.

SAXON_NEXT_IN_CHAIN

public static final Serializer.Property SAXON_NEXT_IN_CHAIN
Saxon extension to indicate that output should not be serialized, but should be further transformed. The property gives the relative URI of a stylesheet to be applied. Note that the Serializer class does not recognize this property.

SAXON_NEXT_IN_CHAIN_BASE_URI

public static final Serializer.Property SAXON_NEXT_IN_CHAIN_BASE_URI
Saxon extension, indicate the base URI against which SAXON_NEXT_IN_CHAIN should be resolved.

SAXON_RECOGNIZE_BINARY

public static final Serializer.Property SAXON_RECOGNIZE_BINARY
Saxon extension for use when writing to the text output method; this option causes the processing instructions hex and b64 to be recognized containing hexBinary or base64 data respectively.

SAXON_REQUIRE_WELL_FORMED

public static final Serializer.Property SAXON_REQUIRE_WELL_FORMED
Saxon extension for use when output is sent to a SAX ContentHandler: indicates that the output is required to be well-formed (exactly one top-level element)

SAXON_STYLESHEET_VERSION

public static final Serializer.Property SAXON_STYLESHEET_VERSION
Saxon extension for internal use: used in XSLT to tell the serializer whether the stylesheet used version="1.0" or version="2.0"

SAXON_SUPPLY_SOURCE_LOCATOR

public static final Serializer.Property SAXON_SUPPLY_SOURCE_LOCATOR
Saxon extension for interfacing with debuggers; indicates that the location information is available for events in this output stream

SAXON_SUPPRESS_INDENTATION

public static final Serializer.Property SAXON_SUPPRESS_INDENTATION
Saxon extension: set to a space-separated list of element names, in Clark notation, within which no content is to be indented. This is typically because the element contains mixed content in which whitespace is significant.

SAXON_WRAP

public static final Serializer.Property SAXON_WRAP
Saxon extension, indicates that the output of a query is to be wrapped before serialization, such that each item in the result sequence is enclosed in an element indicating its type

STANDALONE

public static final Serializer.Property STANDALONE
Set to "yes", "no", or "omit" to indicate the required value of the standalone attribute in the XML declaration of the output file

UNDECLARE_PREFIXES

public static final Serializer.Property UNDECLARE_PREFIXES
Set to "yes" or "no" to indicate (for XML 1.1) whether namespace that go out of scope should be undeclared

USE_CHARACTER_MAPS

public static final Serializer.Property USE_CHARACTER_MAPS
List of names of character maps to be used. Character maps can only be specified in an XSLT stylesheet.

VALUES

public static final List<Serializer.Property> VALUES
An immutable list containing the values comprising this enum class in the order they're declared. This field may be used to iterate over the constants as follows:
for(Property c : Property.VALUES)
    System.out.println(c);

VERSION

public static final Serializer.Property VERSION
Version of output method, for example "1.0" or "1.1" for XML

Method Detail

family

public final List<Serializer.Property> family()
Returns an immutable list containing the values comprising this enum class in the order they're declared. This instance method simply returns VALUES. Few programmers should have any need to use this method. It is provided for use by sophisticated enum-based data structures to prevent the need for reflective access to VALUES.

Returns: an immutable list containing the values comprising this enum class, in the order they're declared.

toString

public String toString()
Get the name of the property expressed as a QName in Clark notation. The namespace will be null for standard serialization properties, and will be the Saxon namespace http://saxon.sf.net/ for Saxon extensions

Returns: the name of the serialization property as a QName in Clark notation, {uri}local

valueOf

public static final Serializer.Property valueOf(String name)
Static factory to return the enum constant pertaining to the given string name. The string must match exactly an identifier used to declare an enum constant in this type.

Throws: IllegalArgumentException if this enum class has no constant with the specified name.