ASTReference (PMD Velocity 7.0.0-rc2 API)

java.lang.Object
- net.sourceforge.pmd.lang.ast.impl.AbstractNode<B,N>
- - net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.vm.ast.AbstractVmNode,VmNode>
  - - net.sourceforge.pmd.lang.vm.ast.ASTReference

All Implemented Interfaces:

GenericNode<VmNode>, JjtreeNode<VmNode>, Node, TextAvailableNode, VmNode, Reportable
```
public final class ASTReference
extends AbstractJjtreeNode<net.sourceforge.pmd.lang.vm.ast.AbstractVmNode,VmNode>
```
This class is responsible for handling the references in VTL ($foo).
Please look at the Parser.jjt file which is what controls the generation of this class.

Version:

$Id: ASTReference.java 806597 2009-08-21 15:21:44Z nbubna $

Author:

Jason van Zyl, Geir Magnusson Jr., Christoph Reck, Kent Johnson

Field Summary
- Fields inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
  id
- Fields inherited from interface net.sourceforge.pmd.lang.ast.Node
  COORDS_COMPARATOR

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<P,R> R`	`acceptVisitor(AstVisitor<? super P,? extends R> visitor, P data)`
`protected <P,R> R`	`acceptVmVisitor(VmVisitor<? super P,? extends R> visitor, P data)`
`String`	`getRootString()`	Returns the 'root string', the reference key.
`String`	`getXPathNodeName()`
`String`	`literal()`	Override of the SimpleNode method literal() Returns the literal representation of the node.
`protected void`	`setImage(String image)`

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
addChild, compareLocation, fitTokensToChildren, getFirstToken, getImage, getLastToken, getTextRegion, insertChild, jjtClose, jjtOpen, setFirstToken, setLastToken, toString

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.AbstractNode
children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, remove, removeChildAtIndex, setChild, setParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode
ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getNthParent, getParent, getPreviousSibling

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode
getFirstToken, getLastToken, tokens

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node
ancestors, children, compareLocation, descendants, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfType, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getParentsOfType, getReportLocation, getRoot, getTextDocument, getUserMap, getXPathAttributesIterator, hasDescendantOfType, hasImageEqualTo, isFindBoundary

Methods inherited from interface net.sourceforge.pmd.lang.ast.TextAvailableNode
getOriginalText, getText, getTextRegion

Methods inherited from interface net.sourceforge.pmd.lang.vm.ast.VmNode
jjtAccept

- Method Detail
  - acceptVmVisitor
```
protected <P,R> R acceptVmVisitor(VmVisitor<? super P,? extends R> visitor,
                                        P data)
```
  - getRootString
```
public String getRootString()
```
    Returns the 'root string', the reference key.
    
    Returns:
    
    the root string.
  - literal
```
public String literal()
```
    Override of the SimpleNode method literal() Returns the literal representation of the node. Should be something like $<token>.
    
    Returns:
    
    A literal string.
  - setImage
```
protected void setImage(String image)
```
    Overrides:
    
    setImage in class AbstractJjtreeNode<net.sourceforge.pmd.lang.vm.ast.AbstractVmNode,VmNode>
  - getXPathNodeName
```
public String getXPathNodeName()
```
    Specified by:
    
    getXPathNodeName in interface Node
  - acceptVisitor
```
public final <P,R> R acceptVisitor(AstVisitor<? super P,? extends R> visitor,
                                         P data)
```
    Specified by:
    
    acceptVisitor in interface Node