ClassGraph 4.8.179 · io.github.classgraph.AnnotationEnumValue

Modifier and Type	Field and Description
private String	className The class name.
private String	valueName The value name.

Access	Constructor and Description
pack-priv	AnnotationEnumValue() Default constructor for deserialization.
pack-priv	AnnotationEnumValue(final String The enum class name. className, final String The enum const value name. constValueName) Constructor.

Method Summary

Modifier and Type	Method and Description
public int	compareTo(final AnnotationEnumValue the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: The name of the enum class. getClassName() Implements abstract io.github.classgraph.ScanResultObject.getClassName. Get the class name.
public String	Returns: The fully-qualified name of the enum constant value, i.e. (`getClassName()` + {#getValueName()}). getName() Get the name.
public String	Returns: The name of the enum const value. getValueName() Get the value name.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Object	Returns: The enum constant value represented by this `AnnotationEnumValue` loadClassAndReturnEnumValue(final boolean If true, ignore classloading exceptions and return null on failure. ignoreExceptions) Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this `AnnotationEnumValue`.
public Object	Returns: The enum constant value represented by this `AnnotationEnumValue` loadClassAndReturnEnumValue() Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this `AnnotationEnumValue`.
protected void	toString(final boolean if true, use just the simple name of each class. useSimpleNames, final StringBuilder the buf buf) Implements abstract io.github.classgraph.ScanResultObject.toString. Render to string.

Inherited from io.github.classgraph.ScanResultObject:: findReferencedClassInfo findReferencedClassInfo getClassInfo loadClass loadClass loadClass loadClass setScanResult toString toString toStringWithSimpleNames

className	back to summary
private String className The class name.

valueName	back to summary
private String valueName The value name.

AnnotationEnumValue	back to summary
pack-priv AnnotationEnumValue() Default constructor for deserialization.

AnnotationEnumValue	back to summary
pack-priv AnnotationEnumValue(final String className, final String constValueName) Constructor. Parameters className:String The enum class name. constValueName:String The enum const value name.

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(final AnnotationEnumValue o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:AnnotationEnumValue the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(final AnnotationEnumValue o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:AnnotationEnumValue: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getClassName	back to summary
public String getClassName() Implements abstract io.github.classgraph.ScanResultObject.getClassName. Get the class name. Returns:String The name of the enum class. Annotations @Override

getClassName

back to summary

public String getClassName()

Implements abstract io.github.classgraph.ScanResultObject.getClassName.

Get the class name.

Returns:String

The name of the enum class.

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Get the name. Returns:String The fully-qualified name of the enum constant value, i.e. (`getClassName()` + {#getValueName()}).

public String getName()

Get the name.

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

getValueName	back to summary
public String getValueName() Get the value name. Returns:String The name of the enum const value.

getValueName

back to summary

public String getValueName()

Get the value name.

Returns:String: The name of the enum const value.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

loadClassAndReturnEnumValue back to summary

loadClassAndReturnEnumValue	back to summary
public Object loadClassAndReturnEnumValue(final boolean ignoreExceptions) throws IllegalArgumentException Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this `AnnotationEnumValue`. Parameters ignoreExceptions:boolean If true, ignore classloading exceptions and return null on failure. Returns:Object The enum constant value represented by this `AnnotationEnumValue` Exceptions IllegalArgumentException: if the class could not be loaded and ignoreExceptions was false, or if the enum constant is invalid.

public Object loadClassAndReturnEnumValue(final boolean ignoreExceptions) throws IllegalArgumentException

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

Parameters

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

Returns:Object

The enum constant value represented by this AnnotationEnumValue

Exceptions

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

loadClassAndReturnEnumValue back to summary

loadClassAndReturnEnumValue	back to summary
public Object loadClassAndReturnEnumValue() throws IllegalArgumentException Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this `AnnotationEnumValue`. Returns:Object The enum constant value represented by this `AnnotationEnumValue` Exceptions IllegalArgumentException: if the class could not be loaded, or the enum constant is invalid.

public Object loadClassAndReturnEnumValue() throws IllegalArgumentException

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

Returns:Object

The enum constant value represented by this AnnotationEnumValue

Exceptions

IllegalArgumentException:: if the class could not be loaded, or the enum constant is invalid.

toString	back to summary
protected void toString(final boolean useSimpleNames, final StringBuilder buf) Implements abstract io.github.classgraph.ScanResultObject.toString. Doc from io.github.classgraph.ScanResultObject.toString. Render to string. Parameters useSimpleNames:boolean if true, use just the simple name of each class. buf:StringBuilder the buf Annotations @Override

toString

back to summary

protected void toString(final boolean useSimpleNames, final StringBuilder buf)

Implements abstract io.github.classgraph.ScanResultObject.toString.

Doc from io.github.classgraph.ScanResultObject.toString.

Render to string.

Parameters

useSimpleNames:boolean: if true, use just the simple name of each class.
buf:StringBuilder: the buf

Annotations

@Override

public Class AnnotationEnumValue

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail