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:

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

public class RootNode
extends AbstractNode

Represents root node of Xpath-tree.

Field Summary

Fields

Modifier and Type	Field and Description
private DetailAST	detailAst The ast node.
private static AbstractNode[]	EMPTY_ABSTRACT_NODE_ARRAY Constant for optimization.
private static java.lang.String	ROOT_NAME Name of the root element.

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareOrder(net.sf.saxon.om.NodeInfo nodeInfo) Compares current object with specified for order.
protected java.util.List<AbstractNode>	createChildren() Iterates siblings of the current node and recursively creates new Xpath-nodes.
java.lang.String	getAttributeValue(java.lang.String namespace, java.lang.String localPart) Returns attribute value.
int	getColumnNumber() Returns column number.
int	getDepth() Getter method for node depth.
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.
boolean	hasChildNodes() Determine whether the node has any children.
net.sf.saxon.tree.iter.AxisIterator	iterateAxis(int axisNumber) Determines axis iteration algorithm.
private static java.lang.UnsupportedOperationException	throwUnsupportedOperationException() Returns UnsupportedOperationException exception.

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

atomize, copy, generateId, getAllNamespaces, getBaseURI, getChildren, getConfiguration, getDeclaredNamespaces, getDisplayName, getFingerprint, getPrefix, getPublicId, getSchemaType, getStringValue, getStringValueCS, getSystemId, getTreeInfo, getURI, hasFingerprint, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, iterateAxis, saveLocation, 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.NodeInfo

attributes, children, children, equals, getGenre, hashCode, toShortString

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

getLength, head, itemAt, iterate, reduce, subsequence, toGroundedValue

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

asIterable, concatenate, containsNode, effectiveBooleanValue, materialize

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

makeRepeatable

Field Detail

ROOT_NAME

private static final java.lang.String ROOT_NAME

Name of the root element.

See Also:

Constant Field Values

EMPTY_ABSTRACT_NODE_ARRAY

private static final AbstractNode[] EMPTY_ABSTRACT_NODE_ARRAY

Constant for optimization.

detailAst

private final DetailAST detailAst

The ast node.

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

createChildren

protected java.util.List<AbstractNode> createChildren()

Iterates siblings of the current node and recursively creates new Xpath-nodes.

Specified by:

createChildren in class AbstractNode

Returns:

children list

hasChildNodes

public boolean hasChildNodes()

Determine whether the node has any children.

Returns:

true is the node has any children.

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(int 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

getDepth

public int getDepth()

Getter method for node depth.

Specified by:

getDepth in class AbstractNode

Returns:

always 0

throwUnsupportedOperationException

private static java.lang.UnsupportedOperationException throwUnsupportedOperationException()

Returns UnsupportedOperationException exception.

Returns:

UnsupportedOperationException exception