io.github.classgraph

Class AnnotationParameterValue

java.lang.Object

io.github.classgraph.AnnotationParameterValue

All Implemented Interfaces:

HasName, java.lang.Comparable<AnnotationParameterValue>

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

A wrapper used to pair annotation parameter names with annotation parameter values.

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(AnnotationParameterValue other)
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 annotation parameters.
protected ClassInfo	getClassInfo() Get the ClassInfo object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. no ClassInfo object was created for the class during scanning).
protected java.lang.String	getClassName() The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).
java.lang.String	getName() Get the annotation parameter name.
java.lang.Object	getValue() Get the annotation parameter value.
int	hashCode()
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 annotation parameter name.

Specified by:

getName in interface HasName

Returns:

The annotation parameter name.

getValue

public java.lang.Object getValue()

Get the annotation parameter value.

Returns:

The annotation parameter value. May be one of the following types:

• String for string constants
• String[] for arrays of strings
• A boxed type, e.g. Integer or Character, for primitive-typed constants
• A 1-dimensional primitive-typed array (i.e. int[], long[], short[], char[], byte[], boolean[], float[], or double[]), for arrays of primitives
• A 1-dimensional Object[] array for array types (and then the array element type may be one of the types in this list)
• AnnotationEnumValue, for enum constants (this wraps the enum class and the string name of the constant)
• AnnotationClassRef, for Class references within annotations (this wraps the name of the referenced class)
• AnnotationInfo, for nested annotations

getClassName

protected java.lang.String getClassName()

The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).

Returns:

The class name.

getClassInfo

protected ClassInfo getClassInfo()

Get the ClassInfo object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. no ClassInfo object was created for the class during scanning). N.B. even if this method returns null, loadClass() may be able to load the referenced class by name.

Returns:

The ClassInfo object for the referenced class.

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 annotation parameters.

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info

log - the log

compareTo

public int compareTo(AnnotationParameterValue other)

Specified by:

compareTo in interface java.lang.Comparable<AnnotationParameterValue>

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.