Class RearrangePkgFrame

  • public class RearrangePkgFrame
    extends java.lang.Object
    Process Java Doc Web-Page: Organizes CIET items and generates sub-header labels for Java Doc Package-Summary and Package-Frame HTML-Files, by way of user-provided configuration classes.

    This class allows a user to specify the arrangement of the files on both the package-summary.html files, and the package-frame.html files that are generated by Java Doc. Though the Frames option has been depracted by later versions of Java Doc, this was an extremely useful/convenient way to traverse Java Doc web-pages.

    Both the Package Summary pages, and the Frame pages lists arrange the entities on the page for a particular package in categories such as: Classes, Interfaces, Enums, Errors, Exceptions and also Annotations. If such a list is just to generic and ordinary to be useful, new orders and new sections may be created using this class.

    Note that the input arrays are provided by a 'Configuration Class'. Click below to see the Package-Frame and Package-Summary Rearrangement Configuration Classes that are actualjy used by this Java-HTML JAR Distribution Upgrade-Files: The most recen sorters for the package Torello.HTML and for Torello.Java are fully listed in these HiLited Source Code Files, below:

    All that is entailed when writing a Package-Summary-Sorter File, is the creation of a '.java' source-code file in the 'upgrade-files/config-classes/' sub-directory. That sub-directory should be located inside the source-code Package-Directory of whatever Java Package which you would like sorted by the Java Doc Upgrader. The above listed files, which are the exact Package-Summary-Sorters that were used to compile the current version of Java HTML (the one you are reading, right now), were placed in the directories listed here:

    • Torello/HTML/upgrade-files/config-classes/
    • Torello/Java/upgrade-files/config-classes/

    For a more visual explanation of what the primary method in this class does, please review the following before and after screen clips for a re-arranged package-frame.html file:

    RearrangePkgFrame Example

    The image below shows how a package-summary.html file is changed:

    PackageSummaries Example

Stateless Class: This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member field. It is very similar to the Java-Bean @Stateless Annotation.
  • 1 Constructor(s), 1 declared private, zero-argument constructor
  • 7 Method(s), 7 declared static
  • 12 Field(s), 12 declared static, 12 declared final

    • Method Summary

      • Methods inherited from class java.lang.Object

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


        public static final java.lang.String JD_FRAMES_WARNING_MESSAGE
        In order to generate 'package-frame.html' files, you must pass the --frames switch to the Java Doc Command Line Tool. When you do, you will receive this warning messsage.
        See Also:
        Constant Field Values
        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";