AnnotatedElement (Jikes RVM API)

java.lang.Object
- org.jikesrvm.classloader.AnnotatedElement

All Implemented Interfaces:

AnnotatedElement

Direct Known Subclasses:

RVMMember, RVMType
```
public abstract class AnnotatedElement
extends Object
implements AnnotatedElement
```
A common abstract super class for all elements that can be annotated within the JVM. Namely classes, methods and fields.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Object`	`declaredAnnotationDatas` Annotations from the class file that are described as runtime visible.
`private Annotation[]`	`declaredAnnotations` Cached array of declared annotations.
`private static Annotation[]`	`emptyAnnotationArray` Empty annotation array

Constructor Summary

Constructors
Modifier Constructor and Description

protected AnnotatedElement(RVMAnnotation[] annotations)
Constructor used by all annotated elements

Constructors
Modifier	Constructor and Description
`protected`	`AnnotatedElement(RVMAnnotation[] annotations)` Constructor used by all annotated elements

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private Annotation[]`	`cloneAnnotations(Annotation[] internal)`
`<T extends Annotation> T`	`getAnnotation(Class<T> annotationClass)` Get the annotation implementing the specified class or null
`Annotation[]`	`getAnnotations()` Get the annotations for this and all super annotated elements.
`(package private) Annotation[]`	`getAnnotationsInternal()`
`Annotation[]`	`getDeclaredAnnotations()` Get the annotations for this annotated element
`(package private) Annotation[]`	`getDeclaredAnnotationsInternal()`
`boolean`	`hasAnnotations()`
`boolean`	`hasBaselineNoRegistersAnnotation()`
`boolean`	`hasBaselineSaveLSRegistersAnnotation()`
`boolean`	`hasInlineAnnotation()`
`boolean`	`hasInterruptibleAnnotation()`
`boolean`	`hasLogicallyUninterruptibleAnnotation()`
`boolean`	`hasNoBoundsCheckAnnotation()`
`boolean`	`hasNoCheckStoreAnnotation()`
`boolean`	`hasNoEscapesAnnotation()`
`boolean`	`hasNoInlineAnnotation()`
`boolean`	`hasNonMovingAllocationAnnotation()`
`boolean`	`hasNonMovingAnnotation()`
`boolean`	`hasNoNullCheckAnnotation()`
`boolean`	`hasNoOptCompileAnnotation()`
`boolean`	`hasPreemptibleAnnotation()`
`boolean`	`hasPureAnnotation()`
`boolean`	`hasRuntimeFinalAnnotation()`
`boolean`	`hasRuntimePureAnnotation()`
`boolean`	`hasUninterruptibleAnnotation()`
`boolean`	`hasUninterruptibleNoWarnAnnotation()`
`boolean`	`hasUnpreemptibleAnnotation()`
`boolean`	`hasUnpreemptibleNoWarnAnnotation()`
`boolean`	`hasUntracedAnnotation()`
`(package private) boolean`	`isAnnotationDeclared(TypeReference annotationTypeRef)` Checks if an annotation is declared.
`boolean`	`isAnnotationPresent(Class<? extends Annotation> annotationClass)` Is there an annotation of this type implemented on this annotated element?
`protected static RVMAnnotation[]`	`readAnnotations(int[] constantPool, DataInputStream input, ClassLoader classLoader)`
`(package private) Annotation[]`	`toAnnotations(Object datas)` Convert annotations from internal format to annotation instances.

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

Methods inherited from interface java.lang.reflect.AnnotatedElement
getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotationsByType

- Field Detail
  - declaredAnnotationDatas
```
protected final Object declaredAnnotationDatas
```
    Annotations from the class file that are described as runtime visible. These annotations are available to the reflection API. This is either null, a RVMAnnotation if a single annotation is present, or an array of RVMAnnotation if there is >1
  - declaredAnnotations
```
private Annotation[] declaredAnnotations
```
    Cached array of declared annotations.
  - emptyAnnotationArray
```
private static final Annotation[] emptyAnnotationArray
```
    Empty annotation array
- Constructor Detail
  - AnnotatedElement
```
protected AnnotatedElement(RVMAnnotation[] annotations)
```
    Constructor used by all annotated elements
    
    Parameters:
    
    annotations - array of runtime visible annotations
- Method Detail
  - readAnnotations
