Class HiLiteMethods


  • public class HiLiteMethods
    extends java.lang.Object
    HiLiteMethods - Documentation.

    The primary use of this class is that it allows a user to request that the Java-Doc upgrade package hilite each and every method within an (already existing) Java-Doc HTML Class, Enumerated-Type, or Interface Page.

    NOTE: This class will only provide Method Bodies as Hilited Code, Constructors and Fields are not hilited here.

    The HiLite Method Body procedure is the one which creates segments on your Java Doc Pages that look like:

    HiLited Method Declaration




Stateless Class: This class neither contains any program-state, nor can it be instantiated.
The @StaticFunctional Annotation may also be called 'The Spaghetti Report'
  • 1 Constructor(s), 1 declared private, zero-argument constructor
  • 2 Method(s), 2 declared static
  • 1 Field(s), 1 declared static, 1 declared final


    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method
      static int run​(CommonParamRecord pr)
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • run

        public static int run​(CommonParamRecord pr)
        This method will hilite all Method's that are scraped from a Java Doc Generated HTML Documentation Page for a Class, Enumerated Type, or Interface. Hilited source-code for method-bodies (as String's) are inserted into the Java-Doc HTML Web-Page in the 'Method Details' section for any / all Method's found on the page.
        Parameters:
        pr - This contains all of the needed parameters for this method, encapsulated into a single record-class. The list is somewhat lengthy, so this makes the code "look cleaner"
        Returns:
        This will return a count on exactly how many Method's have had their code-hilited Method-bodies inserted into the JavaDoc Documentation File for this class.
        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
         26
         27
         28
         29
         30
         31
         32
         33
         34
         35
         36
         37
         38
         39
         40
         41
         42
         43
         44
         45
         46
         47
         48
         49
         50
         51
         52
         53
         54
         55
         56
         57
         58
         59
         60
         61
         62
         63
         64
         65
         66
         67
         68
         69
         70
         71
         72
         73
         74
         75
         76
         77
         78
         79
         80
         81
         82
         83
         84
         85
         86
         87
         88
         89
         90
         91
         92
         93
         94
         95
         96
         97
         98
         99
        100
        101
        102
        103
        104
        105
        106
        107
        108
        109
        110
        111
        112
        113
        114
        115
        116
        117
        118
        119
        120
        121
        122
        123
        124
        125
        126
        127
        128
        129
        130
        131
        132
        133
        134
        135
        136
        137
        138
        139
        140
        141
        142
        143
        144
        145
        146
        147
        148
        149
        150
         if (pr.sw != null) pr.sw.println("HiLiteMethods.run(...) ");
        
         int countNumMethodsHiLited  = 0;
         int numMethodsSkipped       = 0;
        
         // ********** Check whether the fileVec has any Methods in the first place  ***************
         if (Details.hasMethodDetails(pr.fileVec) == null)
         {
             if (pr.sw != null) pr.sw.println(
                 "\tJavaDoc File: " + C.BYELLOW + pr.jdFileName + C.RESET + " does not have a " +
                 "Method-Details-Section, Skipping..."
             );
             return 0; // no methods to hilite, skip this file
         }
         // ********** Check whether the fileVec has any Methods in the first place  ***************
        
        
         // ********** Iterate through every method found in the '.html' file  *********************
         HNLIInclusive   methodsIter     = Details.methodDetailsIterator(pr.fileVec);
         boolean         firstIteration  = true;
         int             cur             = 0;
        
         while (methodsIter.hasNext())
         {
             // Retrieves the next method-details section defined in the HTML file using the
             // "Method Details Iterator"
             DotPair methodDP = methodsIter.nextDotPair();
        
             // The instance of JavaDocHTMLFile (jdhf) was built using the same '.html' file, and
             // the same iterator.  Using the 'getMethod(counter)' should retrieve the parsed
             // version of this HTML-defined java method from the javadoc documentation HTML page.
             Method fromHTMLFileMethod = pr.jdhf.getMethod(cur++);
        
             // Now we need to search through all of the methods in the JavaSourceCodeFile for a
             // method with the EXACT SAME NAME AND PARAMETER LIST.
             Method  fromSrcFileMethod = (fromHTMLFileMethod   != null)
                 ? pr.jscf.findMethod(fromHTMLFileMethod)
                 : null;
        
             // Since the instance of "Method" that is retrieved from the Source-Code '.java' file
             // is guaranteed to have the "body text" filled out (as long as their was a body
             // defined for that method, i.e. - it wasn't 'abstract') - we can get that string and
             // save it and hilite it.
             String  methodBodyStr = (fromSrcFileMethod != null)
                 ? fromSrcFileMethod.body
                 : null;
        
             // Output a tab or else it will look "lopsided"
             if (pr.sw != null) if (firstIteration) { firstIteration = false; pr.sw.print('\t'); }
        
             // If there was no method body found ... skip to the next method.
             if (methodBodyStr == null)
             {
                 if (pr.sw != null)
                     pr.sw.print("[NOT-FOUND]: " + C.BRED + fromHTMLFileMethod.name + C.RESET + "  ");
        
                 numMethodsSkipped++;
                 continue;
             }
        
             // PRINT OUT THE METHOD
             if (pr.sw != null) pr.sw.print(C.BGREEN + fromHTMLFileMethod.name + C.RESET + "  ");
        
        
             // ********** Compute the Insertion Point *****************
             // The "<DL>  <DT></DT><DD></DD>  </DL>" lists are for the throws, see-also, returns,
             // etc....  The Code HiLited Method-Body HTML needs to be inserted into its own:
             // <DT>Code:</DT>\n
             // <DD> Hi-Lited Method-Body DIV created by HiLite.ME Server</DD>
             //
             // The Insertion point shall be right before the closing </DL> HTML Element.  This
             // means HiLited Code will *always* be the last 'thing' (for lack of a technical 
             // term) that you can see in a Method-Details Section.
             //
             // ALSO: There are some methods for which no Javadoc Comments have been written, and
             //       therefore, there is no HTML "Definition List" already present in that
             //       particular method's "Method Details" Section.  In this case, an HTML
             //       <DL> ... </DL> surrounding element needs to be created.
             // ********** Compute the Insertion Point *****************
        
             int insertionPoint = TagNodeFind.last
                 (pr.fileVec, methodDP.start, methodDP.end, TC.ClosingTags, "dl");
        
             boolean needToBuildDefList  = insertionPoint == -1;
        
             // ********** Compute the Insertion Point *****************
             // If we need to build the <DL> (Definition List), then we will also have to find a
             // new insertion point.  The method-details section ends with a closing '</LI>' 
             // element, and then a closing '</UL>' Element.  Right before the '</LI>' is where 
             // the insertion should occur.
             // ********** Compute the Insertion Point *****************
        
             if (needToBuildDefList) insertionPoint = TagNodeFind.last
                 (pr.fileVec, methodDP.start, methodDP.end, TC.ClosingTags, "li");
        
             if (insertionPoint == -1)
                 // This case should never happen, but keep it is here, just in case.
                 // (Kind of the point of exceptions).  Guarantees no "Index Out of Bounds" 
                 // Exceptions, and a friendly message.
             {
                 if (pr.sw != null) pr.sw.println(
                     C.BRED + "Could not determine a place to put the hilited code in the JD Page. " +
                     "NOT INSERTING CODE." + C.RESET
                 );
        
                 continue;
             }
        
             // ********** Call the Code Hilite Server *****************
             methodBodyStr = StrIndent.chompCallableBraces(methodBodyStr);
        
             try
             { 
                 methodsIter.insertAt(
                     hiLiteMethodBody(methodBodyStr, needToBuildDefList, pr.hiLiter),
                     insertionPoint
                 );
             }
             catch (IOException | HiLiteException e)
             {
                 throw new HiLiteError(
                     "Failed to HiLite Method-Body (first three lines): " +
                     "[\n" + StringParse.firstNLines(methodBodyStr, 3) + "\n].\n" +
                     "Currently Processing Java Source Code File: [" + pr.srcCodeFileName + "].\n" +
                     "Currently Processing JavaDoc HTML Documentation Page: [" + pr.jdFileName + "].\n" +
                     "Please see getCause() throwable for details.\n" + EXCC.toString(e),
                     e
                 );
             }
             // ********** Call the Code Hilite Server *****************
        
             // Loop to the next method.
             countNumMethodsHiLited++;
         }
        
         if ((countNumMethodsHiLited > 0) || (numMethodsSkipped > 0)) 
             if (pr.sw != null) pr.sw.println();
        
         if (numMethodsSkipped > 0) 
             if (pr.sw != null) pr.sw.println(
                 "\t" + C.BRED + "Skipped  " + C.RESET + 
                 C.BBLUE + StringParse.zeroPad(numMethodsSkipped, 5) + C.RESET + " Methods."
             );
        
         if (pr.sw != null) pr.sw.println(
             "\tHilited  " + C.BBLUE + StringParse.zeroPad(countNumMethodsHiLited, 5) + C.RESET +
             " Methods."
         );
        
         return countNumMethodsHiLited;