Package com.puppycrawl.tools.checkstyle.xpath

Class AbstractNode

  • All Implemented Interfaces:
    javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.om.GroundedValue, net.sf.saxon.om.Item, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.s9api.Location, org.xml.sax.Locator
    Direct Known Subclasses:
    AttributeNode, ElementNode, RootNode
    public abstract class AbstractNode
extends java.lang.Object
implements net.sf.saxon.om.NodeInfo
    Represents general class for ElementNode, RootNode and AttributeNode.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.List<AbstractNode> children
      The children.
      private net.sf.saxon.om.TreeInfo treeInfo
      The TreeInfo object.

      • Fields inherited from interface net.sf.saxon.om.NodeInfo

        IS_DTD_TYPE, IS_NILLED

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractNode​(net.sf.saxon.om.TreeInfo treeInfo)
      Constructor of the abstract class AbstractNode.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      net.sf.saxon.om.AtomicSequence atomize()
      Returns AtomicSequence.
      void copy​(net.sf.saxon.event.Receiver receiver, int index, net.sf.saxon.s9api.Location location)
      Copy method.
      protected abstract java.util.List<AbstractNode> createChildren()
      Creates nodes for children.
      private static java.lang.UnsupportedOperationException createUnsupportedOperationException()
      Returns UnsupportedOperationException exception.
      void generateId​(net.sf.saxon.tree.util.FastStringBuffer fastStringBuffer)
      Generate id method.
      net.sf.saxon.om.NamespaceMap getAllNamespaces()
      Returns namespace array.
      java.lang.String getBaseURI()
      Returns base uri.
      protected java.util.List<AbstractNode> getChildren()
      Getter method for children.
      net.sf.saxon.Configuration getConfiguration()
      Returns configuration.
      net.sf.saxon.om.NamespaceBinding[] getDeclaredNamespaces​(net.sf.saxon.om.NamespaceBinding[] namespaceBindings)
      Returns namespace array.
      abstract int getDepth()
      Getter method for node depth.
      java.lang.String getDisplayName()
      Returns display name.
      int getFingerprint()
      Returns fingerprint.
      java.lang.String getPrefix()
      Returns prefix.
      java.lang.String getPublicId()
      Returns public id.
      net.sf.saxon.type.SchemaType getSchemaType()
      Returns type of the schema.
      java.lang.String getStringValue()
      Returns string value.
      java.lang.CharSequence getStringValueCS()
      Returns CharSequence string value.
      java.lang.String getSystemId()
      Returns system id.
      abstract int getTokenType()
      Getter method for token type.
      net.sf.saxon.om.TreeInfo getTreeInfo()
      Returns tree info.
      abstract DetailAST getUnderlyingNode()
      Returns underlying node.
      java.lang.String getURI()
      Returns uri of the namespace for the current node.
      boolean hasFingerprint()
      Returns if implementation provides fingerprints.
      boolean isId()
      Returns boolean.
      boolean isIdref()
      Returns boolean.
      boolean isNilled()
      Returns boolean.
      boolean isSameNodeInfo​(net.sf.saxon.om.NodeInfo nodeInfo)
      Returns true if nodes are same, false otherwise.
      boolean isStreamed()
      Returns boolean.
      net.sf.saxon.tree.iter.AxisIterator iterateAxis​(int axisNumber, java.util.function.Predicate<? super net.sf.saxon.om.NodeInfo> nodeTest)
      Determines axis iteration algorithm.
      net.sf.saxon.s9api.Location saveLocation()
      Returns location.
      void setSystemId​(java.lang.String systemId)
      Sets system id.

      • 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.om.GroundedValue

        asIterable, concatenate, containsNode, effectiveBooleanValue, materialize

      • Methods inherited from interface net.sf.saxon.om.Item

        getLength, head, itemAt, iterate, reduce, subsequence

      • Methods inherited from interface net.sf.saxon.om.NodeInfo

        attributes, children, children, compareOrder, equals, getAttributeValue, getColumnNumber, getGenre, getLineNumber, getLocalPart, getNodeKind, getParent, getRoot, hasChildNodes, hashCode, iterateAxis, toShortString

      • Methods inherited from interface net.sf.saxon.om.Sequence

        makeRepeatable

      • Methods inherited from interface javax.xml.transform.Source

        isEmpty

    • Field Detail

      • treeInfo

        private final net.sf.saxon.om.TreeInfo treeInfo
        The TreeInfo object.

    • Constructor Detail

      • AbstractNode

        protected AbstractNode​(net.sf.saxon.om.TreeInfo treeInfo)
        Constructor of the abstract class AbstractNode.
        Parameters:
        treeInfo - TreeInfo object

    • Method Detail

      • getTokenType

        public abstract int getTokenType()
        Getter method for token type.
        Returns:
        token type

      • getDepth

        public abstract int getDepth()
        Getter method for node depth.
        Returns:
        depth

      • createChildren

        protected abstract java.util.List<AbstractNode> createChildren()
        Creates nodes for children.
        Returns:
        children list

      • getChildren

        protected java.util.List<AbstractNode> getChildren()
        Getter method for children.
        Returns:
        children list

      • isSameNodeInfo

        public boolean isSameNodeInfo​(net.sf.saxon.om.NodeInfo nodeInfo)
        Returns true if nodes are same, false otherwise.
        Specified by:
        isSameNodeInfo in interface net.sf.saxon.om.NodeInfo
        Parameters:
        nodeInfo - other node
        Returns:
        TreeInfo

      • hasFingerprint

        public boolean hasFingerprint()
        Returns if implementation provides fingerprints.
        Specified by:
        hasFingerprint in interface net.sf.saxon.om.NodeInfo
        Returns:
        boolean

      • getURI

        public java.lang.String getURI()
        Returns uri of the namespace for the current node.
        Specified by:
        getURI in interface net.sf.saxon.om.NodeInfo
        Returns:
        uri

      • iterateAxis

        public net.sf.saxon.tree.iter.AxisIterator iterateAxis​(int axisNumber,
                                                       java.util.function.Predicate<? super net.sf.saxon.om.NodeInfo> nodeTest)
        Determines axis iteration algorithm.
        Specified by:
        iterateAxis in interface net.sf.saxon.om.NodeInfo
        Parameters:
        axisNumber - element from AxisInfo
        nodeTest - filter for iterator
        Returns:
        AxisIterator object

      • getTreeInfo

        public final net.sf.saxon.om.TreeInfo getTreeInfo()
        Returns tree info.
        Specified by:
        getTreeInfo in interface net.sf.saxon.om.NodeInfo
        Returns:
        tree info

      • getStringValue

        public java.lang.String getStringValue()
        Returns string value. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getStringValue in interface net.sf.saxon.om.GroundedValue
        Specified by:
        getStringValue in interface net.sf.saxon.om.Item
        Specified by:
        getStringValue in interface net.sf.saxon.om.NodeInfo
        Returns:
        string value

      • getDeclaredNamespaces

        public final net.sf.saxon.om.NamespaceBinding[] getDeclaredNamespaces​(net.sf.saxon.om.NamespaceBinding[] namespaceBindings)
        Returns namespace array. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getDeclaredNamespaces in interface net.sf.saxon.om.NodeInfo
        Parameters:
        namespaceBindings - namespace array
        Returns:
        namespace array

      • getAllNamespaces

        public net.sf.saxon.om.NamespaceMap getAllNamespaces()
        Returns namespace array. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getAllNamespaces in interface net.sf.saxon.om.NodeInfo
        Returns:
        namespace map

      • isId

        public final boolean isId()
        Returns boolean. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        isId in interface net.sf.saxon.om.NodeInfo
        Returns:
        boolean

      • isIdref

        public final boolean isIdref()
        Returns boolean. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        isIdref in interface net.sf.saxon.om.NodeInfo
        Returns:
        boolean

      • isNilled

        public final boolean isNilled()
        Returns boolean. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        isNilled in interface net.sf.saxon.om.NodeInfo
        Returns:
        boolean

      • isStreamed

        public final boolean isStreamed()
        Returns boolean. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        isStreamed in interface net.sf.saxon.om.Item
        Specified by:
        isStreamed in interface net.sf.saxon.om.NodeInfo
        Returns:
        boolean

      • getConfiguration

        public final net.sf.saxon.Configuration getConfiguration()
        Returns configuration. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getConfiguration in interface net.sf.saxon.om.NodeInfo
        Returns:
        configuration

      • setSystemId

        public final void setSystemId​(java.lang.String systemId)
        Sets system id. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        setSystemId in interface javax.xml.transform.Source
        Parameters:
        systemId - system id

      • getSystemId

        public final java.lang.String getSystemId()
        Returns system id. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getSystemId in interface net.sf.saxon.s9api.Location
        Specified by:
        getSystemId in interface org.xml.sax.Locator
        Specified by:
        getSystemId in interface net.sf.saxon.om.NodeInfo
        Specified by:
        getSystemId in interface javax.xml.transform.Source
        Specified by:
        getSystemId in interface javax.xml.transform.SourceLocator
        Returns:
        system id

      • getPublicId

        public final java.lang.String getPublicId()
        Returns public id. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getPublicId in interface net.sf.saxon.s9api.Location
        Specified by:
        getPublicId in interface org.xml.sax.Locator
        Specified by:
        getPublicId in interface net.sf.saxon.om.NodeInfo
        Specified by:
        getPublicId in interface javax.xml.transform.SourceLocator
        Returns:
        public id

      • getBaseURI

        public final java.lang.String getBaseURI()
        Returns base uri. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getBaseURI in interface net.sf.saxon.om.NodeInfo
        Returns:
        base uri

      • saveLocation

        public final net.sf.saxon.s9api.Location saveLocation()
        Returns location. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        saveLocation in interface net.sf.saxon.s9api.Location
        Returns:
        location

      • getStringValueCS

        public final java.lang.CharSequence getStringValueCS()
        Returns CharSequence string value. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getStringValueCS in interface net.sf.saxon.om.GroundedValue
        Specified by:
        getStringValueCS in interface net.sf.saxon.om.Item
        Returns:
        CharSequence string value

      • getFingerprint

        public final int getFingerprint()
        Returns fingerprint. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getFingerprint in interface net.sf.saxon.om.NodeInfo
        Returns:
        fingerprint

      • getDisplayName

        public final java.lang.String getDisplayName()
        Returns display name. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getDisplayName in interface net.sf.saxon.om.NodeInfo
        Returns:
        display name

      • getPrefix

        public final java.lang.String getPrefix()
        Returns prefix. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getPrefix in interface net.sf.saxon.om.NodeInfo
        Returns:
        prefix

      • getSchemaType

        public final net.sf.saxon.type.SchemaType getSchemaType()
        Returns type of the schema. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        getSchemaType in interface net.sf.saxon.om.NodeInfo
        Returns:
        type of the schema

      • atomize

        public final net.sf.saxon.om.AtomicSequence atomize()
        Returns AtomicSequence. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        atomize in interface net.sf.saxon.om.Item
        Specified by:
        atomize in interface net.sf.saxon.om.NodeInfo
        Returns:
        AtomicSequence

      • generateId

        public final void generateId​(net.sf.saxon.tree.util.FastStringBuffer fastStringBuffer)
        Generate id method. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        generateId in interface net.sf.saxon.om.NodeInfo
        Parameters:
        fastStringBuffer - fastStringBuffer

      • copy

        public final void copy​(net.sf.saxon.event.Receiver receiver,
                       int index,
                       net.sf.saxon.s9api.Location location)
        Copy method. Throws UnsupportedOperationException, because no child class implements it and this method is not used for querying.
        Specified by:
        copy in interface net.sf.saxon.om.NodeInfo
        Parameters:
        receiver - receiver
        index - index
        location - location

      • createUnsupportedOperationException

        private static java.lang.UnsupportedOperationException createUnsupportedOperationException()
        Returns UnsupportedOperationException exception. Methods which throws this exception are not supported for all nodes.
        Returns:
        UnsupportedOperationException exception