Package com.ibm.wala.types.annotations

Class TypeAnnotation

java.lang.Object

com.ibm.wala.types.annotations.TypeAnnotation

public class TypeAnnotation
extends Object

A TypeAnnotation represents a JSR 308 Java Type Annotation.

Author:

Martin Hecker martin.hecker@kit.edu

See Also:

• Annotation
• TypeAnnotation.TypeAnnotationTarget
• JLS (SE8), 4.7.20
• JSR 308: Annotations on Java Types
• Type Annotations (JSR 308) and the Checker Framework

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TypeAnnotation.CatchTarget
static class	TypeAnnotation.EmptyTarget
static class	TypeAnnotation.FormalParameterTarget
static class	TypeAnnotation.LocalVarTarget
static class	TypeAnnotation.OffsetTarget
static class	TypeAnnotation.SuperTypeTarget
static class	TypeAnnotation.ThrowsTarget
static class	TypeAnnotation.TypeAnnotationTarget	A TypeAnnotation.TypeAnnotationTarget represents the "target" of a Type Annotation.
static interface	TypeAnnotation.TypeAnnotationTargetConverter	A @{TypeAnnotationTargetConverter} takes "unresolved" instances of TypeAnnotationsReader.TypeAnnotationTarget, resolves some byte-code specific data, and returns instances of the corresponding TypeAnnotation.TypeAnnotationTarget subclass.
static class	TypeAnnotation.TypeArgumentTarget
static class	TypeAnnotation.TypeParameterBoundTarget
static class	TypeAnnotation.TypeParameterTarget

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Annotation	getAnnotation()
TypeAnnotationsReader.TargetType	getTargetType()
static Collection<TypeAnnotation>	getTypeAnnotationsFromReader(TypeAnnotationsReader r, TypeAnnotation.TypeAnnotationTargetConverter converter, ClassLoaderReference clRef)
TypeAnnotation.TypeAnnotationTarget	getTypeAnnotationTarget()
List<Pair<TypeAnnotationsReader.TypePathKind,Integer>>	getTypePath()
int	hashCode()
static TypeAnnotation	make(Annotation annotation, TypeAnnotation.TypeAnnotationTarget typeAnnotationTarget, TypeAnnotationsReader.TargetType targetType)	This method is intended to be used in testing only.
static TypeAnnotation	make(Annotation annotation, List<Pair<TypeAnnotationsReader.TypePathKind,Integer>> typePath, TypeAnnotation.TypeAnnotationTarget typeAnnotationTarget, TypeAnnotationsReader.TargetType targetType)	This method is intended to be used in testing only.
static TypeAnnotation.TypeAnnotationTargetConverter	targetConverterAtClassFile(ClassLoaderReference clRef)
static TypeAnnotation.TypeAnnotationTargetConverter	targetConverterAtCode(ClassLoaderReference clRef, IBytecodeMethod<?> method)
static TypeAnnotation.TypeAnnotationTargetConverter	targetConverterAtFieldInfo()
static TypeAnnotation.TypeAnnotationTargetConverter	targetConverterAtMethodInfo(ClassLoaderReference clRef)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getTypeAnnotationsFromReader

public static Collection<TypeAnnotation> getTypeAnnotationsFromReader(TypeAnnotationsReader r,
 TypeAnnotation.TypeAnnotationTargetConverter converter,
 ClassLoaderReference clRef)
                                                               throws InvalidClassFileException

Throws:

InvalidClassFileException

make

public static TypeAnnotation make(Annotation annotation,
 List<Pair<TypeAnnotationsReader.TypePathKind,Integer>> typePath,
 TypeAnnotation.TypeAnnotationTarget typeAnnotationTarget,
 TypeAnnotationsReader.TargetType targetType)

This method is intended to be used in testing only.

Otherwise, obtain TypeAnnotations from

• ShrikeCTMethod.getTypeAnnotationsAtCode(boolean)
• ShrikeCTMethod.getTypeAnnotationsAtMethodInfo(boolean)
• FieldImpl.getTypeAnnotations()
• ShrikeClass.getTypeAnnotations(boolean)

Returns:

A TypeAnnotation comprised of annotation, typePath and targetType

make

public static TypeAnnotation make(Annotation annotation,
 TypeAnnotation.TypeAnnotationTarget typeAnnotationTarget,
 TypeAnnotationsReader.TargetType targetType)

This method is intended to be used in testing only.

Otherwise, obtain TypeAnnotations from

• ShrikeCTMethod.getTypeAnnotationsAtCode(boolean)
• ShrikeCTMethod.getTypeAnnotationsAtMethodInfo(boolean)
• FieldImpl.getTypeAnnotations()
• ShrikeClass.getTypeAnnotations(boolean)

Returns:

A TypeAnnotation comprised of annotation, an empty typePath, and targetType

targetConverterAtCode

public static TypeAnnotation.TypeAnnotationTargetConverter targetConverterAtCode(ClassLoaderReference clRef,
 IBytecodeMethod<?> method)

targetConverterAtMethodInfo

public static TypeAnnotation.TypeAnnotationTargetConverter targetConverterAtMethodInfo(ClassLoaderReference clRef)

targetConverterAtClassFile

public static TypeAnnotation.TypeAnnotationTargetConverter targetConverterAtClassFile(ClassLoaderReference clRef)

targetConverterAtFieldInfo

public static TypeAnnotation.TypeAnnotationTargetConverter targetConverterAtFieldInfo()

getAnnotation

public Annotation getAnnotation()

Returns:

the Annotation of this TypeAnnotation

getTypePath

public List<Pair<TypeAnnotationsReader.TypePathKind,Integer>> getTypePath()

Returns:

the typePath of this TypeAnnotation

See Also:

• JLS (SE8), 4.7.20.2

getTypeAnnotationTarget

public TypeAnnotation.TypeAnnotationTarget getTypeAnnotationTarget()

Returns:

the TypeAnnotation.TypeAnnotationTarget of this TypeAnnotation

getTargetType

public TypeAnnotationsReader.TargetType getTargetType()

Returns:

the TypeAnnotationsReader.TargetType of this TypeAnnotation