Package net.sf.saxon.event
Class OutputterEventBuffer
- java.lang.Object
-
- net.sf.saxon.event.Outputter
-
- net.sf.saxon.event.OutputterEventBuffer
-
- All Implemented Interfaces:
javax.xml.transform.Result,Receiver
public class OutputterEventBuffer extends Outputter
An EventBuffer is a receiver of events that records the events in memory for subsequent replay. It is used, for example, in the implementation of try/catch, where events cannot be written directly to the final serializer in case an error occurs and is caught.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.
- Since:
- 9.9
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.event.Outputter
pipelineConfiguration, systemId
-
-
Constructor Summary
Constructors Constructor Description OutputterEventBuffer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidappend(Item item, Location location, int properties)Append an arbitrary item (node, atomic value, or function) to the output.voidattribute(NodeName name, SimpleType type, java.lang.CharSequence value, Location location, int properties)Notify an attribute.voidcharacters(java.lang.CharSequence chars, Location location, int properties)Notify character data.voidclose()Notify the end of the event streamvoidcomment(java.lang.CharSequence content, Location location, int properties)Notify a comment.voidendDocument()Notify the end of a document nodevoidendElement()Notify the end of an element.booleanisEmpty()voidnamespace(java.lang.String prefix, java.lang.String uri, int properties)Notify a namespace binding.voidprocessingInstruction(java.lang.String name, java.lang.CharSequence data, Location location, int properties)Output a processing instructionvoidreplay(Outputter out)Replay the captured events to a supplied destinationvoidreset()voidsetBuffer(java.util.List<OutputterEvent> buffer)voidstartContent()Notify the start of the content, that is, the completion of all attributes and namespaces.voidstartDocument(int properties)Notify the start of a document nodevoidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an element, supplying all attributes and namespacesvoidstartElement(NodeName elemName, SchemaType typeCode, Location location, int properties)Notify the start of an element.-
Methods inherited from class net.sf.saxon.event.Outputter
append, getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, open, setPipelineConfiguration, setSystemId, setUnparsedEntity, usesTypeAnnotations
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.event.Receiver
handlesAppend
-
-
-
-
Method Detail
-
setBuffer
public void setBuffer(java.util.List<OutputterEvent> buffer)
-
startDocument
public void startDocument(int properties) throws XPathExceptionDescription copied from class:OutputterNotify the start of a document node- Specified by:
startDocumentin interfaceReceiver- Specified by:
startDocumentin classOutputter- Parameters:
properties- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endDocument
public void endDocument() throws XPathExceptionDescription copied from class:OutputterNotify the end of a document node- Specified by:
endDocumentin interfaceReceiver- Specified by:
endDocumentin classOutputter- Throws:
XPathException- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties)
Description copied from class:OutputterNotify the start of an element. This version ofstartElement()must be followed by calls onOutputter.attribute(NodeName, SimpleType, CharSequence, Location, int)andOutputter.namespace(String, String, int)to supply the attributes and namespaces; these calls may be terminated by a call onOutputter.startContent()but this is not mandatory.- Specified by:
startElementin classOutputter- Parameters:
elemName- the name of the element.typeCode- the type annotation of the element.location- 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 classReceiverOption
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
Description copied from class:OutputterNotify the start of an element, supplying all attributes and namespaces- Specified by:
startElementin interfaceReceiver- Overrides:
startElementin classOutputter- Parameters:
elemName- the name of the element.type- 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 classReceiverOption- Throws:
XPathException- if an error occurs
-
attribute
public void attribute(NodeName name, SimpleType type, java.lang.CharSequence value, Location location, int properties)
Description copied from class:OutputterNotify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Specified by:
attributein classOutputter- Parameters:
name- The name of the attributetype- The type annotation of the attributevalue- the string value of the attributelocation- provides information such as line number and system ID.properties- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this attribute
- NO_SPECIAL_CHARACTERS
- Attribute value contains no special characters
-
namespace
public void namespace(java.lang.String prefix, java.lang.String uri, int properties)Description copied from class:OutputterNotify a namespace binding. This method is called at some point after startElement(). The semantics are similar to the xsl:namespace instruction in XSLT, or the namespace node constructor in XQuery. A namespace must not conflict with any namespaces already used for element or attribute names.- Specified by:
namespacein classOutputter- Parameters:
prefix- The namespace prefix; zero-length string for the default namespaceuri- The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.properties- The REJECT_DUPLICATES property: if set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:
-
startContent
public void startContent()
Description copied from class:OutputterNotify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial Outputter of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.- Overrides:
startContentin classOutputter
-
endElement
public void endElement() throws XPathExceptionDescription copied from class:OutputterNotify the end of an element. The Outputter must maintain a stack if it needs to know which element is ending.- Specified by:
endElementin interfaceReceiver- Specified by:
endElementin classOutputter- Throws:
XPathException- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, Location location, int properties)Description copied from class:OutputterNotify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.- Specified by:
charactersin interfaceReceiver- Specified by:
charactersin classOutputter- Parameters:
chars- The characterslocation- provides information such as line number and system ID.properties- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this text node
- USE_CDATA
- Output as a CDATA section
-
processingInstruction
public void processingInstruction(java.lang.String name, java.lang.CharSequence data, Location location, int properties)Description copied from class:OutputterOutput a processing instruction- Specified by:
processingInstructionin interfaceReceiver- Specified by:
processingInstructionin classOutputter- Parameters:
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.
-
comment
public void comment(java.lang.CharSequence content, Location location, int properties)Description copied from class:OutputterNotify a comment. Comments are only notified if they are outside the DTD.
-
append
public void append(Item item, Location location, int properties)
Description copied from class:OutputterAppend an arbitrary item (node, atomic value, or function) to the output. The default implementation throwsUnsupportedOperationException.- Specified by:
appendin interfaceReceiver- Overrides:
appendin classOutputter- Parameters:
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 areReceiverOption.ALL_NAMESPACES; the default (0) means
-
close
public void close()
Description copied from class:OutputterNotify the end of the event stream
-
replay
public void replay(Outputter out) throws XPathException
Replay the captured events to a supplied destination- Parameters:
out- the destinationReceiverto receive the events- Throws:
XPathException- if any error occurs
-
isEmpty
public boolean isEmpty()
-
reset
public void reset()
-
-