Package com.saxonica.serialize
Class BinaryEmitter
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.serialize.Emitter
com.saxonica.serialize.BinaryEmitter
- All Implemented Interfaces:
Result
,Receiver
,ReceiverWithOutputProperties
- Direct Known Subclasses:
Base64BinaryEmitter
,HexBinaryEmitter
This is an abstract superclass for the two binary output methods saxon:base64Binary and saxon:hexBinary.
-
Field Summary
FieldsFields inherited from class net.sf.saxon.serialize.Emitter
allCharactersEncodable, characterSet, outputProperties, writer
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(UnicodeString chars, Location locationId, int properties) Notify character data.void
close()
Notify the end of the event streamvoid
comment
(UnicodeString content, Location locationId, int properties) Notify a comment.void
Notify the end of a document nodevoid
Notify the end of an element.protected OutputStream
makeOutputStream
(StreamResult streamResult) void
open()
Start the output processvoid
processingInstruction
(String name, UnicodeString data, Location locationId, int properties) Output a processing instructionvoid
startDocument
(int properties) Notify the start of a document nodevoid
startElement
(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Notify the start of an elementprotected abstract byte[]
textNodeToBinary
(UnicodeString chars) boolean
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute eventsMethods inherited from class net.sf.saxon.serialize.Emitter
append, getOutputProperties, setMustClose, setOutputProperties, setUnicodeWriter, setUnparsedEntity
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getNamePool, getPipelineConfiguration, getSystemId, handlesAppend, setPipelineConfiguration, setSystemId
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
append, getPipelineConfiguration, handlesAppend, setPipelineConfiguration
Methods inherited from interface javax.xml.transform.Result
getSystemId, setSystemId
-
Field Details
-
outputStream
-
-
Constructor Details
-
BinaryEmitter
- Throws:
XPathException
-
-
Method Details
-
open
Description copied from class:SequenceReceiver
Start the output process- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classSequenceReceiver
- Throws:
XPathException
- if an error occurs
-
startDocument
Description copied from interface:Receiver
Notify the start of a document node- 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
Description copied from interface:Receiver
Notify the end of a document node- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException Description copied from interface:Receiver
Notify the start of an element- 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
-
endElement
Description copied from interface:Receiver
Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.- Throws:
XPathException
- if an error occurs
-
characters
public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException Description copied from interface:Receiver
Notify 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.- Parameters:
chars
- The characterslocationId
- 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
- Throws:
XPathException
- if an error occurs
-
textNodeToBinary
- Throws:
XPathException
-
processingInstruction
public void processingInstruction(String name, UnicodeString data, Location locationId, int properties) throws XPathException Description copied from interface:Receiver
Output a processing instruction- Parameters:
name
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- provides information such as line number and system ID.properties
- Additional information about the PI.- Throws:
XPathException
- if an error occurs
-
comment
public void comment(UnicodeString content, Location locationId, int properties) throws XPathException Description copied from interface:Receiver
Notify a comment. Comments are only notified if they are outside the DTD.- Parameters:
content
- The content of the commentlocationId
- provides information such as line number and system ID.properties
- Additional information about the comment.- Throws:
XPathException
- if an error occurs
-
close
Notify the end of the event stream- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classEmitter
- Throws:
XPathException
- if an error occurs
-
usesTypeAnnotations
public boolean usesTypeAnnotations()Description copied from class:Emitter
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events- Specified by:
usesTypeAnnotations
in interfaceReceiver
- Overrides:
usesTypeAnnotations
in classEmitter
- Returns:
- true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation (or conversely, it may avoid stripping unwanted type annotations)
-
makeOutputStream
- Throws:
XPathException
-