Class Location

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class Location
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
    Location Information storing line-number, column-number and character-number for items inside of a Java Source-Code File (a '.java' file).
    See Also:
    Serialized Form


    • Field Detail

      • serialVersionUID

        🡇  ⇈  ⮫ 🗕  🗗  🗖 
        protected 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:
         protected static final long serialVersionUID = 1;

      • signatureStartPos

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int signatureStartPos
        Entity/Member Signature Starting Character-Position: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 10, Column 5

        The first character (blinking caret in the hilited code above) of the Method-Signature for example-method 'area(float)' is at character number 216 of the Source-Code. That character is the letter 'p'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.signatureStartPos field would be '216'. This means it is the 216th character in the '.java' text-file.

        NOTE: Character Positions in Class Location are chosen such that:

        Java Line of Code:
        sourceFileAsString.substring(location.signatureStartPos, location.signatureEndPos)
    .equals("public static float area(float radius)");

      • signatureStartLine

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int signatureStartLine
        Entity/Member Signature Starting Line-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 10, Column 5 

        The first character (blinking caret in the hilited code above) of the Method-Signature for example-method 'area(float)' is located on Line 10 of the Source-Code Text. That character is the letter 'p'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.signatureStartLine field would be '10' .

      • signatureStartCol

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int signatureStartCol
        Entity/Member Signature Starting Column-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 10, Column 5 

        The first character (blinking caret in the hilited code above) of the Method-Signature for example-method 'area(float)' falls inside column 5. Here, that character is the letter 'p' - and it is preceeded by four space-characters, thereby placing it inside the 5th column of the Source-Code Text.

        In the example above, for the Method-Entity 'area', the value of this class' Location.signatureStartCol field would be '5'.

      • signatureEndPos

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int signatureEndPos
        Entity/Member Signature Ending Character-Position: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius) 
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 10, Column 43

        The last character (blinking caret in the hilited code above) of the Method-Signature for example-method 'area(float)' is a new-line '\n' character - and it was preceeded by the closeing parenthesis character ')'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.signatureEndPos field would be '253'. This means it is the 253rd character in the '.java' text-file.

        NOTE: Character Positions in Class Location are chosen such that:

        Java Line of Code:
        sourceFileAsString.substring(location.signatureStartPos, location.signatureEndPos)
    .equals("public static float area(float radius)");

      • signatureEndLine

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int signatureEndLine
        Entity/Member Signature Ending Line-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius) 
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 10, Column 43 

        The first character (blinking caret in the hilited code above) of the Method-Signature for example-method 'area(float)' is located on Line 10 of the Source-Code Text. That particular character happens to be a new-line '\n' which immediately follows the closing parenthesis ')' character.

        In the example above, for the Method-Entity 'area', the value of this class' Location.signatureEndLine field would be '10'.

      • signatureEndCol

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int signatureEndCol
        Entity/Member Signature Ending Column-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius) 
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 10, Column 43 

        The last character (blinking caret in the hilited code above) of the Method-Signature for example-method 'area(float)' falls inside Column 43. Here, that character is actually a new-line '\n' character that immediately follows the closing parenthesis ')'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.signatureEndCol field would be '43'.

      • jdcStartPos

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int jdcStartPos
        Java-Doc Comment Starting Character-Position: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 5, Column 5

        The first character (blinking caret in the hilited code above) of the Java-Doc Comment for example-method 'area(float)' is character number 56 of the Source-Code. That character is a forward-slash '/'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.jdcStartPos field would be '56'. This means it is the 56th character in the '.java' text-file.

        NOTE: Character Positions in Class Location are chosen as follows. In the line of code below, the String-Value has been abbreviated. This is done solely to make this code more readable on this documentation page.

        Java Line of Code:
        sourceFileAsStr.substring(location.jdcStartPos, location.jdcEndPos)
    .equals("/**\n        * Computes the area of a circle.\n        * @param radius ... */");

      • jdcStartLine

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int jdcStartLine
        Java-Doc Comment Starting Line-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 5, Column 5 

        The first character (blinking caret in the hilited code above) of the Java-Doc Comment for example-method 'area(float)' is located on Line 5 of the Source-Code Text. That character is a forward-slash '/'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.jdcStartLine field would be '5' .

      • jdcStartCol

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int jdcStartCol
        Java-Doc Comment Starting Column-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 5, Column 5 

        The first character (blinking caret in the hilited code above) of the Java-Doc Comment for example-method 'area(float)' falls inside column 5. Here, that character is a forward-slash '/' - and it is preceeded by four space-characters, thereby placing it inside the 5th column of the Source-Code Text.

        In the example above, for the Method-Entity 'area', the value of this class' Location.jdcStartCol field would be '5'.

      • jdcEndPos

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int jdcEndPos
        Java-Doc Comment Ending Character-Position: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */ 
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 9, Column 8

        The last character (blinking caret in the hilited code above) of the Java-Doc Comment for example-method 'area(float)' is a new-line '\n' character that is immediately preceeded by the close-comment sequence '*/'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.jdcEndPos field would be '210'. This means it is the 210th character in the '.java' text-file.

        NOTE: Character Positions in Class Location are chosen as follows. In the line of code below, the String-Value has been abbreviated. This is done solely to make this code more readable on this documentation page.

        Java Line of Code:
        sourceFileAsStr.substring(location.jdcStartPos, location.jdcEndPos)
    .equals("/**\n        * Computes the area of a circle.\n        * @param radius ... */");

      • jdcEndLine

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int jdcEndLine
        Java-Doc Comment Ending Line-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */ 
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 9, Column 8 

        The first character (blinking caret in the hilited code above) of the Java-Doc Comment for example-method 'area(float)' is located on Line 9 of the Source-Code Text. That particular character is the new-line '\n' immediately following the closing forward-slash '/' character.

        In the example above, for the Method-Entity 'area', the value of this class' Location.jdcEndLine field would be '9'.

      • jdcEndCol

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int jdcEndCol
        Java-Doc Comment Ending Column-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */ 
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 9, Column 8 

        The last character (blinking caret in the hilited code above) of the Java-Doc Comment for example-method 'area(float)' falls inside Column 8. Here, that character is actually a new-line '\n' character - and it was preceeded by the close-comment sequence '*/'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.jdcEndCol field would be '8'.

      • bodyStartPos

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int bodyStartPos
        Entity/Member Body Starting Character-Position: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 11, Column 42

        The first character (blinking caret in the hilited code above) of the Java-Doc Comment for example-method 'area(float)' is character number 259 of the Source-Code. That character is the opening squiggly-brace character ('{').

        In the example above, for the Method-Entity 'area', the value of this class' Location.bodySartPos field would be '259'. This means it is the 259th character in the '.java' text-file.

        NOTE: Character Positions in Class Location are chosen such that:

        Java Line of Code:
        sourceFileAsString.substring(location.bodyStartPos, location.bodyEndPos)
    .equals("{ return (float) Math.PI * radius * radius; }");

      • bodyStartLine

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int bodyStartLine
        Entity/Member Body Starting Line-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 11, Column 42 

        The first character (blinking caret in the hilited code above) of the Method-Body for example-method 'area(float)' is located on Line 11 of the Source-Code Text. That particular character is an opening squiggly-brace '{'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.bodyStartLine field would be '11' .

      • bodyStartCol

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int bodyStartCol
        Entity/Member Body Starting Column-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; }
