cetus.hir

Class Annotation

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.Object>

cetus.hir.Annotation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Direct Known Subclasses:

CodeAnnotation, CommentAnnotation, PragmaAnnotation

public abstract class Annotation
extends java.util.HashMap<java.lang.String,java.lang.Object>

Annotation is the base class of any annotation type used in Cetus. Unlike the implementation in the past versions of Cetus, this class is separated from the IR tree to clarify usage of annotations along with their associated IR (either Declaration or Statement).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
void	attach(Annotatable ir) Attaches a link from this annotation to the specified IR.
Annotation	clone() Returns a clone of this annotation object.
void	detach() Removes this annotation from its associated annotatable object.
<T> T	get(java.lang.String key) Returns the annotated value with the specified key.
Annotatable	getAnnotatable() Returns the annotatable object that contains this annotation.
static <T extends Annotation> void	hideAnnotations(Annotatable at, java.lang.Class<T> type) Disables printing of the specified annotation type attached at the given annotatable object.
void	setPosition(int position) Sets the relative position from the associated IR with the given position.
void	setSkipPrint(boolean skip_print) Sets the skip_print field.
abstract java.lang.String	toString() Returns a string representation of the annotation.
java.lang.String	toString(int position) Returns the string representation of this annotation if the given position is equal to the position of this annotation.

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

get

public <T> T get(java.lang.String key)

Returns the annotated value with the specified key.

Parameters:

key - the given string key.

Returns:

the annotated value or null (if not present).

setPosition

public void setPosition(int position)

Sets the relative position from the associated IR with the given position.

Parameters:

position - the new position.

toString

public abstract java.lang.String toString()

Returns a string representation of the annotation. All child classes of Annotation should implement their own toString() method.

Overrides:

toString in class java.util.AbstractMap<java.lang.String,java.lang.Object>

Returns:

the string representation.

toString

public java.lang.String toString(int position)

Returns the string representation of this annotation if the given position is equal to the position of this annotation.

clone

public Annotation clone()

Returns a clone of this annotation object.

Overrides:

clone in class java.util.HashMap<java.lang.String,java.lang.Object>

Returns:

a cloned annotation.

attach

public void attach(Annotatable ir)

Attaches a link from this annotation to the specified IR. Declaration and Statement implement the Annotatable interface.

Parameters:

ir - the associated Cetus IR.

detach

public void detach()

Removes this annotation from its associated annotatable object.

setSkipPrint

public void setSkipPrint(boolean skip_print)

Sets the skip_print field.

getAnnotatable

public Annotatable getAnnotatable()

Returns the annotatable object that contains this annotation.

hideAnnotations

public static <T extends Annotation> void hideAnnotations(Annotatable at,
                                          java.lang.Class<T> type)

Disables printing of the specified annotation type attached at the given annotatable object.

Parameters:

at - the annotatable object of interest (statement or declaration).

type - the annotation type to be hidden.