Class BinaryEmitter

    • Constructor Detail

      • BinaryEmitter

        public BinaryEmitter()
    • Method Detail

      • usesWriter

        public boolean usesWriter()
        Determine whether the Emitter wants a Writer for character output or an OutputStream for binary output. The standard Emitters all use a Writer, so this returns true; but a subclass can override this if it wants to use an OutputStream
        Overrides:
        usesWriter in class Emitter
        Returns:
        false: this Emitter uses an OutputStream
      • startDocument

        public void startDocument​(int properties)
                           throws XPathException
        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 class ReceiverOption
        Throws:
        XPathException - if an error occurs
      • endDocument

        public void endDocument()
                         throws XPathException
        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 element
        namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
        location - an object providing information about the module, line, and column where the node originated
        properties - 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
        Throws:
        XPathException - if an error occurs
      • endElement

        public void endElement()
                        throws XPathException
        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​(java.lang.CharSequence 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 characters
        locationId - 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

        protected abstract byte[] textNodeToBinary​(java.lang.CharSequence chars)
                                            throws XPathException
        Throws:
        XPathException
      • processingInstruction

        public void processingInstruction​(java.lang.String name,
                                          java.lang.CharSequence 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 instruction
        locationId - 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​(java.lang.CharSequence 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 comment
        locationId - provides information such as line number and system ID.
        properties - Additional information about the comment.
        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 interface Receiver
        Overrides:
        usesTypeAnnotations in class Emitter
        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)