Class CleanPackageSummaries

  • public class CleanPackageSummaries
    extends java.lang.Object
    Process Java Doc Web-Page: Simple utility for modifying Java Doc Package-Summary Files, using a user-provided function-pointer or lamda.

    JD-Upgrader Internally Used Class, Methods are Package-Private

    There is largely no use for these methods outside of the Java Doc Upgrader Application. Little Java-Doc Style Documentation will be provided here. The code itself (and code comments) may be viewed using the HiLited Source Code Button in the Navigation-Bar, or the URL-Link that is lower on this page.

    To see how this Upgrader Application class works, click the HiLited Source Code Link above.

    Each complete Java Package has a 'Summary Page' created for it, using an '.html' file simply named 'package-summary.html'. The general structure of the page is great. The user is encouraged to write a '' file, and include it in the package's source-code directory. The issue is that an 'AI', of sorts, adds in the list of classes, interfaces, enums, exceptions and errors that comprise the package along with a brief-description explaining what that class, interface etc... does.

    The problem is that if there is any complexity to the code-comments for any of those classes, interfaces etc. - the summary itself will looked horribly skewed. This class attempt to 'clean up' the 'package-summary.html' pages by simply removing the extraneous HTML inserted into the page. The Upgrader Tool provides a means to insert your own 'Summary Cleaner' - although the default cleaner works very well. To register a Package Summary Cleaner with the Upgrader before it runs, invoke the method Upgrade.setPackageSummaryCleaner(Consumer)

    This type of Lambda is actually very easy to write, if you are capable at using the HTML manipulation and modification methods in the HTML Package. Review the code in the default cleaner to see how it simply strip away everything after the first sentence in a package summary page.

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
  • 2 Method(s), 2 declared static
  • 1 Field(s), 1 declared static, 1 declared final

    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait