Class Sink

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver

    public class Sink
    extends SequenceReceiver
    A Sink is a Receiver that discards all information passed to it
    • Method Detail

      • close

        public void close()
        End of event stream
      • startDocument

        public void startDocument​(int properties)
        Start of a document node.
        properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption
      • endDocument

        public void endDocument()
        Notify the end of a document node
      • startElement

        public void startElement​(NodeName elemName,
                                 SchemaType type,
                                 AttributeMap attributes,
                                 NamespaceMap namespaces,
                                 Location location,
                                 int properties)
                          throws XPathException
        Notify the start of an element
        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
        XPathException - if an error occurs
      • endElement

        public void endElement()
        End of element
      • characters

        public void characters​(UnicodeString chars,
                               Location locationId,
                               int properties)
        Character data
        chars - The characters
        locationId - provides information such as line number and system ID.
        properties - Bit significant value. The following bits are defined:
        Disable escaping for this text node
        Output as a CDATA section
      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                          UnicodeString data,
                                          Location locationId,
                                          int properties)
        Processing Instruction
        target - 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.
      • comment

        public void comment​(UnicodeString chars,
                            Location locationId,
                            int properties)
        Output a comment
        chars - The content of the comment
        locationId - provides information such as line number and system ID.
        properties - Additional information about the comment.
      • append

        public void append​(Item item,
                           Location locationId,
                           int copyNamespaces)
        Append an arbitrary item (node or atomic value) to the output
        Specified by:
        append in interface Receiver
        Specified by:
        append in class SequenceReceiver
        item - the item to be appended
        locationId - the location of the calling instruction, for diagnostics
        copyNamespaces - if the item is an element node, this indicates whether its namespaces need to be copied. Values are ReceiverOption.ALL_NAMESPACES; the default (0) means
      • setUnparsedEntity

        public void setUnparsedEntity​(java.lang.String name,
                                      java.lang.String uri,
                                      java.lang.String publicId)
        Set the URI for an unparsed entity in the document.
        Specified by:
        setUnparsedEntity in interface Receiver
        setUnparsedEntity in class SequenceReceiver
        name - The name of the unparsed entity
        uri - The system identifier of the unparsed entity
        publicId - The public identifier of the unparsed entity
      • usesTypeAnnotations

        public boolean usesTypeAnnotations()
        Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events
        true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation