Package io.github.classgraph

Class AnnotationInfo

java.lang.Object

io.github.classgraph.AnnotationInfo

All Implemented Interfaces:

Comparable<AnnotationInfo>

public class AnnotationInfo
extends Object
implements Comparable<AnnotationInfo>

Holds metadata about a specific annotation instance on a class, method, method parameter or field.

Field Summary

Fields

Modifier and Type	Field	Description
protected ScanResult	scanResult

Method Summary

Modifier and Type	Method	Description
int	compareTo(AnnotationInfo o)
boolean	equals(Object obj)
ClassInfo	getClassInfo()
protected String	getClassName()	Return the name of the annotation class, for getClassInfo().
AnnotationParameterValueList	getDefaultParameterValues()
String	getName()
AnnotationParameterValueList	getParameterValues()
int	hashCode()
boolean	isInherited()
Annotation	loadClassAndInstantiate()	Load the Annotation class corresponding to this AnnotationInfo object, by calling getClassInfo().loadClass(), then create a new instance of the annotation, with the annotation parameter values obtained from this AnnotationInfo object.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

scanResult

protected transient ScanResult scanResult

Method Detail

getName

public String getName()

Returns:

The name of the annotation class.

isInherited

public boolean isInherited()

Returns:

true if this annotation is meta-annotated with Inherited.

getDefaultParameterValues

public AnnotationParameterValueList getDefaultParameterValues()

Returns:

the list of default parameter values for this annotation, or the empty list if none.

getParameterValues

public AnnotationParameterValueList getParameterValues()

Returns:

The parameter values of this annotation, including any default parameter values inherited from the annotation class definition, or the empty list if none.

getClassName

protected String getClassName()

Return the name of the annotation class, for getClassInfo().

Returns:

The class name.

getClassInfo

public ClassInfo getClassInfo()

Returns:

The ClassInfo object for the annotation class.

loadClassAndInstantiate

public Annotation loadClassAndInstantiate()

Load the Annotation class corresponding to this AnnotationInfo object, by calling getClassInfo().loadClass(), then create a new instance of the annotation, with the annotation parameter values obtained from this AnnotationInfo object.

Returns:

The new Annotation instance.

compareTo

public int compareTo(AnnotationInfo o)

Specified by:

compareTo in interface Comparable<AnnotationInfo>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object