```
protected static RVMAnnotation[] readAnnotations(int[] constantPool,
                                                 DataInputStream input,
                                                 ClassLoader classLoader)
                                          throws IOException
```
    Throws:
    
    IOException
  - getAnnotations
```
public final Annotation[] getAnnotations()
```
    Get the annotations for this and all super annotated elements.
    
    Specified by:
    
    getAnnotations in interface AnnotatedElement
  - getAnnotationsInternal
```
Annotation[] getAnnotationsInternal()
```
  - getDeclaredAnnotations
```
public final Annotation[] getDeclaredAnnotations()
```
    Get the annotations for this annotated element
    
    Specified by:
    
    getDeclaredAnnotations in interface AnnotatedElement
  - getDeclaredAnnotationsInternal
```
final Annotation[] getDeclaredAnnotationsInternal()
```
  - cloneAnnotations
```
private Annotation[] cloneAnnotations(Annotation[] internal)
```
  - toAnnotations
```
final Annotation[] toAnnotations(Object datas)
```
    Convert annotations from internal format to annotation instances.
    
    Parameters:
    
    datas - the annotations.
    
    Returns:
    
    the annotation instances.
  - getAnnotation
```
public final <T extends Annotation> T getAnnotation(Class<T> annotationClass)
```
    Get the annotation implementing the specified class or null
    
    Specified by:
    
    getAnnotation in interface AnnotatedElement
  - isAnnotationPresent
```
public final boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)
```
    Is there an annotation of this type implemented on this annotated element?
    
    Specified by:
    
    isAnnotationPresent in interface AnnotatedElement
  - isAnnotationDeclared
```
final boolean isAnnotationDeclared(TypeReference annotationTypeRef)
```
    Checks if an annotation is declared.
    This is provided as an alternative to isAnnotationPresent() as isAnnotationPresent() may require classloading and instantiation of annotations. Classloading would mean that it would not be @Uninterruptible. Instantiation is not desirable as checking of annotations occurs prior to the bootimage compiler being ready to instantiate objects.
    
    Parameters:
    
    annotationTypeRef - the annotation to check for
    
    Returns:
    
    true if annotation present.
  - hasAnnotations
```
public final boolean hasAnnotations()
```
    Returns:
    
    true if the element has at least one annotation
  - hasInterruptibleAnnotation
```
public final boolean hasInterruptibleAnnotation()
```
    Returns:
    
    true if this element has a Interruptible annotation.
    
    See Also:
    
    Interruptible
  - hasLogicallyUninterruptibleAnnotation
```
public final boolean hasLogicallyUninterruptibleAnnotation()
```
    Returns:
    
    true if this element has a LogicallyUninterruptible annotation.
    
    See Also:
    
    LogicallyUninterruptible
  - hasPreemptibleAnnotation
```
public final boolean hasPreemptibleAnnotation()
```
    Returns:
    
    true if this element has a Preemptible annotation.
    
    See Also:
    
    Preemptible
  - hasUninterruptibleNoWarnAnnotation
```
public final boolean hasUninterruptibleNoWarnAnnotation()
```
    Returns:
    
    true if this element has a UninterruptibleNoWarn annotation.
    
    See Also:
    
    UninterruptibleNoWarn
  - hasUnpreemptibleNoWarnAnnotation
```
public final boolean hasUnpreemptibleNoWarnAnnotation()
```
    Returns:
    
    true if this element has a UninterruptibleNoWarn annotation.
    
    See Also:
    
    UninterruptibleNoWarn
  - hasUninterruptibleAnnotation
```
public final boolean hasUninterruptibleAnnotation()
```
    Returns:
    
    true if this element has a Uninterruptible annotation.
    
    See Also:
    
    Uninterruptible
  - hasNoCheckStoreAnnotation
```
public final boolean hasNoCheckStoreAnnotation()
```
    Returns:
    
    true if this element has a NoCheckStore annotation.
    
    See Also:
    
    NoCheckStore
  - hasUnpreemptibleAnnotation
```
public final boolean hasUnpreemptibleAnnotation()
```
    Returns:
    
    true if this element has a Unpreemptible annotation.
    
    See Also:
    
    Unpreemptible
  - hasNoOptCompileAnnotation
