Class Constructor

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

    public class Constructor
    extends Callable
    implements java.io.Serializable, java.lang.Comparable<Constructor>, java.lang.Cloneable
    Java Parser Bridge, Constructor - Documentation.

    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 and modifiers list of a field. Such information, (hopefully) obviously, is mostly readily available from Java's reflection API. The reflection API has been around since Java was first created in the 1990's. The Java Parser library, however, allows a programmer to parse java source files that have as yet been compiled to class files and/or allow more access to the specifics of a source file.

    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:

    http://developer.torello.directory/ralphsReference/jars/javaparser-core-3.16.2.jar

    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.
    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 java.io.Serializable. 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
        Code:
        Exact Field Declaration Expression:
        1
        public static final long serialVersionUID = 1;
        
    • Constructor Detail

      • Constructor

        protected Constructor​
                    (com.github.javaparser.ast.body.ConstructorDeclaration cd,
                     boolean isSignatureOnly)
        
        Builds an instance of this class
        Parameters:
        cd - This can be retrieved in any number of ways from the JavaParser package. The instantiation process will convert a Java-Parser form of a ConstructorDeclaration, into this Bridge form class Method.
        isSignatureOnly - This constructor may be used to build an instance of Constructor using only the signature of the constructor. Without a constructor-body definition, set this parameter to TRUE; the value of the public final String body field will be null.

        NOTE: If this Java-Parser ConstructorDeclaration does have a body-defined, but this parameter is set to TRUE, the body String-field will still be null.
    • 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.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A printable string of this field.
        See Also:
        PF, toString(int), StrCSV.toCSV(String[], boolean, boolean, Integer)
        Code:
        Exact Method Body:
        1
        2
        3
        4
        5
        6
        7
         return
             "Name:            [" + name + "]\n" +
             "Signature:       [" + signature + "]\n" +
             "Modifiers:       [" + StrCSV.toCSV(modifiers, true, true, null) + "]\n" +
             "Parameter Names: [" + StrCSV.toCSV(parameterNames, true, true, null) + "]\n" +
             "Parameter Types: [" + StrCSV.toCSV(parameterTypes, true, true, null) + "]\n" +
             "Exceptions:      [" + StrCSV.toCSV(exceptions, true, true, null) + "]\n";
        
      • 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.
        Parameters:
        flags - These are the toString flags from class PF ("Print Flags"). View available flags listed in class PF.
        Returns:
        A printable String of this Constructor, with comment information included as well.
        See Also:
        toString(), StrCSV.toCSV(String[], boolean, boolean, Integer), PF
        Code:
        Exact Method Body:
         1
         2
         3
         4
         5
         6
         7
         8
         9
        10
        11
        12
        13
        14
        15
        16
        17
        18
        19
        20
        21
        22
        23
        24
        25
         boolean color           = (flags & PF.UNIX_COLORS) > 0;
         boolean comments        = (flags & PF.JAVADOC_COMMENTS) > 0;
         boolean constrBody      = (flags & PF.BODY) > 0;
         boolean shortConstrBody = (flags & PF.BODY_SHORT) > 0;
        
         if (constrBody && shortConstrBody) constrBody = false;
        
         String  bodyStr         = this.body;
         if (shortConstrBody)
         {
             int pos = StrIndexOf.nth(body, 3, '\n');
             if (pos != -1) bodyStr = body.substring(0, pos);
         }
        
         return
             "Name:                   [" + (color ? C.BCYAN : "") + name + (color ? C.RESET : "") + "]\n" +
             "Signature:              [" + (color ? C.BYELLOW : "") + signature + (color ? C.RESET : "") + "]\n" +
             "Modifiers:              [" + StrCSV.toCSV(modifiers, true, true, null) + "]\n" +
             "Parameter Names:        [" + StrCSV.toCSV(parameterNames, true, true, null) + "]\n" +
             "Parameter Types:        [" + StrCSV.toCSV(parameterTypes, true, true, null) + "]\n" +
             "Exceptions:             [" + StrCSV.toCSV(exceptions, true, true, null) + "]\n" +
        
             (comments ?         ("Comments:               [\n" + (color ? C.BGREEN : "") + jdComment + (color ? C.RESET : "") + "\n]\n") : "") +
             (constrBody ?       ("Constructor Body:       [\n" + bodyStr + "\n]\n") : "") +
             (shortConstrBody ?  ("Short Constructor Body: [\n" + bodyStr + "\n]\n") : "");
        
      • clone

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

        public int compareTo​(Constructor c)
        Java's interface Comparable<T> requirements. This does a very simple comparison using the underlying field final String name and also final String signature.
        Specified by:
        compareTo in interface java.lang.Comparable<Constructor>
        Parameters:
        c - Any other Constructor to be compared to 'this' Constructor
        Returns:
        An integer that fulfils Java's interface Comparable<T> public boolean compareTo(T t) method requirements.
        Code:
        Exact Method Body:
        1
        2
         int ret = this.name.compareTo(c.name);
         return (ret != 0) ? ret : this.signature.compareTo(c.signature);
        
      • 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.
        Parameters:
        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.
        Returns:
        This method returns TRUE when 'this' instance of Constructor has the same parameter-list as 'other'.
        Code:
        Exact Method Body:
         1
         2
         3
         4
         5
         6
         7
         8
         9
        10
        11
        12
        13
        14
        15
        16
         // 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.parameterNames.length != other.parameterNames.length) return false;
        
         // 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 the 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.parameterTypesNoPackage[i].equals(other.parameterTypesNoPackage[i])) return false;
        
         // ALL TESTS PASSED
         return true;