12  }
        Line 11, Column 42 

        The first character (blinking caret in the hilited code above) of the Method-Body for example-method 'area(float)' falls inside column 5. Here, that character is a squiggly-brace '{' - and it is preceeded by four space-characters, thereby placing it inside the 5th column of the Source-Code Text.

        In the example above, for the Method-Entity 'area', the value of this class' Location.bodyStartCol field would be '5'.

      • bodyEndPos

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int bodyEndPos
        Entity/Member Body Ending Character-Position: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; } 
12  }
        Line 11, Column 50

        The last character (blinking caret in the hilited code above) of the Method-Body of example-method 'area(float)' is the new-line '\n' character that immediately follows the block-statement's closing squiggly-brace '}'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.bodyEndPos field would be '303'. This means it is the 303rd character in the '.java' text-file.

        NOTE: Character Positions in Class Location are chosen such that:

        Java Line of Code:
        sourceFileAsString.substring(location.bodyStartPos, location.bodyEndPos)
    .equals("{ return (float) Math.PI * radius * radius; }");

      • bodyEndLine

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int bodyEndLine
        Entity/Member Body Ending Line-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; } 
12  }
        Line 11, Column 50 

        The last character (blinking caret in the hilited code above) of the Method-Bodyof example-method 'area(float)' is located on Line 11 of the Source-Code Text. The character that is actually blinking is the new-line '\n' that immediately follows the block-statement's closing squiggly-brace '}'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.bodyEndLine field would be '11'.

      • bodyEndCol

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final int bodyEndCol
        Entity/Member Body Ending Column-Number: 

        1  package Example.Math;
