Class AnnotationInfo
- java.lang.Object
-
- io.github.classgraph.ScanResultObject
-
- io.github.classgraph.AnnotationInfo
-
- All Implemented Interfaces:
HasName
,java.lang.Comparable<AnnotationInfo>
public class AnnotationInfo extends ScanResultObject implements java.lang.Comparable<AnnotationInfo>, HasName
Holds metadata about a specific annotation instance on a class, method, method parameter or field.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
AnnotationInfo.AnnotationInvocationHandler
InvocationHandler
for dynamically instantiating anAnnotation
object.
-
Field Summary
Fields Modifier and Type Field Description private AnnotationParameterValueList
annotationParamValues
The annotation param values.private boolean
annotationParamValuesHasBeenConvertedToPrimitive
Set to true once any Object[] arrays of boxed types in annotationParamValues have been lazily converted to primitive arrays.private AnnotationParameterValueList
annotationParamValuesWithDefaults
The annotation param values with defaults.private java.lang.String
name
The name.-
Fields inherited from class io.github.classgraph.ScanResultObject
classRef, scanResult
-
-
Constructor Summary
Constructors Constructor Description AnnotationInfo()
Default constructor for deserialization.AnnotationInfo(java.lang.String name, AnnotationParameterValueList annotationParamValues)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(AnnotationInfo o)
(package private) void
convertWrapperArraysToPrimitiveArrays()
Convert wrapper arrays to primitive arrays.boolean
equals(java.lang.Object obj)
protected void
findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo, java.util.Set<ClassInfo> refdClassInfo, LogNode log)
GetClassInfo
objects for any classes referenced in the type descriptor or type signature.ClassInfo
getClassInfo()
Return theClassInfo
object for the annotation class.protected java.lang.String
getClassName()
Get the name of the annotation class, forgetClassInfo()
.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 theAnnotation
class corresponding to thisAnnotationInfo
object, by callinggetClassInfo().loadClass()
, then create a new instance of the annotation, with the annotation parameter values obtained from thisAnnotationInfo
object, possibly overriding default annotation parameter values obtained from callinggetClassInfo()
thenClassInfo.getAnnotationDefaultParameterValues()
.(package private) void
setScanResult(ScanResult scanResult)
Set ScanResult backreferences in info objects after scan has completed.protected void
toString(boolean useSimpleNames, java.lang.StringBuilder buf)
Render to string.-
Methods inherited from class io.github.classgraph.ScanResultObject
findReferencedClassInfo, loadClass, loadClass, loadClass, loadClass, toString, toString, toStringWithSimpleNames
-
-
-
-
Field Detail
-
name
private java.lang.String name
The name.
-
annotationParamValues
private AnnotationParameterValueList annotationParamValues
The annotation param values.
-
annotationParamValuesHasBeenConvertedToPrimitive
private transient boolean annotationParamValuesHasBeenConvertedToPrimitive
Set to true once any Object[] arrays of boxed types in annotationParamValues have been lazily converted to primitive arrays.
-
annotationParamValuesWithDefaults
private transient AnnotationParameterValueList annotationParamValuesWithDefaults
The annotation param values with defaults.
-
-
Constructor Detail
-
AnnotationInfo
AnnotationInfo()
Default constructor for deserialization.
-
AnnotationInfo
AnnotationInfo(java.lang.String name, AnnotationParameterValueList annotationParamValues)
Constructor.- Parameters:
name
- The name of the annotation.annotationParamValues
- The annotation parameter values, or null if none.
-
-
Method Detail
-
getName
public java.lang.String getName()
Get the name.
-
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, forgetClassInfo()
.- Specified by:
getClassName
in classScanResultObject
- Returns:
- the class name
-
setScanResult
void setScanResult(ScanResult scanResult)
Description copied from class:ScanResultObject
Set ScanResult backreferences in info objects after scan has completed.- Overrides:
setScanResult
in classScanResultObject
- Parameters:
scanResult
- the scan result
-
findReferencedClassInfo
protected void findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo, java.util.Set<ClassInfo> refdClassInfo, LogNode log)
GetClassInfo
objects for any classes referenced in the type descriptor or type signature.- Overrides:
findReferencedClassInfo
in classScanResultObject
- Parameters:
classNameToClassInfo
- the map from class name toClassInfo
.refdClassInfo
- the referenced class infolog
- the log
-
getClassInfo
public ClassInfo getClassInfo()
Return theClassInfo
object for the annotation class.- Overrides:
getClassInfo
in classScanResultObject
- Returns:
- The
ClassInfo
object for the referenced class.
-
loadClassAndInstantiate
public java.lang.annotation.Annotation loadClassAndInstantiate()
Load theAnnotation
class corresponding to thisAnnotationInfo
object, by callinggetClassInfo().loadClass()
, then create a new instance of the annotation, with the annotation parameter values obtained from thisAnnotationInfo
object, possibly overriding default annotation parameter values obtained from callinggetClassInfo()
thenClassInfo.getAnnotationDefaultParameterValues()
.Note that the returned
Annotation
will have some sort ofInvocationHandler
proxy type, such asio.github.classgraph.features.$Proxy4
orcom.sun.proxy.$Proxy6
. This is an unavoidable side effect of the fact that concreteAnnotation
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 andinstanceof
: you are able to cast the returned proxy instance to the annotation type, andinstanceof
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 callClassInfo.loadClass()
, and read the annotations directly from the returnedClass
object.- Returns:
- The new
Annotation
instance, as a dynamic proxy object that can be cast to the expected annotation type.
-
convertWrapperArraysToPrimitiveArrays
void convertWrapperArraysToPrimitiveArrays()
Convert wrapper arrays to primitive arrays.
-
compareTo
public int compareTo(AnnotationInfo o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<AnnotationInfo>
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
protected void toString(boolean useSimpleNames, java.lang.StringBuilder buf)
Description copied from class:ScanResultObject
Render to string.- Specified by:
toString
in classScanResultObject
- Parameters:
useSimpleNames
- if true, use just the simple name of each class.buf
- the buf
-
-