io.github.classgraph

Class AnnotationInfo

java.lang.Object

io.github.classgraph.AnnotationInfo

All Implemented Interfaces:

HasName, java.lang.Comparable<AnnotationInfo>

public class AnnotationInfo
extends java.lang.Object
implements java.lang.Comparable<AnnotationInfo>, HasName

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<?>	classRef The class ref, once the class is loaded.
protected ScanResult	scanResult The scan result.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AnnotationInfo o)
boolean	equals(java.lang.Object obj)
protected void	findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo, java.util.Set<ClassInfo> refdClassInfo, LogNode log) Get ClassInfo objects for any classes referenced in the type descriptor or type signature.
ClassInfo	getClassInfo() Return the ClassInfo object for the annotation class.
protected java.lang.String	getClassName() Get the name of the annotation class, for getClassInfo().
AnnotationParameterValueList	getDefaultParameterValues() Get the default parameter values.
java.lang.String	getName() Get the name.
AnnotationParameterValueList	getParameterValues() Get the parameter values.
AnnotationParameterValueList	getParameterValues(boolean includeDefaultValues) Get the parameter values.
int	hashCode()
boolean	isInherited() Checks if the annotation is inherited.
java.lang.annotation.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, possibly overriding default annotation parameter values obtained from calling getClassInfo() then ClassInfo.getAnnotationDefaultParameterValues().
java.lang.String	toString() Render to string.
protected void	toString(boolean useSimpleNames, java.lang.StringBuilder buf) Render to string.
java.lang.String	toStringWithSimpleNames() Render to string, using only simple names for classes.

Methods inherited from class java.lang.Object

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

Field Detail

scanResult

protected transient ScanResult scanResult

The scan result.

classRef

protected transient java.lang.Class<?> classRef

The class ref, once the class is loaded.

Method Detail

getName

public java.lang.String getName()

Get the name.

Specified by:

getName in interface HasName

Returns:

The name of the annotation class.

isInherited

public boolean isInherited()

Checks if the annotation is inherited.

Returns:

true if this annotation is meta-annotated with Inherited.

getDefaultParameterValues

public AnnotationParameterValueList getDefaultParameterValues()

Get the default parameter values.

Returns:

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

getParameterValues

public AnnotationParameterValueList getParameterValues(boolean includeDefaultValues)

Get the parameter values.

Parameters:

includeDefaultValues - if true, include default values for any annotation parameter value that is missing.

Returns:

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

getParameterValues

public AnnotationParameterValueList getParameterValues()

Get the parameter values.

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 java.lang.String getClassName()

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

Returns:

the class name

findReferencedClassInfo

protected void findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo,
                                       java.util.Set<ClassInfo> refdClassInfo,
                                       LogNode log)

Get ClassInfo objects for any classes referenced in the type descriptor or type signature.

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info

log - the log

getClassInfo

public ClassInfo getClassInfo()

Return the ClassInfo object for the annotation class.

Returns:

The ClassInfo object for the referenced class.

loadClassAndInstantiate

public java.lang.annotation.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, possibly overriding default annotation parameter values obtained from calling getClassInfo() then ClassInfo.getAnnotationDefaultParameterValues().

Note that the returned Annotation will have some sort of InvocationHandler proxy type, such as io.github.classgraph.features.$Proxy4 or com.sun.proxy.$Proxy6. This is an unavoidable side effect of the fact that concrete Annotation instances cannot be instantiated directly. (ClassGraph uses the same approach that the JDK uses to instantiate annotations from a map.) However, proxy instances are handled specially when it comes to casting and instanceof: you are able to cast the returned proxy instance to the annotation type, and instanceof checks against the annotation class will succeed.

Of course another option you have for getting the concrete annotations, rather than instantiating the annotations on a ClassInfo object via this method, is to call ClassInfo.loadClass(), and read the annotations directly from the returned Class object.

Returns:

The new Annotation instance, as a dynamic proxy object that can be cast to the expected annotation type.

compareTo

public int compareTo(AnnotationInfo o)

Specified by:

compareTo in interface java.lang.Comparable<AnnotationInfo>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

protected void toString(boolean useSimpleNames,
                        java.lang.StringBuilder buf)

Render to string.

Parameters:

useSimpleNames - if true, use just the simple name of each class.

buf - the buf

toStringWithSimpleNames

public java.lang.String toStringWithSimpleNames()

Render to string, using only simple names for classes.

Returns:

the string representation, using simple names for classes.

toString

public java.lang.String toString()

Render to string.

Overrides:

toString in class java.lang.Object

Returns:

the string representation.