Package net.sf.saxon.serialize

Class XMLIndenter

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver
    Direct Known Subclasses:
    XMLIndenterPE
    public class XMLIndenter
extends ProxyReceiver
    XMLIndenter: This ProxyReceiver indents elements, by adding character data where appropriate. The character data is always added as "ignorable white space", that is, it is never added adjacent to existing character data.

    • Field Detail

      • indentChars

        protected char[] indentChars

    • Constructor Detail

      • XMLIndenter

        public XMLIndenter​(XMLEmitter next)
        Create an XML Indenter
        Parameters:
        next - the next receiver in the pipeline, always an XMLEmitter

    • Method Detail

      • setOutputProperties

        public void setOutputProperties​(java.util.Properties props)
        Set the properties for this indenter
        Parameters:
        props - the serialization properties

      • startElement

        public void startElement​(NodeName nameCode,
                         SchemaType type,
                         AttributeMap attributes,
                         NamespaceMap namespaces,
                         Location location,
                         int properties)
                  throws XPathException
        Output element start tag
        Specified by:
        startElement in interface Receiver
        Overrides:
        startElement in class ProxyReceiver
        Parameters:
        nameCode - 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

      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                  java.lang.CharSequence data,
                                  Location locationId,
                                  int properties)
                           throws XPathException
        Output a processing instruction
        Specified by:
        processingInstruction in interface Receiver
        Overrides:
        processingInstruction in class ProxyReceiver
        Parameters:
        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.
        Throws:
        XPathException - if an error occurs

      • characters

        public void characters​(java.lang.CharSequence chars,
                       Location locationId,
                       int properties)
                throws XPathException
        Output character data
        Specified by:
        characters in interface Receiver
        Overrides:
        characters in class ProxyReceiver
        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

      • comment

        public void comment​(java.lang.CharSequence chars,
                    Location locationId,
                    int properties)
             throws XPathException
        Output a comment
        Specified by:
        comment in interface Receiver
        Overrides:
        comment in class ProxyReceiver
        Parameters:
        chars - 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()
        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 ProxyReceiver
        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

      • getIndentation

        protected int getIndentation()
        Get the number of spaces to be used for indentation
        Returns:
        the number of spaces to be added to the indentation for each level

      • isDoubleSpaced

        protected boolean isDoubleSpaced​(NodeName name)
        Ask whether a particular element is to be double-spaced
        Parameters:
        name - the element name
        Returns:
        true if double-spacing is in effect for this element

      • getLineLength

        protected int getLineLength()
        Get the suggested maximum length of a line
        Returns:
        the suggested maximum line length (used for wrapping attributes)