public class EventBuffer extends SequenceReceiver
Note that events are retained along with their properties, so the class implements "sticky disable-output-escaping" - text nodes can have selected characters marked with the disable-escaping property.
pipelineConfiguration, previousAtomic, systemId
Constructor and Description |
---|
EventBuffer(PipelineConfiguration pipe) |
Modifier and Type | Method and Description |
---|---|
void |
append(Item item,
Location location,
int properties)
Append an arbitrary item (node, atomic value, or function) to the output
|
void |
characters(UnicodeString chars,
Location location,
int properties)
Notify character data.
|
void |
close()
Notify the end of the event stream
|
void |
comment(UnicodeString content,
Location location,
int properties)
Notify a comment.
|
void |
endDocument()
Notify the end of a document node
|
void |
endElement()
Notify the end of an element.
|
void |
processingInstruction(java.lang.String name,
UnicodeString data,
Location location,
int properties)
Output a processing instruction
|
void |
replay(Receiver out)
Replay the captured events to a supplied destination
|
void |
startDocument(int properties)
Notify the start of a document node
|
void |
startElement(NodeName elemName,
SchemaType typeCode,
AttributeMap attributes,
NamespaceMap namespaces,
Location location,
int properties)
Notify the start of an element
|
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getNamePool, getPipelineConfiguration, getSystemId, handlesAppend, open, setPipelineConfiguration, setSystemId, setUnparsedEntity
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
usesTypeAnnotations
public EventBuffer(PipelineConfiguration pipe)
public void startDocument(int properties) throws XPathException
Receiver
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOption
XPathException
- if an error occurspublic void endDocument() throws XPathException
Receiver
XPathException
- if an error occurspublic void startElement(NodeName elemName, SchemaType typeCode, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
Receiver
elemName
- the name of the element.typeCode
- the type annotation of the element.attributes
- the attributes of this elementnamespaces
- the in-scope namespaces of this element: generally this is all the in-scope
namespaces, without relying on inheriting namespaces from parent elementslocation
- an object providing information about the module, line, and column where the node originatedproperties
- bit-significant properties of the element node. If there are no relevant
properties, zero is supplied. The definitions of the bits are in class ReceiverOption
XPathException
- if an error occurspublic void endElement() throws XPathException
Receiver
XPathException
- if an error occurspublic void characters(UnicodeString chars, Location location, int properties) throws XPathException
Receiver
chars
- The characterslocation
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void processingInstruction(java.lang.String name, UnicodeString data, Location location, int properties) throws XPathException
Receiver
name
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocation
- provides information such as line number and system ID.properties
- Additional information about the PI.XPathException
- if an error occurspublic void comment(UnicodeString content, Location location, int properties) throws XPathException
Receiver
content
- The content of the commentlocation
- provides information such as line number and system ID.properties
- Additional information about the comment.XPathException
- if an error occurspublic void append(Item item, Location location, int properties) throws XPathException
SequenceReceiver
append
in interface Receiver
append
in class SequenceReceiver
item
- the item to be appendedlocation
- the location of the calling instruction, for diagnosticsproperties
- if the item is an element node, this indicates whether its namespaces
need to be copied. Values are ReceiverOption.ALL_NAMESPACES
; the default (0) meansXPathException
- if an error occurspublic void close() throws XPathException
Receiver
XPathException
- if an error occurspublic void replay(Receiver out) throws XPathException
out
- the destination Receiver
to receive the eventsXPathException
- if any error occursCopyright (c) 2004-2022 Saxonica Limited. All rights reserved.