2  
3  public class GeometryClass
4  {
5       /**
6        * Computes the area of a circle.
7        * @param radius The radius of any circle
8        * @return The area of a circle having the given radius
9        */
10      public static float area(float radius)
11      { return (float) Math.PI * radius * radius; } 
12  }
        Line 11, Column 50 

        The last character (blinking caret in the hilited code above) of the Method Body for example-method 'area(float)' falls inside Column 50. Here, that character is actually a new-line '\n' - the one immediately preceeded by the close block-statement character, namely the closing squiggly-brace '}'.

        In the example above, for the Method-Entity 'area', the value of this class' Location.bodyEndCol field would be '50'.

    • Method Detail

      • toString

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public java.lang.String toString()
        Standard Java toString() method
        Overrides:
        toString in class java.lang.Object
        Returns:
        Returns the contents of this class, as a java.lang.String
        Code:
        Exact Method Body:
         return
     "signatureStartPos:  " + signatureStartPos + '\n' +
     "signatureStartLine: " + signatureStartLine + '\n' +
     "signatureStartCol:  " + signatureStartCol + '\n' +
    
     "signatureEndPos:    " + signatureEndPos + '\n' +
     "signatureEndLine:   " + signatureEndLine + '\n' +
     "signatureEndCol:    " + signatureEndCol + '\n' +
    
     "jdcStartPos:        " + jdcStartPos + '\n' +
     "jdcStartLine:       " + jdcStartLine + '\n' +
     "jdcStartCol:        " + jdcStartCol + '\n' +
    
     "jdcEndPos:          " + jdcEndPos + '\n' +
     "jdcEndLine:         " + jdcEndLine + '\n' +
     "jdcEndCol:          " + jdcEndCol + '\n' +
    
     "bodyStartPos:       " + bodyStartPos + '\n' +
     "bodyStartLine:      " + bodyStartLine + '\n' +
     "bodyStartCol:       " + bodyStartCol + '\n' +
    
     "bodyEndPos:         " + bodyEndPos + '\n' +
     "bodyEndLine:        " + bodyEndLine + '\n' +
     "bodyEndCol:         " + bodyEndCol + '\n';

      • clone

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public java.lang.Object clone()
        Standard Java clone() method
        Overrides:
        clone in class java.lang.Object
        Returns:
        Returns a copy of 'this' instance
        Code:
        Exact Method Body:
         return new Location(this);

      • equals

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public boolean equals​(java.lang.Object other)
        Standard Java equals() method
        Overrides:
        equals in class java.lang.Object
        Parameters:
        other - This may be any Java Object, but one that extends class 'Location' has the potential to result in a TRUE evaluation from this method.
        Returns:
        TRUE if and only if the contents of 'this' instance are identical to the contents of 'other' (and only if 'other' is actually an instance of Location, or extends at least extends it).
        Code:
        Exact Method Body:
         if (! Location.class.isAssignableFrom(other.getClass())) return false;

 Location l = (Location) other;

 return
         (this.signatureStartPos     == l.signatureStartPos)
     &&  (this.signatureStartLine    == l.signatureStartLine)
     &&  (this.signatureStartCol     == l.signatureStartCol)
    
     &&  (this.signatureEndPos       == l.signatureEndPos)
     &&  (this.signatureEndLine      == l.signatureEndLine)
     &&  (this.signatureEndCol       == l.signatureEndCol)
    
     &&  (this.jdcStartPos           == l.jdcStartPos)
     &&  (this.jdcStartLine          == l.jdcStartLine)
     &&  (this.jdcStartCol           == l.jdcStartCol)
    
     &&  (this.jdcEndPos             == l.jdcEndPos)
     &&  (this.jdcEndLine            == l.jdcEndLine)
     &&  (this.jdcEndCol             == l.jdcEndCol)
    
     &&  (this.bodyStartPos          == l.bodyStartPos)
     &&  (this.bodyStartLine         == l.bodyStartLine)
     &&  (this.bodyStartCol          == l.bodyStartCol)
    
     &&  (this.bodyEndPos            == l.bodyEndPos)
     &&  (this.bodyEndLine           == l.bodyEndLine)
     &&  (this.bodyEndCol            == l.bodyEndCol);

      • hashCode

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public int hashCode()
        Simply invokes the hashCode() static-method provided by class java.lang.Integer.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for this object.
        Code:
        Exact Method Body:
         return Integer.hashCode(this.signatureStartPos * this.signatureEndPos);

      • toString

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public java.lang.String toString​(int flags,
                                 java.lang.String srcFileAsStr)
        Generates a String - with all information available, including any content requested by the 'flags' parameter.
        Parameters:
        flags - These are the toString(...) flags from class PF ("Print Flags"). View available flags listed in class PF.
        srcFileAsStr - This parameter should contain the complete '.java' source-code file as a String. If you have passed the Print-Flags for requesting that the body or Java-Doc Comment be output to the returned-String, this parameter must be passed a valid copy of the '.java' File.

        This parameter may be null, and if it is it will be ignored. When null is passed to this parameter, the actual Body, Java-Doc Comment & Signature simply cannot be extracted, and the output of this toString method shall only print the location numbers, column's and line-numbers instead.

        If a valid copy of the contents of the '.java' file that produced 'this' instance of Location is passed and if the appropriate Print-Flags are passed tot he 'flags' parameter requesting that the specified-elements (signature, comment and body) be output to the returned-String, then those elements will be printed to the output-String.

        NOTE: If the contents of parameter 'srcFileAsstr' are not the exact and un-modified contents of the '.java file that produced 'this' instance of location, then the String returned will contain erroneous information. It is even possible that a StringIndexOutOfBoundsException may be thrown.
        Returns:
        A printable String of the locations represented by this instance
        See Also:
        PF, StrCSV.toCSV(String[], boolean, boolean, Integer), toString()
        Code:
        Exact Method Body:
         boolean color       = (flags & UNIX_COLORS) > 0;
 boolean src         = srcFileAsStr != null;
 boolean signature   = src;
 boolean bodyShort   = src && ((flags & BODY_SHORT) > 0);
 boolean bodyLong    = (! bodyShort) && src && ((flags & BODY) > 0);
 boolean jdc         = src && ((flags & JAVADOC_COMMENTS) > 0);
 boolean locShort    = (flags & BRIEF_LOCATION) > 0;
 int     M_OVER_2    = MAX_STR_LEN / 2;

 if (locShort) return

     (signature
         ? ("Signature:        " + StrIndent.indentAfter2ndLine
             (srcFileAsStr.substring(signatureStartPos, signatureEndPos), 4, true, false) +
             '\n')
         : "") +

     "Signature-Start:  " +
     "pos="  + (color ? BGREEN : "") + signatureStartPos  + (color ? RESET : "") + ", " +
     "line=" + (color ? BGREEN : "") + signatureStartLine + (color ? RESET : "") + ", " +
     "col="  + (color ? BGREEN : "") + signatureStartCol  + (color ? RESET : "") + "\n" +

     "Signature-End:    " +
     "pos="  + (color ? BCYAN : "") + signatureEndPos  + (color ? RESET : "") + ", " +
     "line=" + (color ? BCYAN : "") + signatureEndLine + (color ? RESET : "") + ", " +
     "col="  + (color ? BCYAN : "") + signatureEndCol  + (color ? RESET : "") + "\n" +

     (jdc
         ? ("Java-Doc Comment: " + StrPrint.abbrev(srcFileAsStr.substring
             (jdcStartPos, jdcEndPos), M_OVER_2, true, null, MAX_STR_LEN) + '\n')
         : "") +

     "Java-Doc-Start:   " +
     "pos="  + (color ? BGREEN : "") + jdcStartPos  + (color ? RESET : "") + ", " +
     "line=" + (color ? BGREEN : "") + jdcStartLine + (color ? RESET : "") + ", " +
     "col="  + (color ? BGREEN : "") + jdcStartCol  + (color ? RESET : "") + "\n" +

     "Java-Doc-End:     " +
     "pos="  + (color ? BCYAN : "") + jdcEndPos  + (color ? RESET : "") + ", " +
     "line=" + (color ? BCYAN : "") + jdcEndLine + (color ? RESET : "") + ", " +
     "col="  + (color ? BCYAN : "") + jdcEndCol  + (color ? RESET : "") + "\n" +

     (bodyShort
         ? ("Body:             " + StrPrint.abbrev(srcFileAsStr.substring
             (signatureStartPos, signatureEndPos), M_OVER_2, true, null, MAX_STR_LEN))
         : "") +

     (bodyLong
         ? ("Body:             " + StrIndent.indentAfter2ndLine
             (srcFileAsStr.substring(signatureStartPos, signatureEndPos), 4, true, false))
         : "") +

     "Body-Start:       " +
     "pos="  + (color ? BGREEN : "") + bodyStartPos  + (color ? RESET : "") + ", " +
     "line=" + (color ? BGREEN : "") + bodyStartLine + (color ? RESET : "") + ", " +
     "col="  + (color ? BGREEN : "") + bodyStartCol  + (color ? RESET : "") + "\n" +

     "Body-End:         " +
     "pos="  + (color ? BCYAN : "") + bodyEndPos  + (color ? RESET : "") + ", " +
     "line=" + (color ? BCYAN : "") + bodyEndLine + (color ? RESET : "") + ", " +
     "col="  + (color ? BCYAN : "") + bodyEndCol  + (color ? RESET : "");

 else return

     (signature
         ? ("SIGNATURE: " + StrIndent.indentAfter2ndLine
             (srcFileAsStr.substring(signatureStartPos, signatureEndPos), 4, true, false))
         : "") +

     "signatureStartPos:  " + (color ? BGREEN : "") + signatureStartPos + '\n' +
         (color ? RESET : "") + 
     "signatureStartLine: " + (color ? BGREEN : "") + signatureStartLine + '\n' +
         (color ? RESET : "") + 
     "signatureStartCol:  " + (color ? BGREEN : "") + signatureStartCol + '\n' +
         (color ? RESET : "") + 
    
     "signatureEndPos:    " + (color ? BCYAN : "") + signatureEndPos + '\n' +
         (color ? RESET : "") + 
     "signatureEndLine:   " + (color ? BCYAN : "") + signatureEndLine + '\n' +
         (color ? RESET : "") + 
     "signatureEndCol:    " + (color ? BCYAN : "") + signatureEndCol + '\n' +
         (color ? RESET : "") + 

     (jdc
         ? ("BODY: " + StrPrint.abbrev(srcFileAsStr.substring
             (jdcStartPos, jdcEndPos), M_OVER_2, true, null, MAX_STR_LEN))
         : "") +

     "jdcStartPos:        " + (color ? BGREEN : "") + jdcStartPos + '\n' +
         (color ? RESET : "") + 
     "jdcStartLine:       " + (color ? BGREEN : "") + jdcStartLine + '\n' +
         (color ? RESET : "") + 
     "jdcStartCol:        " + (color ? BGREEN : "") + jdcStartCol + '\n' +
         (color ? RESET : "") + 

     "jdcEndPos:          " + (color ? BCYAN : "") + jdcEndPos + '\n' +
         (color ? RESET : "") + 
     "jdcEndLine:         " + (color ? BCYAN : "") + jdcEndLine + '\n' +
         (color ? RESET : "") + 
     "jdcEndCol:          " + (color ? BCYAN : "") + jdcEndCol + '\n' +
         (color ? RESET : "") + 

     (bodyShort
         ? ("BODY: " + StrPrint.abbrev(srcFileAsStr.substring
             (signatureStartPos, signatureEndPos), M_OVER_2, true, null, MAX_STR_LEN))
         : "") +

     (bodyLong
         ? ("BODY: " + StrIndent.indentAfter2ndLine
             (srcFileAsStr.substring(signatureStartPos, signatureEndPos), 4, true, false))
         : "") +

     "bodyStartPos:       " + (color ? BGREEN : "") + bodyStartPos +'\n' +
         (color ? RESET : "") + 
     "bodyStartLine:      " + (color ? BGREEN : "") + bodyStartLine + '\n' +
         (color ? RESET : "") +
     "bodyStartCol:       " + (color ? BGREEN : "") + bodyStartCol + '\n' +
         (color ? RESET : "") + 

     "bodyEndPos:         " + (color ? BCYAN : "") + bodyEndPos + '\n' +
         (color ? RESET : "") + 
     "bodyEndLine:        " + (color ? BCYAN : "") + bodyEndLine + '\n' +
         (color ? RESET : "") + 
     "bodyEndCol:         " + (color ? BCYAN : "") + bodyEndCol + '\n' +
         (color ? RESET : "");

      • quickSummary

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public java.lang.String quickSummary()
        Produces a quick-summary, as a String.
        Returns:
        a very brief summary of the information contained by this class. Lists only the starting line numbers for the three sections.
        Code:
        Exact Method Body:
         return "signature-line=" + this.signatureStartLine + ", javadoc-line=" + this.jdcStartLine +
     ", body-line=" + this.bodyStartLine;