Package io.github.classgraph

Class AnnotationEnumValue

  • All Implemented Interfaces:
    java.lang.Comparable<AnnotationEnumValue>
    public class AnnotationEnumValue
extends ScanResultObject
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 Detail

      • className

        private java.lang.String className
        The class name.

      • valueName

        private java.lang.String valueName
        The value name.

    • Constructor Detail

      • AnnotationEnumValue

        AnnotationEnumValue()
        Default constructor for deserialization.

      • AnnotationEnumValue

        AnnotationEnumValue​(java.lang.String className,
                    java.lang.String constValueName)
        Constructor.
        Parameters:
        className - The enum class name.
        constValueName - The enum const value name.

    • Method Detail

      • getClassName

        public java.lang.String getClassName()
        Get the class name.
        Specified by:
        getClassName in class ScanResultObject
        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.

      • 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)
        Description copied from class: ScanResultObject
        Render to string.
        Specified by:
        toString in class ScanResultObject
        Parameters:
        useSimpleNames - if true, use just the simple name of each class.
        buf - the buf