gov.nasa.jpf.vm

Class AnnotationInfo

java.lang.Object

gov.nasa.jpf.vm.AnnotationInfo

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AbstractTypeAnnotationInfo

public class AnnotationInfo
extends java.lang.Object
implements java.lang.Cloneable

the JPF internal representation for Java Annotations AnnotationInfos represent a separate type system. While we could have used normal ClassInfos (Java annotations are just restricted interfaces with some syntactic sugar), we keep this separate because ClassInfos would be overkill. Besides, our runtime behavior differs in that we synchronously load annotation class files when we encounter them during normal ClassInfo construction (i.e. we parse recursively), whereas a normal JVM only loads them once they are referenced. The reason why we deviate is that annotations are used more often in tools than via reflection within the SUT, i.e. they most likely will be read either by JPF or by listeners, so we want them as soon as possible to avoid additional class state. This also means we do not faithfully model ClassNotFoundExceptions on annotations due to reflection calls within the SUT, but that seems less important than having them available during ClassInfo construction. This mostly matters because of default values and inherited class annotations. AnnotationInfo serves as the concrete type of declaration annotations, and as the base for type annotations, holding all the info that comes from the annotation class file. In the first case, AnnotationInfo instances can be shared if there are no explicit values. Sharing does not make sense for type annotations which need to store site specific target info (from the classfile). Note - AnnotationInfos loaded by the same ClassLoader that do not have explicitly set values are shared between annotated objects

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationInfo.AnnotationAttribute
static class	AnnotationInfo.ClassValue
static class	AnnotationInfo.Entry
static class	AnnotationInfo.EnumValue

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoaderInfo	classLoader this records if the associated class file has been loaded.
protected AnnotationInfo.Entry[]	entries
protected boolean	isInherited
protected java.lang.String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnnotationInfo(AnnotationInfo exemplar) this is the base ctor for AbstractTypeAnnotationInfos, which add additional target information from the classfile
	AnnotationInfo(java.lang.String name, AnnotationInfo.Entry[] entries, boolean isInherited)
	AnnotationInfo(java.lang.String name, ClassLoaderInfo classLoader, AnnotationParser parser)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asString()
protected AnnotationInfo	cloneFor(ClassLoaderInfo cl)
AnnotationInfo	cloneForOverriddenValues() this returns a clone that can be used to explicitly set values.
ClassLoaderInfo	getClassLoaderInfo()
static java.lang.Object	getClassValue(java.lang.String type)
AnnotationInfo.Entry[]	getEntries()
static java.lang.Object	getEnumValue(java.lang.String eType, java.lang.String eConst)
java.lang.String	getName()
java.lang.Object	getValue(java.lang.String key) this is the common getter that should trigger parsing the corresponding class file
<T> T	getValue(java.lang.String key, java.lang.Class<T> type)
boolean	getValueAsBoolean(java.lang.String key)
double	getValueAsDouble(java.lang.String key)
float	getValueAsFloat(java.lang.String key)
int	getValueAsInt(java.lang.String key)
long	getValueAsLong(java.lang.String key)
java.lang.String	getValueAsString(java.lang.String key)
java.lang.String[]	getValueAsStringArray()
java.lang.String[]	getValueAsStringArray(java.lang.String key)
boolean	isInherited()
void	setClonedEntryValue(java.lang.String key, java.lang.Object newValue)
void	setEntries(AnnotationInfo.Entry[] entries)
void	setInherited(boolean isInherited)
void	setName(java.lang.String name)
java.lang.Object	value()
java.lang.String	valueAsString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

entries

protected AnnotationInfo.Entry[] entries

isInherited

protected boolean isInherited

classLoader

protected ClassLoaderInfo classLoader

this records if the associated class file has been loaded. If it isn't resolved yet, we don't know about default values, hence we need to check before retrieving field values that have not been explicitly set. Note this is search global and hence does not need to be state managed since we only check for default values, i.e. there are no side effects. Loading has to happen with the right ClassLoader though

Constructor Detail

AnnotationInfo

public AnnotationInfo(java.lang.String name,
                      ClassLoaderInfo classLoader,
                      AnnotationParser parser)
               throws ClassParseException

Throws:

ClassParseException

AnnotationInfo

protected AnnotationInfo(AnnotationInfo exemplar)

this is the base ctor for AbstractTypeAnnotationInfos, which add additional target information from the classfile

AnnotationInfo

public AnnotationInfo(java.lang.String name,
                      AnnotationInfo.Entry[] entries,
                      boolean isInherited)

Method Detail

getEnumValue

public static java.lang.Object getEnumValue(java.lang.String eType,
                                            java.lang.String eConst)

getClassValue

public static java.lang.Object getClassValue(java.lang.String type)

setName

public void setName(java.lang.String name)
             throws ClassParseException

Throws:

ClassParseException

setEntries

public void setEntries(AnnotationInfo.Entry[] entries)

setInherited

public void setInherited(boolean isInherited)

isInherited

public boolean isInherited()

getClassLoaderInfo

public ClassLoaderInfo getClassLoaderInfo()

getName

public java.lang.String getName()

cloneFor

protected AnnotationInfo cloneFor(ClassLoaderInfo cl)

cloneForOverriddenValues

public AnnotationInfo cloneForOverriddenValues()

this returns a clone that can be used to explicitly set values. NOTE - Entry instances are still shared, i.e. to change values we have to create and set new Entry instances

setClonedEntryValue

public void setClonedEntryValue(java.lang.String key,
                                java.lang.Object newValue)

getEntries

public AnnotationInfo.Entry[] getEntries()

getValue

public java.lang.Object getValue(java.lang.String key)

this is the common getter that should trigger parsing the corresponding class file

value

public java.lang.Object value()

valueAsString

public java.lang.String valueAsString()

getValueAsString

public java.lang.String getValueAsString(java.lang.String key)

getValueAsStringArray

public java.lang.String[] getValueAsStringArray()

getValueAsStringArray

public java.lang.String[] getValueAsStringArray(java.lang.String key)

getValue

public <T> T getValue(java.lang.String key,
                      java.lang.Class<T> type)

getValueAsBoolean

public boolean getValueAsBoolean(java.lang.String key)

getValueAsInt

public int getValueAsInt(java.lang.String key)

getValueAsLong

public long getValueAsLong(java.lang.String key)

getValueAsFloat

public float getValueAsFloat(java.lang.String key)

getValueAsDouble

public double getValueAsDouble(java.lang.String key)

asString

public java.lang.String asString()