Package net.sf.saxon.serialize
Class UncommittedSerializer
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.serialize.UncommittedSerializer
This class is used when the decision on which serialization method to use has to be delayed until the first
element is read. It buffers comments and processing instructions until that happens; then when the first
element arrives it creates a real serialization pipeline and uses that for future output.
- Author:
- Michael H. Kay
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) boolean
(package private) Result
(package private) Properties
(package private) List<net.sf.saxon.serialize.UncommittedSerializer.PendingNode>
Fields inherited from class net.sf.saxon.event.ProxyReceiver
nextReceiver
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
ConstructorsConstructorDescriptionUncommittedSerializer
(Result finalResult, Receiver next, Properties outputProperties) Create an uncommitted Serializer -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(CharSequence chars, int locationId, int properties) Produce character output using the current Writer.void
close()
End of documentvoid
comment
(CharSequence chars, int locationId, int properties) Output a commentvoid
open()
Start of event streamvoid
processingInstruction
(String target, CharSequence data, int locationId, int properties) Processing Instructionvoid
startElement
(NodeName elemName, SchemaType typeCode, int locationId, int properties) Output an element start tag.Methods inherited from class net.sf.saxon.event.ProxyReceiver
append, attribute, endDocument, endElement, getNamePool, getUnderlyingReceiver, namespace, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument, usesTypeAnnotations
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, getConfiguration, getPipelineConfiguration, getSystemId
-
Field Details
-
committed
boolean committed -
pending
List<net.sf.saxon.serialize.UncommittedSerializer.PendingNode> pending -
finalResult
Result finalResult -
outputProperties
Properties outputProperties
-
-
Constructor Details
-
UncommittedSerializer
Create an uncommitted Serializer- Parameters:
finalResult
- the output destinationnext
- the next receiver in the pipelineoutputProperties
- the serialization properties
-
-
Method Details
-
open
Description copied from class:ProxyReceiver
Start of event stream- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
close
End of document- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
characters
Produce character output using the current Writer.- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.properties
- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this text node
- USE_CDATA
- Output as a CDATA section
- Throws:
XPathException
- if an error occurs
-
processingInstruction
public void processingInstruction(String target, CharSequence data, int locationId, int properties) throws XPathException Processing Instruction- Specified by:
processingInstruction
in interfaceReceiver
- Overrides:
processingInstruction
in classProxyReceiver
- Parameters:
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.properties
- Additional information about the PI.- Throws:
XPathException
- if an error occurs
-
comment
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.properties
- Additional information about the comment.- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties) throws XPathException Output an element start tag.
This can only be called once: it switches to a substitute output generator for XML, XHTML, or HTML, depending on the element name.- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- Parameters:
elemName
- The element name (tag)typeCode
- The type annotationproperties
- Bit field holding special properties of the elementlocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- Throws:
XPathException
- if an error occurs
-