org.codehaus.groovy.ast

Class ASTNode

java.lang.Object

org.codehaus.groovy.ast.ASTNode

All Implemented Interfaces:

NodeMetaDataHandler

Direct Known Subclasses:

AnnotatedNode, AnnotationNode, GenericsType, ModifierNode, ModuleNode, Statement

public class ASTNode
extends java.lang.Object
implements NodeMetaDataHandler

Base class for any AST node. This class supports basic information used in all nodes of the AST:

• line and column number information. Usually a node represents a certain area in a text file determined by a starting position and an ending position. For nodes that do not represent this, this information will be -1. A node can also be configured in its line/col information using another node through setSourcePosition(otherNode).
• every node can store meta data. A phase operation or transform can use this to transport arbitrary information to another phase operation or transform. The only requirement is that the other phase operation or transform runs after the part storing the information. If the information transport is done it is strongly recommended to remove that meta data.
• a text representation of this node trough getText(). This was in the past used for assertion messages. Since the usage of power asserts this method will not be called for this purpose anymore and might be removed in future versions of Groovy

Author:

James Strachan, Jochen "blackdrag" Theodorou

Constructor Summary

Constructors

Constructor and Description
ASTNode()

Method Summary

Modifier and Type	Method and Description
void	copyNodeMetaData(ASTNode other) Copies all node meta data from the other node to this one
void	copyNodeMetaData(NodeMetaDataHandler other) Copies all node meta data from the other node to this one
int	getColumnNumber()
int	getLastColumnNumber()
int	getLastLineNumber()
int	getLineNumber()
ListHashMap	getMetaDataMap()
java.util.Map<?,?>	getNodeMetaData() Returns an unmodifiable view of the current node metadata.
<T> T	getNodeMetaData(java.lang.Object key) Gets the node meta data.
java.lang.String	getText()
java.lang.Object	putNodeMetaData(java.lang.Object key, java.lang.Object value) Sets the node meta data but allows overwriting values.
void	removeNodeMetaData(java.lang.Object key) Removes a node meta data entry.
void	setColumnNumber(int columnNumber)
void	setLastColumnNumber(int lastColumnNumber)
void	setLastLineNumber(int lastLineNumber)
void	setLineNumber(int lineNumber)
void	setMetaDataMap(java.util.Map<?,?> metaDataMap)
void	setNodeMetaData(java.lang.Object key, java.lang.Object value) Sets the node meta data.
void	setSourcePosition(ASTNode node) Sets the source position using another ASTNode.
void	visit(GroovyCodeVisitor visitor)

Methods inherited from class java.lang.Object

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

Constructor Detail

ASTNode

public ASTNode()

Method Detail

visit

public void visit(GroovyCodeVisitor visitor)

getText

public java.lang.String getText()

getLineNumber

public int getLineNumber()

setLineNumber

public void setLineNumber(int lineNumber)

getColumnNumber

public int getColumnNumber()

setColumnNumber

public void setColumnNumber(int columnNumber)

getLastLineNumber

public int getLastLineNumber()

setLastLineNumber

public void setLastLineNumber(int lastLineNumber)

getLastColumnNumber

public int getLastColumnNumber()

setLastColumnNumber

public void setLastColumnNumber(int lastColumnNumber)

setSourcePosition

public void setSourcePosition(ASTNode node)

Sets the source position using another ASTNode. The sourcePosition consists of a line/column pair for the start and a line/column pair for the end of the expression or statement

Parameters:

node - - the node used to configure the position information

copyNodeMetaData

public void copyNodeMetaData(ASTNode other)

Copies all node meta data from the other node to this one

Parameters:

other - - the other node

getNodeMetaData

public <T> T getNodeMetaData(java.lang.Object key)

Description copied from interface: NodeMetaDataHandler

Gets the node meta data.

Specified by:

getNodeMetaData in interface NodeMetaDataHandler

Parameters:

key - - the meta data key

Returns:

the node meta data value for this key

copyNodeMetaData

public void copyNodeMetaData(NodeMetaDataHandler other)

Description copied from interface: NodeMetaDataHandler

Copies all node meta data from the other node to this one

Specified by:

copyNodeMetaData in interface NodeMetaDataHandler

Parameters:

other - - the other node

setNodeMetaData

public void setNodeMetaData(java.lang.Object key,
                            java.lang.Object value)

Description copied from interface: NodeMetaDataHandler

Sets the node meta data.

Specified by:

setNodeMetaData in interface NodeMetaDataHandler

Parameters:

key - - the meta data key

value - - the meta data value

putNodeMetaData

public java.lang.Object putNodeMetaData(java.lang.Object key,
                                        java.lang.Object value)

Description copied from interface: NodeMetaDataHandler

Sets the node meta data but allows overwriting values.

Specified by:

putNodeMetaData in interface NodeMetaDataHandler

Parameters:

key - - the meta data key

value - - the meta data value

Returns:

the old node meta data value for this key

removeNodeMetaData

public void removeNodeMetaData(java.lang.Object key)

Description copied from interface: NodeMetaDataHandler

Removes a node meta data entry.

Specified by:

removeNodeMetaData in interface NodeMetaDataHandler

Parameters:

key - - the meta data key

getNodeMetaData

public java.util.Map<?,?> getNodeMetaData()

Description copied from interface: NodeMetaDataHandler

Returns an unmodifiable view of the current node metadata.

Specified by:

getNodeMetaData in interface NodeMetaDataHandler

Returns:

the node metadata. Always not null.

getMetaDataMap

public ListHashMap getMetaDataMap()

Specified by:

getMetaDataMap in interface NodeMetaDataHandler

setMetaDataMap

public void setMetaDataMap(java.util.Map<?,?> metaDataMap)

Specified by:

setMetaDataMap in interface NodeMetaDataHandler