Class PackageSummaryHTML

    • 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;

      • JD_FRAMES_WARNING_MESSAGE

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String JD_FRAMES_WARNING_MESSAGE
        Deprecated, but useful API Error-Message
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
         public static final String JD_FRAMES_WARNING_MESSAGE =
         "javadoc: warning - You have specified to generate frames, by using the --frames " +
             "option.\n" +
         "The default is currently to not generate frames and the support for \n" +
         "frames will be removed in a future release.\n" +
         "To suppress this warning, remove the --frames option and avoid the use of frames.\n";

      • packageName

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final java.lang.String packageName
        The name of the Java Package represented by this instance.
        Code:
        Exact Field Declaration Expression:
         public final String packageName;

    • Method Detail

      • head

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public java.util.Vector<HTMLNode> head()
        Allows a User to both retrieve and to modify the contents of the 'package-summary.html' <HEAD>-Section.
        Returns:
        Vectorized-HTML of this Web-Page's <HEAD>...</HEAD> Section.
        Code:
        Exact Method Body:
         return this.head.html;

      • topNavBar

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public java.util.Vector<HTMLNode> topNavBar()
        Allows a User to both retrieve and to modify the contents of the 'package-summary.html' Nav-Bar.
        Returns:
        Vectorized-HTML of this Web-Page's Upper Navigation Menu-Bar.
        Code:
        Exact Method Body:
         return (this.topNavBar == null) ? null : this.topNavBar.html;

      • bottomNavBar

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public java.util.Vector<HTMLNode> bottomNavBar()
        Allows a User to both retrieve and to modify the contents of the 'package-summary.html' Nav-Bar.
        Returns:
        Vectorized-HTML of this Web-Page's Lower Navigation Menu-Bar.
        Code:
        Exact Method Body:
         return (this.bottomNavBar == null) ? null : this.bottomNavBar.html;

      • description

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public java.util.Vector<HTMLNode> description()
        Allows a User to both retrieve and to modify the contents of the 'package-summary.html' Description Text-Area.
        Returns:
        Vectorized-HTML of this Web-Page's Main Description Box.
        Code:
        Exact Method Body:
         return this.description.html;

      • defaultCleaner

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public static final void defaultCleaner​
            (java.util.Vector<HTMLNode> cietSummary)
        Code:
        Exact Method Body:
         // boolean VERBOSE = MsgVerbose.isVerbose();

 // System.out.println("INSIDE MY LAMBDA:\n" + Util.pageToString(cietSummary));

 int i=0, nodePos=-1;

 /*
 if (VERBOSE) MsgVerbose.println
     ("cietSummary: " + BGREEN + Util.pageToString(cietSummary) + RESET);
 */

 while ((nodePos == -1) && (i < searches.length))
     nodePos = TextNodeFind.first(cietSummary, TextComparitor.CN_CI, searches[i++]);

 if (nodePos == -1)
 {
     // if (VERBOSE) MsgVerbose.println("No String Markers Found!  Exiting...");
     return;
 }

 String  s   = cietSummary.elementAt(nodePos).str;
 int     pos = StrIndexOf.first_CI(s, searches[--i]);

 /*
 if (VERBOSE) MsgVerbose.println("s: " + s);
 */

 s = s.substring(0, pos);

 /*
 if (VERBOSE) MsgVerbose.println("s.substring: " + s);
 */

 if (s.length() != 0)
     cietSummary.setElementAt(new TextNode(s), nodePos++);

 if (nodePos < cietSummary.size())
     Util.Remove.range(cietSummary, nodePos, cietSummary.size());


 // Util.removeAllTagNodes(cietSummary);
 // CHANGED March 2nd 2022

 TagNodeRemove.allExcept(cietSummary, TC.Both, "a", "b", "i", "code", "span");

 /*
 if (VERBOSE) MsgVerbose.println(
     BCYAN + Util.pageToString(cietSummary) + RESET +
     "\n************************************************************\n"
 );
 */