```
public final boolean hasNoOptCompileAnnotation()
```
    Returns:
    
    true if this element has a NoOptCompile annotation.
    
    See Also:
    
    NoOptCompile
  - hasInlineAnnotation
```
public final boolean hasInlineAnnotation()
```
    Returns:
    
    true if this element has a Inline annotation.
    
    See Also:
    
    Inline
  - hasNoInlineAnnotation
```
public final boolean hasNoInlineAnnotation()
```
    Returns:
    
    true if this element has a NoInline annotation.
    
    See Also:
    
    NoInline
  - hasBaselineNoRegistersAnnotation
```
public final boolean hasBaselineNoRegistersAnnotation()
```
    Returns:
    
    true if this element has a BaselineNoRegisters annotation.
    
    See Also:
    
    BaselineNoRegisters
  - hasBaselineSaveLSRegistersAnnotation
```
public final boolean hasBaselineSaveLSRegistersAnnotation()
```
    Returns:
    
    true if this element has a BaselineSaveLSRegisters annotation.
    
    See Also:
    
    BaselineSaveLSRegisters
  - hasPureAnnotation
```
public final boolean hasPureAnnotation()
```
    Returns:
    
    true if this element has a Pure annotation.
    
    See Also:
    
    Pure
  - hasRuntimePureAnnotation
```
public final boolean hasRuntimePureAnnotation()
```
    Returns:
    
    true if this element has a RuntimePure annotation.
    
    See Also:
    
    RuntimePure
  - hasNoNullCheckAnnotation
```
public final boolean hasNoNullCheckAnnotation()
```
    Returns:
    
    true if this element has a NoNullCheck annotation.
    
    See Also:
    
    NoNullCheck
  - hasNoBoundsCheckAnnotation
```
public final boolean hasNoBoundsCheckAnnotation()
```
    Returns:
    
    true if this element has a NoBoundsCheck annotation.
    
    See Also:
    
    NoBoundsCheck
  - hasRuntimeFinalAnnotation
```
public final boolean hasRuntimeFinalAnnotation()
```
    Returns:
    
    true if this element has a RuntimeFinal annotation.
    
    See Also:
    
    RuntimeFinal
  - hasNoEscapesAnnotation
```
public final boolean hasNoEscapesAnnotation()
```
    Returns:
    
    true if this element has a NoEscapes annotation.
    
    See Also:
    
    NoEscapes
  - hasUntracedAnnotation
```
public final boolean hasUntracedAnnotation()
```
    Returns:
    
    true if this element has a Untraced annotation.
    
    See Also:
    
    Untraced
  - hasNonMovingAnnotation
```
public final boolean hasNonMovingAnnotation()
```
    Returns:
    
    true if this element has a NonMoving annotation.
    
    See Also:
    
    NonMoving
  - hasNonMovingAllocationAnnotation
```
public final boolean hasNonMovingAllocationAnnotation()
```
    Returns:
    
    true if this element has a NonMovingAllocation annotation.
    
    See Also:
    
    NonMovingAllocation

Class AnnotatedElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.reflect.AnnotatedElement

Field Detail

declaredAnnotationDatas

declaredAnnotations

emptyAnnotationArray

Constructor Detail

AnnotatedElement

Method Detail

readAnnotations

getAnnotations

getAnnotationsInternal

getDeclaredAnnotations

getDeclaredAnnotationsInternal

cloneAnnotations

toAnnotations

getAnnotation

isAnnotationPresent

isAnnotationDeclared

hasAnnotations

hasInterruptibleAnnotation

hasLogicallyUninterruptibleAnnotation

hasPreemptibleAnnotation

hasUninterruptibleNoWarnAnnotation

hasUnpreemptibleNoWarnAnnotation

hasUninterruptibleAnnotation

hasNoCheckStoreAnnotation

hasUnpreemptibleAnnotation

hasNoOptCompileAnnotation

hasInlineAnnotation

hasNoInlineAnnotation

hasBaselineNoRegistersAnnotation

hasBaselineSaveLSRegistersAnnotation

hasPureAnnotation

hasRuntimePureAnnotation

hasNoNullCheckAnnotation

hasNoBoundsCheckAnnotation

hasRuntimeFinalAnnotation

hasNoEscapesAnnotation

hasUntracedAnnotation

hasNonMovingAnnotation

hasNonMovingAllocationAnnotation