Class Constructor

  • All Implemented Interfaces:, java.lang.Cloneable, java.lang.Comparable<Constructor>

    public class Constructor
    extends Callable
    implements, java.lang.Comparable<Constructor>, java.lang.Cloneable
    Extension of Package java.lang.reflect
    This class operates as a slightly more advanced version of the basic Java Reflection Class java.lang.reflect.Constructor. This class provides a hook into the native Java Parser JAR Library class ConstructorDeclaration.

    This class is heavily used internally, and can be used (if needed) to modify Java Doc Web-Pages, programmatically.

    HTML Processors that sort the Web-Page "Summary-Tables" will provide instances of this class to your Summary-Sorter Handler methods. Summary-Sorter handlers usually implement the SummarySorterHelper interface; please review that class for more about sorting Java-Doc Page Summary Tables.

    The HTML Processors that upgrade Web-Page "Detail Elements" also rely heavily on this class. Please review the class: ReflHTML for more information about Java-Doc Web-Page Detail Sections.
    Java Parser Bridge: Holds all information extracted from '.java' Source-Files about Constructor's identified in that file.

    Instances of this Class are Obtained From: ReflHTML & SummaryTableHTML

    Use of the Reflection-HTML API is *NOT REQUIRED* to perform a standard Java Doc HTML File Upgrade. This "extra API" allows for programmatic modification of Java Doc HTML. This class contains quite a bit of reflected information, and furthermore, here there is a hook to the Native Java Parser Reflection Class.
    The purpose of this bridge is provide a pared down, easier-to-use (but-with less-features) version of the publicly available "JavaParser" package. This class Field allows for storing the name, definition, modifiers list, etc... of a constructor.

    There is a Java-Parser Library that is required to use this Package. The Java Doc Upgrader Package / Tool will not work without this '.jar'file being placed in your CLASSPATH environment-variable. That '.jar'is available here:

    There is a book available and an internet "Gitter" support web-site chat-room with some of the people involved in writing this library. There are quite a number of available jars in the "Master Jar Distribution" - but the core library jar is fully sufficient for running the tasks needed by this Java-Doc Upgrade Tool's logic.

    Reflection-Classes Inheritance-Diagram

    Class Declaration
    Class Callable
    Class Method
    Class Constructor
    Also Inherits Class Callable
    No Additional Fields
    Reflection Class
    Inheritance Diagram

    Class Field
    Class EnumConstant
    Class AnnotationElem
    Class NestedType

    All reflection classes above, also contain an additional (transient, non-Serializable) field that hooks into the native Java-Parser Library classes, providing an option for a more in-depth or complete analysis using that Library's features & extensive utilities.
    See Also:
    Serialized Form

    • Field Detail

      • serialVersionUID

        public static final long serialVersionUID
        This fulfils the SerialVersion UID requirement for all classes that implement Java's interface Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.
        See Also:
        Constant Field Values
        Exact Field Declaration Expression:
         public static final long serialVersionUID = 1;
      • constructorDeclaration

        🡅  🡇    
        public final transient com.github.javaparser.ast.body.ConstructorDeclaration constructorDeclaration

        Hook Reference to Java-Parser Refletion Class

        Though this class offers a streamlined set of reflection features, the Native Java-Parser Library Reflection-Classes offer a near-complete set of analysis tools for just about any kind of code-analysis neccessary. If you would like your Java Doc Pages to include more analytical-information, this field is provided as a convenience for such purposes.
        If a user decides to make use of the Java-Parser ConstructorDeclaration instance that was used to build this Constructor, it may be retrieved from this transient field.
        Exact Field Declaration Expression:
         public final transient ConstructorDeclaration constructorDeclaration;
      • methodTree

        🡅  🡇    
        public final transient com.sun.source.tree.MethodTree methodTree

        Hook Reference to Sun/Oracle Parser-Refletion Class

        Though this class offers a streamlined set of reflection features, the Native Oracle Library Reflection-Classes offer a detailed AST interface into the standard Java Compiler. If you would like to use these Tree's to provide further code analysis on your Java-Doc Pages, this field is provided as a convenience for such purposes.
        If a user decides to make use of the native Sun/Oracle MethodTree instance that was used to build this Constructor instance, it may be retrieved from this transient field.

        NOTE: The package com.sun.source.tree "reuses" or "overloads" the MethodTree object such that it may represent either a Method, or a Constructor. When a MethodTree instance is actually representing a constructor, the name that is used for the instance will be '<init>', rather than a method that abides by the standard Java naming conventions.
        Exact Field Declaration Expression:
         public final transient MethodTree methodTree;
    • Constructor Detail

      • Constructor

        🡅  🡇    
        public Constructor​(com.sun.source.tree.MethodTree mt,
                           TreeUtils util,
                           java.lang.String constructorName)
        Constructs an instance of this class, Constructor. A parsed AST node that has been compiled by Java's Source-Parser, and the exact instance of TreeUtils that generated the parsed node must be passed by parameter to this constructor.
        mt - Any instance of a Java AST Constructor Node. It is required that this member / entity AST-Node is one which the Java-Compiler generated using the exact same TreeUtils instance also being passed by parameter here.

        Any time that the Java-Compiler parses a 'Constructor' Member / Entity, that member is converted into an instance of the AST-Node MethodTree.
        util - This utility class will contain references to all of the most important instances that are used when compiling a standard Java Souce-Code ('.java' File). In this Java-Doc Web-Page 'Upgrade' Package, whenever any '.java' file is compiled and converted into an Abstract Syntax Tree, a new instance of TreeUtils will be created / generated.

        Each source-file in a Java-Project will be compiled once, and converted into an instance of TreeUtils. Note that it is imperative that the TreeUtils instance being passed to this method is the same instance that was used to generate the Constructor-Node instance with this constructor-invocation.

        An instance of TreeUtils. is always available as a member-field of the top-level class JavaDocHTMLFile.treeUtils.
        constructorName - The name of the type (which is also the name of the constructor) has to be passed here, in order for this constructor to work.
    • Method Detail

      • toString

        🡅  🡇    
        public java.lang.String toString()
        Generates a string of this constructor, with most information included.

        NOTE: This will not return every piece of information contained by this class. For example, both the constructor body, and any possible JavaDoc Comments are not included. For a more enhanced toString() version, call the one that accepts flags.
        toString in class Callable
        A printable string of this field.
        See Also:
        PF, toString(int), StrCSV.toCSV(String[], boolean, boolean, Integer)
        Exact Method Body:
             "Name:            [" + name + "]\n" +
             "Signature:       [" + StrPrint.abbrevEndRDSF(signature, MAX_STR_LEN, true) + "]\n" +
             "Modifiers:       [" + StrCSV.toCSV(modifiers, true, true, null) + "]\n" +
             printedParameterNamesTS() +
             printedParameterTypesTS() +
             printedExceptionsTS() +
             // This will **NEVER** be null - unless 'this' instance was built from an HTML File,
             // rather than a source-code file.  Instances like that are only used temporarily, and
             // are garbage collected instantly.  Do this check anyway (just in case).
             "Location:        " + ((this.location == null)
                 ? "null" 
                 : ('[' + this.location.quickSummary() + ']'));
      • toString

        🡅  🡇    
        public java.lang.String toString​(int flags)
        This class expects a flags that has been masked using the constant (public, static, final int) fields of class PF. Please view this class for more information about the flags available for modifying the return-value of this toString() method.
        toString in class Callable
        flags - These are the toString flags from class PF ("Print Flags"). View available flags listed in class PF.
        A printable String of this Constructor, with comment information included as well.
        See Also:
        toString(), StrCSV.toCSV(String[], boolean, boolean, Integer), PF
        Exact Method Body:
         boolean color = (flags & UNIX_COLORS) > 0;
             printedName("Constructor", 20, color) + 
             printedSignature(20, color) +
             printedModifiers(20) +
             printedParamNames() + 
             printedParamTypes(jowFlags(flags)) +
             printedExceptions() +
             printedLocation(20, color, (flags & BRIEF_LOCATION) > 0) +
             // The previous method does not add a '\n' end to the end of the returned string
             // These are both optional, they add a '\n' AT THE BEGINNING if one of them is included
             printedComments(20, color, (flags & JAVADOC_COMMENTS) > 0) +
      • clone

        🡅  🡇    
        public Constructor clone()
        Java's interface Cloneable requirements. This instantiates a new Constructor with identical fields.
        clone in class java.lang.Object
        A new Constructor whose internal fields are identical to this one. A deep copy on all internal arrays is performed. New arrays are instantiated.
        Exact Method Body:
         return new Constructor(this);
      • compareTo

        🡅  🡇    
        public int compareTo​(Constructor c)
        Java's interface Comparable<T> requirements. This looks at the number of parameters, and parameter types in making a sort-decision.
        Specified by:
        compareTo in interface java.lang.Comparable<Constructor>
        c - Any other Constructor to be compared to 'this' Constructor
        An integer that fulfils Java's interface Comparable<Constructor> public boolean compareTo(Constructor c) method requirements.
        Exact Method Body:
         if (this == c) return 0;
         int ret = this.numParameters() - c.numParameters();
         if (ret != 0) return ret;
         if (this.parameterTypesJOW != null)
             for (int i=0; i < this.parameterTypesJOW.length; i++)
                 if ((ret = this.parameterTypesJOW[i].compareTo(c.parameterTypesJOW[i])) != 0)
                     return ret;
         return 0;
      • equals

        public boolean equals​(Constructor other)
        This should be called an "atypical version" of the usual equals(Object other) constructor. This version of equals merely compares the name and parameters-list of the constructor. The presumption here is that the definition of a 'constructor' only has meaning - at all - inside the context of a class or enumerated-type where that constructor is defined. Since inside any '.java' source-code file, there may only be one constructor with a given parameter-list, this shall return TRUE whenever the constructor being compared has the same parameter types as 'this' does.
        other - This may be any other constructor. It is strongly suggested that this be a constructor defined in the same '.java' source-code file as 'this' constructor.
        This method returns TRUE when 'this' instance of Constructor has the same parameter-list as 'other'.
        Exact Method Body:
         // If the number of parameters in the 'other' instance of Constructor differ from the
         // number of parameters in 'this' Constructor, then return FALSE immediately.  It cannot be
         // a match
         if (this.numParameters() != other.numParameters()) return false;
         // If there are no parameters (for either of them), then return true immediately
         if (this.numParameters() == 0) return true;
         // If any of the parameter-names are different, break immediately and return false;
         for (int i=0; i < this.parameterNames.length; i++)
             if (! this.parameterNames[i].equals(other.parameterNames[i]))
                 return false;
         // If the parameter-types listed by the javadoc '.html' file differ from parameter-types
         // listed in the original '.java' source-code file, then break immediately.
         // NOTE: The "package-information" for the FULL CLASS OR INTERFACE NAME is not always
         // available.
         for (int i=0; i < this.parameterTypes.length; i++)
             if (! this.parameterTypesJOW[i].equals(other.parameterTypesJOW[i]))
                 return false;
         // ALL TESTS PASSED
         return true;