Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ xpath overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.puppycrawl.tools.checkstyle.checks.xpath
Class DocumentNavigator  

java.lang.Object
  DefaultNavigator
      com.puppycrawl.tools.checkstyle.checks.xpath.DocumentNavigator

---

public class DocumentNavigator

extends DefaultNavigator

Navigates around a DetailAST, using XPath semantics. Requires jaxen, http://jaxen.sourceforge.net and saxpath, http://sourceforge.net/projects/saxpath/. Idea shamelessly stolen from the equivalent PMD code (pmd.sourceforge.net).

---

Field Summary
private static java.util.Iterator	EMPTY_ITERATOR           Iterator for an empty sequence

 

Constructor Summary

DocumentNavigator()

 

Method Summary
java.util.Iterator	getAttributeAxisIterator(java.lang.Object aObject)
java.lang.String	getAttributeName(java.lang.Object aObject)
java.lang.String	getAttributeNamespaceUri(java.lang.Object aObject)
java.lang.String	getAttributeQName(java.lang.Object aObject)
java.lang.String	getAttributeStringValue(java.lang.Object aObject)
java.util.Iterator	getChildAxisIterator(java.lang.Object aObject)           Get an iterator over all of this node's children.
java.lang.String	getCommentStringValue(java.lang.Object aObject)
java.lang.Object	getDocumentNode(java.lang.Object aObject)
java.lang.String	getElementName(java.lang.Object aObject)
java.lang.String	getElementNamespaceUri(java.lang.Object aObject)
java.lang.String	getElementQName(java.lang.Object aObject)
java.lang.String	getElementStringValue(java.lang.Object aObject)
java.util.Iterator	getFollowingAxisIterator(java.lang.Object aObject)           Get an iterator over all following nodes, depth-first.
java.util.Iterator	getFollowingSiblingAxisIterator(java.lang.Object aObject)           Get an iterator over all following siblings.
java.lang.String	getNamespacePrefix(java.lang.Object aObject)
java.lang.String	getNamespaceStringValue(java.lang.Object aObject)
java.util.Iterator	getParentAxisIterator(java.lang.Object aObject)           Get a (single-member) iterator over this node's parent.
java.lang.Object	getParentNode(java.lang.Object aObject)
java.util.Iterator	getPrecedingAxisIterator(java.lang.Object aObject)           Get an iterator over all preceding nodes, depth-first.
java.util.Iterator	getPrecedingSiblingAxisIterator(java.lang.Object aObject)           Get an iterator over all preceding siblings.
java.lang.String	getTextStringValue(java.lang.Object aObject)
boolean	isAttribute(java.lang.Object aObject)
boolean	isComment(java.lang.Object aObject)
boolean	isDocument(java.lang.Object aObject)
boolean	isElement(java.lang.Object aObject)
boolean	isNamespace(java.lang.Object aObject)
boolean	isProcessingInstruction(java.lang.Object aObject)
boolean	isText(java.lang.Object aObject)
XPath	parseXPath(java.lang.String aObject)

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

EMPTY_ITERATOR

private static final java.util.Iterator EMPTY_ITERATOR

Iterator for an empty sequence

Constructor Detail

DocumentNavigator

public DocumentNavigator()

Method Detail

getAttributeName

public java.lang.String getAttributeName(java.lang.Object aObject)

---

getAttributeNamespaceUri

public java.lang.String getAttributeNamespaceUri(java.lang.Object aObject)

---

getAttributeQName

public java.lang.String getAttributeQName(java.lang.Object aObject)

---

getAttributeStringValue

public java.lang.String getAttributeStringValue(java.lang.Object aObject)

---

getCommentStringValue

public java.lang.String getCommentStringValue(java.lang.Object aObject)

---

getElementName

public java.lang.String getElementName(java.lang.Object aObject)

---

getElementNamespaceUri

public java.lang.String getElementNamespaceUri(java.lang.Object aObject)

---

getElementQName

public java.lang.String getElementQName(java.lang.Object aObject)

---

getElementStringValue

public java.lang.String getElementStringValue(java.lang.Object aObject)

---

getNamespacePrefix

public java.lang.String getNamespacePrefix(java.lang.Object aObject)

---

getNamespaceStringValue

public java.lang.String getNamespaceStringValue(java.lang.Object aObject)

---

getTextStringValue

public java.lang.String getTextStringValue(java.lang.Object aObject)

---

isAttribute

public boolean isAttribute(java.lang.Object aObject)

---

isComment

public boolean isComment(java.lang.Object aObject)

---

isDocument

public boolean isDocument(java.lang.Object aObject)

---

isElement

public boolean isElement(java.lang.Object aObject)

---

isNamespace

public boolean isNamespace(java.lang.Object aObject)

---

isProcessingInstruction

public boolean isProcessingInstruction(java.lang.Object aObject)

---

isText

public boolean isText(java.lang.Object aObject)

---

parseXPath

public XPath parseXPath(java.lang.String aObject)
                 throws SAXPathException

---

getParentNode

public java.lang.Object getParentNode(java.lang.Object aObject)

---

getAttributeAxisIterator

public java.util.Iterator getAttributeAxisIterator(java.lang.Object aObject)

---

getChildAxisIterator

public java.util.Iterator getChildAxisIterator(java.lang.Object aObject)

Get an iterator over all of this node's children.

---

getParentAxisIterator

public java.util.Iterator getParentAxisIterator(java.lang.Object aObject)

Get a (single-member) iterator over this node's parent.

---

getFollowingSiblingAxisIterator

public java.util.Iterator getFollowingSiblingAxisIterator(java.lang.Object aObject)

Get an iterator over all following siblings.

---

getPrecedingSiblingAxisIterator

public java.util.Iterator getPrecedingSiblingAxisIterator(java.lang.Object aObject)

Get an iterator over all preceding siblings.

---

getFollowingAxisIterator

public java.util.Iterator getFollowingAxisIterator(java.lang.Object aObject)

Get an iterator over all following nodes, depth-first.

---

getPrecedingAxisIterator

public java.util.Iterator getPrecedingAxisIterator(java.lang.Object aObject)

Get an iterator over all preceding nodes, depth-first.

---

getDocumentNode

public java.lang.Object getDocumentNode(java.lang.Object aObject)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ xpath overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---