Package 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:

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 ElementNode
extends AbstractNode

Represents element node of Xpath-tree.

Field Summary

Fields

Modifier and Type	Field	Description
private static AttributeNode	ATTRIBUTE_NODE_UNINITIALIZED	Holder value for lazy creation of attribute node.
private AttributeNode	attributeNode	The text attribute node.
private int	depth	Depth of the node.
private DetailAST	detailAst	The ast node.
private static AbstractNode[]	EMPTY_ABSTRACT_NODE_ARRAY	Constant for optimization.
private int	indexAmongSiblings	Represents index among siblings.
private AbstractNode	parent	The parent of the current node.
private AbstractNode	root	The root node.
private static java.lang.String	TEXT_ATTRIBUTE_NAME	String literal for text attribute.

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private static int	compareCommonAncestorChildrenOrder(net.sf.saxon.om.NodeInfo first, net.sf.saxon.om.NodeInfo second)	Walks up the hierarchy until a common ancestor is found.
int	compareOrder(net.sf.saxon.om.NodeInfo other)	Compares current object with specified for order.
protected java.util.List<AbstractNode>	createChildren()	Iterates children of the current node and recursively creates new Xpath-nodes.
private AttributeNode	getAttributeNode()	Checks if token type supports @text attribute, extracts its value, creates AttributeNode object and returns it.
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.
private java.util.List<AbstractNode>	getFollowingSiblings()	Returns following siblings of the current node.
private net.sf.saxon.tree.iter.AxisIterator	getFollowingSiblingsIterator()	Returns following sibling axis iterator.
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.
private java.util.List<AbstractNode>	getPrecedingSiblings()	Returns preceding siblings of the current node.
private net.sf.saxon.tree.iter.AxisIterator	getPrecedingSiblingsIterator()	Returns preceding sibling axis iterator.
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.
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.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

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

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

makeRepeatable

Methods inherited from interface javax.xml.transform.Source

isEmpty

Field Detail

TEXT_ATTRIBUTE_NAME

private static final java.lang.String TEXT_ATTRIBUTE_NAME

String literal for text attribute.

See Also:

Constant Field Values

EMPTY_ABSTRACT_NODE_ARRAY

private static final AbstractNode[] EMPTY_ABSTRACT_NODE_ARRAY

Constant for optimization.

ATTRIBUTE_NODE_UNINITIALIZED

private static final AttributeNode ATTRIBUTE_NODE_UNINITIALIZED

Holder value for lazy creation of attribute node.

root

private final AbstractNode root

The root node.

parent

private final AbstractNode parent

The parent of the current node.

detailAst

private final DetailAST detailAst

The ast node.

depth

private final int depth

Depth of the node.

indexAmongSiblings

private final int indexAmongSiblings

Represents index among siblings.

attributeNode

private AttributeNode attributeNode

The text attribute node.

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

compareCommonAncestorChildrenOrder

private static int compareCommonAncestorChildrenOrder(net.sf.saxon.om.NodeInfo first,
                                                      net.sf.saxon.om.NodeInfo second)

Walks up the hierarchy until a common ancestor is found. Then compares topmost sibling nodes.

Parameters:

first - NodeInfo to compare

second - NodeInfo to compare

Returns:

the value 0 if first == second; a value less than 0 if first should be first; a value greater than 0 if second should be first.

getDepth

public int getDepth()

Getter method for node depth.

Specified by:

getDepth in class AbstractNode

Returns:

depth

createChildren

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

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

getPrecedingSiblingsIterator

private net.sf.saxon.tree.iter.AxisIterator getPrecedingSiblingsIterator()

Returns preceding sibling axis iterator.

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

Returns:

iterator

getFollowingSiblingsIterator

private net.sf.saxon.tree.iter.AxisIterator getFollowingSiblingsIterator()

Returns following sibling axis iterator.

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

Returns:

iterator

getFollowingSiblings

private java.util.List<AbstractNode> getFollowingSiblings()

Returns following siblings of the current node.

Returns:

siblings

getPrecedingSiblings

private java.util.List<AbstractNode> getPrecedingSiblings()

Returns preceding siblings of the current node.

Returns:

siblings

getAttributeNode

private AttributeNode getAttributeNode()

Checks if token type supports @text attribute, extracts its value, creates AttributeNode object and returns it. Value can be accessed using @text attribute.

Returns:

attribute node if possible, otherwise the null value

throwUnsupportedOperationException

private static java.lang.UnsupportedOperationException throwUnsupportedOperationException()

Returns UnsupportedOperationException exception.

Returns:

UnsupportedOperationException exception