Package io.github.fastclasspathscanner

Class AnnotationEnumValue

java.lang.Object

io.github.fastclasspathscanner.AnnotationEnumValue

All Implemented Interfaces:

Comparable<AnnotationEnumValue>

public class AnnotationEnumValue
extends Object
implements Comparable<AnnotationEnumValue>

Class for wrapping an enum constant value (split into class name and constant name) referenced inside an annotation.

Field Summary

Fields

Modifier and Type	Field	Description
protected ScanResult	scanResult

Constructor Summary

Constructors

Constructor	Description
AnnotationEnumValue(String className, String constValueName)

Method Summary

Modifier and Type	Method	Description
int	compareTo(AnnotationEnumValue o)
boolean	equals(Object o)
String	getClassName()	Return the name of the enum class.
String	getName()	Get the fully-qualified name of the enum const value, i.e.
String	getValueName()	Return the name of the enum const value.
int	hashCode()
Object	loadClassAndReturnEnumValue()	Loads the enum class, if it has not yet been loaded, instantiates the enum constants, and returns the enum constant value represented by this AnnotationEnumValue.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

scanResult

protected transient ScanResult scanResult

Constructor Detail

AnnotationEnumValue

public AnnotationEnumValue(String className,
                           String constValueName)

Parameters:

className - The enum class name.

constValueName - The enum const value name.

Method Detail

getClassName

public String getClassName()

Return the name of the enum class.

getValueName

public String getValueName()

Return the name of the enum const value.

getName

public String getName()

Get the fully-qualified name of the enum const value, i.e. (getClassName() + getConstValueName()).

Returns:

The fully-qualified name of the enum const value, i.e. (getClassName() + getConstValueName()).

loadClassAndReturnEnumValue

public Object loadClassAndReturnEnumValue()
                                   throws IllegalArgumentException

Loads the enum class, if it has not yet been loaded, instantiates the enum constants, and returns the enum constant value represented by this AnnotationEnumValue.

Returns:

The enum constant value.

Throws:

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 Comparable<AnnotationEnumValue>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object