org.codehaus.groovy.ast

Class NodeMetaDataHandlerHelper

java.lang.Object

org.codehaus.groovy.ast.NodeMetaDataHandlerHelper

public class NodeMetaDataHandlerHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
NodeMetaDataHandlerHelper(NodeMetaDataHandler delegate)

Method Summary

Modifier and Type	Method and Description
void	copyNodeMetaData(NodeMetaDataHandler other) Copies all node meta data from the other node to this one
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.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	setNodeMetaData(java.lang.Object key, java.lang.Object value) Sets the node meta data.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeMetaDataHandlerHelper

public NodeMetaDataHandlerHelper(NodeMetaDataHandler delegate)

Method Detail

getNodeMetaData

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

Gets the node meta data.

Parameters:

key - - the meta data key

Returns:

the node meta data value for this key

copyNodeMetaData

public void copyNodeMetaData(NodeMetaDataHandler other)

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

Parameters:

other - - the other node

setNodeMetaData

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

Sets the node meta data.

Parameters:

key - - the meta data key

value - - the meta data value

Throws:

GroovyBugError - if key is null or there is already meta data under that key

putNodeMetaData

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

Sets the node meta data but allows overwriting values.

Parameters:

key - - the meta data key

value - - the meta data value

Returns:

the old node meta data value for this key

Throws:

GroovyBugError - if key is null

removeNodeMetaData

public void removeNodeMetaData(java.lang.Object key)

Removes a node meta data entry.

Parameters:

key - - the meta data key

Throws:

GroovyBugError - if the key is null

getNodeMetaData

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

Returns an unmodifiable view of the current node metadata.

Returns:

the node metadata. Always not null.