Enum Entity

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Entity>

    public enum Entity
    extends java.lang.Enum<Entity>
    Entity: Exhaustive list of all items that may be defined inside of a Java Type.

    This is the complete list of 'things' (here-to-fore referred to as 'Entity'), thay may be defined inside of a Java class, interface, annotation, enum or record.

    For convenience, and more advanced users, these enum constants keep references to the Type Mirrors that are related to the enum's name (as a java.lang.Class)


    • Method Summary

       
      Convert String to Enum Constant
      Modifier and Type Method
      static Entity valueOf​(String name)
       
      List all Enum Constants
      Modifier and Type Method
      static Entity[] values()
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • FIELD

        🡇    
        public static final Entity FIELD
        Denotes Field(s)
        Code:
        Exact Constant Declaration:
        FIELD(Field.class, VariableDeclarator.class, "FD")
        
      • METHOD

        🡅  🡇    
        public static final Entity METHOD
        Denotes Method(s).
        Code:
        Exact Constant Declaration:
        METHOD(Method.class, MethodDeclaration.class, "MD")
        
      • CONSTRUCTOR

        🡅  🡇    
        public static final Entity CONSTRUCTOR
        Denotes Constructor(s).
        Code:
        Exact Constant Declaration:
        CONSTRUCTOR(Constructor.class, ConstructorDeclaration.class, "CO")
        
      • ANNOTATION_ELEM

        🡅  🡇    
        public static final Entity ANNOTATION_ELEM
        Used for the 'Elements' - which must be located inside an Annotation Definition - but are not always required or mandatory. Only an @interface (Annotation) may have "Annotation Elements".
        Code:
        Exact Constant Declaration:
        ANNOTATION_ELEM(AnnotationElem.class, AnnotationMemberDeclaration.class, "AE")
        
      • ENUM_CONSTANT

        🡅  🡇    
        public static final Entity ENUM_CONSTANT
        Used for the Enumerated-Constants which may only be found inside a Java 'enum'
        Code:
        Exact Constant Declaration:
        ENUM_CONSTANT(EnumConstant.class, EnumConstantDeclaration.class, "EC")
        
      • INNER_CLASS

        🡅  🡇    
        public static final Entity INNER_CLASS
        Denotes Static inner-class(es), inner-interface(s), inner-enums, etc.

        NOTE: The Type-Mirror Fields for the enum constant INNER_CLASS are set to null. Inner classes are types themselves, and the 'Type-Mirror' for an inner-class would be java.lang.Class.class itself!
        Code:
        Exact Constant Declaration:
        INNER_CLASS(NestedType.class, TypeDeclaration.class, "NT")
        
    • Field Detail

      • upgraderReflectionClass

        🡅  🡇    
        public final java.lang.Class<? extends Declaration> upgraderReflectionClass
        This is provided for more custom upgrades that could possible need to make a switch using this java.lang.Class. Utilizing these public and final enum-fields isn't required for using this upgrader at all; however, this 'Type Mirror' (Class) could potentially be convenient for an advanced user making his own custom modifications to Java Doc Pages.

        The Class<? extends Declaration> instance stored in this 'Type Mirror' field is just the actual java.lang.class of one of the five CIET-Types. Specifically this field will always evaluate to one of the following values:

        • Method.class
        • Constructor.class
        • Field.class
        • EnumConstant.class
        • AnnotationElem.class
        • null - for the INNER_CLASS constant
        Code:
        Exact Field Declaration Expression:
        public final Class<? extends Declaration> upgraderReflectionClass;
        
      • javaParserReflectionClass

        🡅  🡇    
        public final java.lang.Class<? extends com.github.javaparser.ast.Node> javaParserReflectionClass
        This is provided for more custom upgrades that could possible need to make a switch using this java.lang.Class. Utilizing these public and final enum-fields isn't required for using this upgrader at all; however, this 'Type Mirror' (Class) could potentially be convenient for an advanced user making his own custom modifications to Java Doc Pages.

        The Class<? extends Node> instance stored in this 'Type Mirror' field is the actual java.lang.Class of the Java Parser Node that is used to build this kind of Entity. Specifically, this field will always evaluate to one of the following Java Parser com.github.javaparser.ast.body.* values:

        • MethodDeclaration.class
        • ConstructorDeclaration.class
        • VariableDeclarator.class
        • EnumConstantDeclaration.class
        • AnnotationMemberDeclaration.class
        • null - for the INNER_CLASS constant
        Code:
        Exact Field Declaration Expression:
        public final Class<? extends Node> javaParserReflectionClass;
        
      • abbrev

        🡅  🡇    
        public final java.lang.String abbrev
        Two character abbreviation-string for this Entity, usefull for CSS ID's
        Code:
        Exact Field Declaration Expression:
        public final String abbrev;
        
    • Method Detail

      • values

        🡅  🡇    
        public static Entity[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Entity c : Entity.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        🡅    
        public static Entity valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null