io.github.classgraph

Class AnnotationEnumValue

java.lang.Object

io.github.classgraph.AnnotationEnumValue

All Implemented Interfaces:

java.lang.Comparable<AnnotationEnumValue>

public class AnnotationEnumValue
extends java.lang.Object
implements java.lang.Comparable<AnnotationEnumValue>

Class for wrapping an enum constant value (split into class name and constant name), as used as an annotation parameter value.

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(AnnotationEnumValue 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 by this object.
java.lang.String	getClassName() Get the class name.
java.lang.String	getName() Get the name.
java.lang.String	getValueName() Get the value name.
int	hashCode()
java.lang.Object	loadClassAndReturnEnumValue() Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this AnnotationEnumValue.
java.lang.Object	loadClassAndReturnEnumValue(boolean ignoreExceptions) Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this AnnotationEnumValue.
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

getClassName

public java.lang.String getClassName()

Get the class name.

Returns:

The name of the enum class.

getValueName

public java.lang.String getValueName()

Get the value name.

Returns:

The name of the enum const value.

getName

public java.lang.String getName()

Get the name.

Returns:

The fully-qualified name of the enum constant value, i.e. (getClassName() + {#getValueName()}).

loadClassAndReturnEnumValue

public java.lang.Object loadClassAndReturnEnumValue(boolean ignoreExceptions)
                                             throws java.lang.IllegalArgumentException

Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this AnnotationEnumValue.

Parameters:

ignoreExceptions - If true, ignore classloading exceptions and return null on failure.

Returns:

The enum constant value represented by this AnnotationEnumValue

Throws:

java.lang.IllegalArgumentException - if the class could not be loaded and ignoreExceptions was false, or if the enum constant is invalid.

loadClassAndReturnEnumValue

public java.lang.Object loadClassAndReturnEnumValue()
                                             throws java.lang.IllegalArgumentException

Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this AnnotationEnumValue.

Returns:

The enum constant value represented by this AnnotationEnumValue

Throws:

java.lang.IllegalArgumentException - if the class could not be loaded, or the enum constant is invalid.

compareTo

public int compareTo(AnnotationEnumValue o)

Specified by:

compareTo in interface java.lang.Comparable<AnnotationEnumValue>

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

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 by this object.

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info

log - the log

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.