Package com.puppycrawl.tools.checkstyle.xpath

Class RootNode

java.lang.Object

com.puppycrawl.tools.checkstyle.xpath.AbstractNode

com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode

com.puppycrawl.tools.checkstyle.xpath.RootNode

All Implemented Interfaces:

Source, SourceLocator, net.sf.saxon.lib.ActiveSource, 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

public class RootNode
extends AbstractRootNode

Represents DetailAST's root node of Xpath-tree.

Field Summary

Fields

Modifier and Type	Field	Description
private final DetailAST	detailAst	The ast node.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected List<AbstractNode>	createChildren()	Iterates siblings of the current node and recursively creates new Xpath-nodes.
int	getColumnNumber()	Returns column number.
int	getLineNumber()	Returns line number.
int	getTokenType()	Getter method for token type.
DetailAST	getUnderlyingNode()	Returns underlying node.
boolean	hasChildNodes()	Determine whether the node has any children.

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

compareOrder, getAttributeValue, getDepth, getLocalPart, getNodeKind, getParent, getRoot, iterateAxis

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

atomize, copy, generateId, getAllNamespaces, getBaseURI, getChildren, getConfiguration, getDeclaredNamespaces, getDisplayName, getFingerprint, getNamespaceUri, getPrefix, getPublicId, getSchemaType, getStringValue, getSystemId, getTreeInfo, getUnicodeStringValue, 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.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

asActiveSource, attributes, children, children, deliver, equals, getAttributeValue, getGenre, hashCode, toShortString

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

makeRepeatable

Methods inherited from interface javax.xml.transform.Source

isEmpty

Field Details

detailAst

private final DetailAST detailAst

The ast node.

Constructor Details

RootNode

public RootNode(DetailAST detailAst)

Creates a new RootNode instance.

Parameters:

detailAst - reference to DetailAST

Method Details

createChildren

protected 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.

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. Returns the actual type of the underlying AST root, which is either COMPILATION_UNIT for an ordinary compilation unit or COMPACT_COMPILATION_UNIT for a JEP 512 compact source file.

Specified by:

getTokenType in class AbstractNode

Returns:

token type of the underlying AST root

getUnderlyingNode

public DetailAST getUnderlyingNode()

Returns underlying node.

Specified by:

getUnderlyingNode in class AbstractNode

Returns:

underlying node