Package com.puppycrawl.tools.checkstyle.xpath

Class RootNode

java.lang.Object

com.puppycrawl.tools.checkstyle.xpath.AbstractNode

com.puppycrawl.tools.checkstyle.xpath.RootNode

All Implemented Interfaces:

java.lang.Iterable<net.sf.saxon.om.NodeInfo>, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.expr.parser.Location, net.sf.saxon.om.GroundedValue<net.sf.saxon.om.NodeInfo>, net.sf.saxon.om.Item<net.sf.saxon.om.NodeInfo>, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence<net.sf.saxon.om.NodeInfo>, org.xml.sax.Locator

public class RootNode
extends AbstractNode

Represents root node of Xpath-tree.

Field Summary

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Constructor	Description
RootNode(DetailAST detailAst)	Creates a new RootNode instance.

Method Summary

Modifier and Type	Method	Description
int	compareOrder(net.sf.saxon.om.NodeInfo nodeInfo)	Compares current object with specified for order.
java.lang.String	getAttributeValue(java.lang.String namespace, java.lang.String localPart)	Returns attribute value.
int	getColumnNumber()	Returns column number.
int	getLineNumber()	Returns line number.
java.lang.String	getLocalPart()	Returns local part.
int	getNodeKind()	Returns type of the node.
net.sf.saxon.om.NodeInfo	getParent()	Returns parent.
net.sf.saxon.om.NodeInfo	getRoot()	Returns root of the tree.
int	getTokenType()	Getter method for token type.
DetailAST	getUnderlyingNode()	Returns underlying node.
net.sf.saxon.tree.iter.AxisIterator	iterateAxis(byte axisNumber)	Determines axis iteration algorithm.

Methods inherited from class com.puppycrawl.tools.checkstyle.xpath.AbstractNode

addChild, atomize, copy, generateId, getBaseURI, getChildren, getConfiguration, getDeclaredNamespaces, getDepth, getDisplayName, getFingerprint, getPrefix, getPublicId, getSchemaType, getStringValue, getStringValueCS, getSystemId, getTreeInfo, getURI, hasChildNodes, hasFingerprint, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, iterateAxis, saveLocation, setDepth, setSystemId

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, effectiveBooleanValue, materialize

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

getLength, head, itemAt, iterate, iterator, reduce, subsequence

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

equals, getGenre, hashCode, toShortString

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

makeRepeatable

Methods inherited from interface javax.xml.transform.Source

isEmpty

Constructor Detail

RootNode

public RootNode(DetailAST detailAst)

Creates a new RootNode instance.

Parameters:

detailAst - reference to DetailAST

Method Detail

compareOrder

public int compareOrder(net.sf.saxon.om.NodeInfo nodeInfo)

Compares current object with specified for order. Throws UnsupportedOperationException because functionality not required here.

Parameters:

nodeInfo - another NodeInfo object

Returns:

number representing order of current object to specified one

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String namespace,
                                          java.lang.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 java.lang.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

iterateAxis

public net.sf.saxon.tree.iter.AxisIterator iterateAxis(byte axisNumber)

Determines axis iteration algorithm. Throws UnsupportedOperationException in case, when there is no axis iterator for given axisNumber.

Parameters:

axisNumber - element from AxisInfo

Returns:

AxisIterator object

getLineNumber

public int getLineNumber()

Returns line number.

Returns:

line number

getColumnNumber

public int getColumnNumber()

Returns column number.

Returns:

column number

getTokenType

public int getTokenType()

Getter method for token type.

Specified by:

getTokenType in class AbstractNode

Returns:

token type

getUnderlyingNode

public DetailAST getUnderlyingNode()

Returns underlying node.

Specified by:

getUnderlyingNode in class AbstractNode

Returns:

underlying node