Package com.puppycrawl.tools.checkstyle.xpath

Class AbstractRootNode

java.lang.Object
com.puppycrawl.tools.checkstyle.xpath.AbstractNode
com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
All Implemented Interfaces:
Source, SourceLocator, net.sf.saxon.lib.ActiveSource, net.sf.saxon.om.GNode, 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, Locator
Direct Known Subclasses:
RootNode
public abstract class AbstractRootNode extends AbstractNode
Represents root node of Xpath-tree.

  • Field Details

  • Constructor Details

    • AbstractRootNode

      protected AbstractRootNode()
      Creates a new AbstractRootNode instance.

  • Method Details

    • compareOrder

      public int compareOrder(net.sf.saxon.om.GNode other)
      Compares current object with specified for order. Throws UnsupportedOperationException because functionality not required here.
      Parameters:
      other - another GNode object
      Returns:
      number representing order of current object to specified one

    • getAttributeValue

      public String getAttributeValue(net.sf.saxon.om.NamespaceUri namespace, String localPart)
      Returns attribute value. Throws UnsupportedOperationException because root node has no attributes.
      Parameters:
      namespace - namespace
      localPart - actual name of the attribute
      Returns:
      attribute value

    • getLocalPart

      public String getLocalPart()
      Returns local part.
      Returns:
      local part

    • getNodeKind

      public int getNodeKind()
      Returns type of the node.
      Returns:
      node kind

    • getParent

      public net.sf.saxon.om.NodeInfo getParent()
      Returns parent.
      Returns:
      parent

    • getRoot

      public net.sf.saxon.om.NodeInfo getRoot()
      Returns root of the tree.
      Returns:
      root of the tree

    • iterateAncestorAxis

      public net.sf.saxon.om.SequenceIterator iterateAncestorAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns ancestor axis iterator. Root has no ancestors.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      empty iterator

    • iterateParentAxis

      public net.sf.saxon.om.SequenceIterator iterateParentAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns parent axis iterator. Root has no parent.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      empty iterator

    • iterateFollowingAxis

      public net.sf.saxon.om.SequenceIterator iterateFollowingAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns following axis iterator. Root has no following nodes.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      empty iterator

    • iterateFollowingSiblingAxis

      public net.sf.saxon.om.SequenceIterator iterateFollowingSiblingAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns following-sibling axis iterator. Root has no siblings.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      empty iterator

    • iteratePrecedingAxis

      public net.sf.saxon.om.SequenceIterator iteratePrecedingAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns preceding axis iterator. Root has no preceding nodes.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      empty iterator

    • iteratePrecedingSiblingAxis

      public net.sf.saxon.om.SequenceIterator iteratePrecedingSiblingAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns preceding-sibling axis iterator. Root has no siblings.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      empty iterator

    • iterateAncestorOrSelfAxis

      public net.sf.saxon.om.SequenceIterator iterateAncestorOrSelfAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns ancestor-or-self axis iterator.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      iterator over the current node

    • iterateSelfAxis

      public net.sf.saxon.om.SequenceIterator iterateSelfAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns self axis iterator.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      iterator over the current node

    • iterateChildAxis

      public net.sf.saxon.om.SequenceIterator iterateChildAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns child axis iterator.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      iterator over the children

    • iterateDescendantAxis

      public net.sf.saxon.om.SequenceIterator iterateDescendantAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns descendant axis iterator.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      iterator over the descendants

    • iterateDescendantOrSelfAxis

      public net.sf.saxon.om.SequenceIterator iterateDescendantOrSelfAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Returns descendant-or-self axis iterator.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      iterator over the current node and its descendants

    • iterateAttributeAxis

      public net.sf.saxon.om.SequenceIterator iterateAttributeAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Attribute axis is not supported for the root node.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      never

    • iterateNamespaceAxis

      public net.sf.saxon.om.SequenceIterator iterateNamespaceAxis(net.sf.saxon.pattern.nodetest.NodePredicate predicate)
      Namespace axis is not supported for the root node.
      Parameters:
      predicate - filter for the iterator, may be null
      Returns:
      never

    • getDepth

      public int getDepth()
      Getter method for node depth.
      Specified by:
      getDepth in class AbstractNode
      Returns:
      always 0

    • createEmptyIterator

      private static net.sf.saxon.om.SequenceIterator createEmptyIterator()
      Creates an iterator without items.
      Returns:
      the shared empty iterator

    • throwUnsupportedOperationException

      private static UnsupportedOperationException throwUnsupportedOperationException()
      Returns UnsupportedOperationException exception.
      Returns:
      UnsupportedOperationException exception