Class Serializer

Build-tree option (XSLT only)

QName identifying the serialization parameter "byte-order-mark"

QName identifying the serialization parameter "cdata-section-elements". The value of this parameter is given as a space-separated list of expanded QNames in Clark notation, that is "{uri}local".

QName identifying the serialization parameter "doctype-public"

QName identifying the serialization parameter "doctype-system"

QName identifying the serialization parameter "encoding"

QName identifying the serialization parameter "escape-uri-attributes". The value is the string "yes" or "no".

HTML version number

QName identifying the serialization parameter "include-content-type". The value is the string "yes" or "no".

QName identifying the serialization parameter "indent". The value is the string "yes" or "no".

Set to a string used to separate adjacent items in an XQuery result sequence

QName identifying the serialization parameter "media-type".

QName identifying the serialization parameter "method". If the method is a user-defined method, then it is given as a QName in Clark notation, that is "{uri}local".

QName identifying the serialization parameter "saxon:next-in-chain". This is available only with XSLT, and identifies the URI of a stylesheet that is to be used to process the results before passing them to their final destination.

QName identifying the serialization parameter "normalization-form"

QName identifying the serialization parameter "omit-xml-declaration". The value is the string "yes" or "no".

Saxon extension: set to a space-separated list of attribute names, in Clark notation, indicating that attributes present in the list should be serialized in the order indicated, followed by attributes not present in the list(these are sorted first by namespace, then by local name).

Saxon extension: request canonical XML output.

QName identifying the serialization parameter "saxon:character-representation"

QName identifying the serialization parameter "saxon:double-space". The value of this parameter is given as a space-separated list of expanded QNames in Clark notation, that is "{uri}local"; each QName identifies an element that should be preceded by an extra blank line within indented output.

QName identifying the serialization parameter "saxon:indent-spaces". The value is an integer (represented as a string) indicating the amount of indentation required. If specified, this parameter overrides indent="no".

Saxon extension: set to an integer (represented as a string) giving the desired maximum length of lines when indenting.Default is 80.

Saxon extension: set to any string. Indicates the sequence of characters used to represent a newline in the text output method, and in newlines used for indentation in any output methods that use indentation.

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.

QName identifying the serialization parameter "saxon:require-well-formed". The value is the string "yes" or "no". If set to "yes", the output must be a well-formed document, or an error will be reported. ("Well-formed" here means that the document node must have exactly one element child, and no text node children other than whitespace-only text nodes).

Saxon extension for internal use: used in XSLT to tell the serializer whether the stylesheet used version="1.0" or version = "2.0"

QName identifying the serialization parameter "suppress-indentation". Retained as a synonym of SUPPRESS_INDENTATION for backwards compatibility.

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

QName identifying the serialization parameter "standalone". The value is the string "yes" or "no" or "omit".

Saxon extension for interfacing with debuggers; indicates that the location information is available for events in this output stream

QName identifying the serialization parameter "suppress-indentation" (introduced in XSLT/XQuery 3.0). Previously available as "saxon:suppress-indentation" The value is the string "yes" or "no" or "omit".

QName identifying the serialization parameter "undeclare-prefixes". The value is the string "yes" or "no".

QName identifying the serialization parameter "use-character-maps". This is available only with XSLT. The value of the parameter is a list of expanded QNames in Clark notation giving the names of character maps defined in the XSLT stylesheet.

QName identifying the serialization parameter "version"

This property determines the base Uri of the constructed Serializer.

Close any resources associated with this destination. Note that this does not close any user-supplied OutputStream or Writer; those must be closed explicitly by the calling application.

Close the destination and notify all registered listeners that it has been closed. This method is intended for internal use by Saxon. The method first calls Serializer.Close to close the destination, then it calls java.util.function.Consumer.accept() on each of the listeners in turn to notify the fact that it has been closed.

Get a character map

Get the current output destination.

The underlying Destination object in the Saxon implementation

Serialize an XdmNode to the selected output destination using this serializer.

Serialize an arbitary XdmValue to the selected output destination using this serializer. The supplied sequence is first wrapped in a document node according to the rules given in section 2 (Sequence Normalization) of the XSLT/XQuery serialization specification; the resulting document node is then serialized using the serialization parameters defined in this serializer. A call on this method will close the writer or output stream internally.

Set a character map to be used

Set default output properties, for use when no explicit properties are set using SetOutputProperty(). The values supplied are typically those specified in the stylesheet or query. In the case of XSLT, they are the properties associated with unamed xsl:output declarations.

Specify the destination of the serialized output, in the form of a file name

Set a serialization property

Specify the destination of the serialized output, in the form of a Stream.

Specify the destination of the serialized output, in the form of a TextWriter.

Set the Processor associated with this Serializer. This will be called automatically if the serializer is created using one of the Processor.NewSerializer() methods.