com.puppycrawl.tools.checkstyle.xpath

Class ElementNode

java.lang.Object

com.puppycrawl.tools.checkstyle.xpath.AbstractNode

com.puppycrawl.tools.checkstyle.xpath.ElementNode

All Implemented Interfaces:

Source, 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, Locator

public class ElementNode
extends AbstractNode

Represents element node of Xpath-tree.

Field Summary

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Constructor and Description
ElementNode(AbstractNode root, AbstractNode parent, DetailAST detailAst, int depth, int indexAmongSiblings) Creates a new ElementNode instance.

Method Summary

Modifier and Type	Method and Description
int	compareOrder(net.sf.saxon.om.NodeInfo other) Compares current object with specified for order.
protected List<AbstractNode>	createChildren() Iterates children of the current node and recursively creates new Xpath-nodes.
String	getAttributeValue(String namespace, String localPart) Returns attribute value.
int	getColumnNumber() Returns column number.
int	getDepth() Getter method for node depth.
int	getLineNumber() Returns line number.
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.
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.

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

Constructor Detail

ElementNode

public ElementNode(AbstractNode root,
                   AbstractNode parent,
                   DetailAST detailAst,
                   int depth,
                   int indexAmongSiblings)

Creates a new ElementNode instance.

Parameters:

root - Node root of the tree

parent - Node parent of the current node

detailAst - reference to DetailAST

depth - the current node depth in the hierarchy

indexAmongSiblings - the current node index among the parent children nodes

Method Detail

compareOrder

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

Compares current object with specified for order.

Parameters:

other - another NodeInfo object

Returns:

number representing order of current object to specified one

getDepth

public int getDepth()

Getter method for node depth.

Specified by:

getDepth in class AbstractNode

Returns:

depth

createChildren

protected List<AbstractNode> createChildren()

Iterates children 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 String getAttributeValue(String namespace,
                                String localPart)

Returns attribute value. Throws UnsupportedOperationException in case, when name of the attribute is not equal to 'text'.

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.

Returns:

root

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.

Reason of suppression for resource, IOResourceOpenedButNotSafelyClosed: AxisIterator implements Closeable interface, but none of the subclasses of the AxisIterator class has non-empty close() method.

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