Package Torello.JavaDoc

This package utilizes the value of an HTML Parser and Search Engine for allowing a user to transform, modify, add-to, and delete HTML nodes (automatically) into an HTML page. The package JavaDoc does this for programmers who would like to do things like automatically add code-hilited code-snippets, for example, directly onto their professionally written Java-Doc Comment-HTML Pages.

There is a Java-Parser Library that is required to use this Package. The Java Doc Upgrader Package / Tool will not work without this '.jar' file being placed in your CLASSPATH environment-variable. That '.jar' is available here:

http://developer.torello.directory/ralphsReference/jars/javaparser-core-3.16.2.jar

Primary User API
Java Entity	Description
Upgrade	The primary builder and configuration class for the Java Doc Upgrade Process, having many customizations that may be requested using the customize-settings methods available here
Reflection API (Optional Use)
Java Entity	Description
UserProcessorAll	This may be implemented to process all Java-Doc Generated Web-Pages for an entire package
UserProcessorPage	An interface that may be implemented by a user to execute detailed customizations and modifications to a specific Java-Doc Web Page
JavaDocHTMLFile	Retains all information parsed from a '.html' Java-Doc web-page, and borrows any missing information that was found in the '.java' source-code file; note that an instance-reference of this class may be rerieved, and used, to further change a Java Doc page by registering a visitor-handler with the configuration class Upgrade by calling Upgrade
SummaryTableHTML<ENTITY extends Declaration>	This class stores the HTML for a Summary-Table - which is the table at the top of a Java Doc Page listing all of one type of entities present in the CIET/Type
ReflHTML<ENTITY extends Declaration>	This class stores the HTML Detail-Descriptions retrieved from a Java Doc web-page 'Details Section', and simultaneously, holds the reflection-data extracted from the '.java' corresponding source-code files - facilitating all changes to a Java Doc Page deemed necessary
HeaderFooterHTML	Encapsulates the HTML placed both the top and the bottom of a JavaDoc Web-Page, including the Navigation-Bar HTML, the Package-Name, Type-Signature and other Banner-Labesl
AnnotationElem	Java Parser Bridge: Holds all information extracted from '.java' Annotation (@interface) Source-Files about all Elements identified in that file
EnumConstant	Java Parser Bridge: Holds all information extracted from '.java' enum Source-Files about Enumerated-Constants's identified in that 'enum' file
Constructor	Java Parser Bridge: Holds all information extracted from '.java' Source-Files about Constructor's identified in that file
Field	Java Parser Bridge: Holds all information extracted from '.java' Source-Files about Field's identified in that file
Method	Java Parser Bridge: Holds all information extracted from '.java' Source-Files about Method's identified in that file
NestedType	Java Parser Bridge: Holds all information extracted from '.java' Source-Files regarding Nested-Types (Inner-Classes)
Callable	Java Parser Bridge: Common-Root Ancestor Class of both Method and Constructor
Declaration	Java Parser Bridge: Common-Root Ancestor Class of all Bridge Data-Classes
Location	Location Information storing line-number, column-number and character-number for items inside of a Java Source-Code File (a '
Internal & Helper Utility
Java Entity	Description
CSSTags	Complete List of CSS CLASS and ID Attributes that are inserted by the HTML Processor Classes CSSTagsTopAndSumm and CSSTagsDetails
HELPER	Helper for parsing Java Source-Code using Java-Parser
HiLiter	A simple Functional-Interface allowing a user to swap in any customized, alternate or proprietary Syntax HiLiter to replace the default HiLiter used by this Upgrader Tool
JDFiles	Retrieve Java Doc HTML Files from the Java Doc output directory
Messager	A replacement for System.out, System.err and even the StorageWriter class used to send error messages to the terminal about upgrade progress
ParsedFile	Parent-class of JavaDocHTMLFile and the source-code parsing classes
PF	Print Flags: Flag-Constants for pretty-printing and selecting output to Reflection API classes' toString(flags) methods
Stats	Maintains a suite of statistics about all Java project-wide source-code files
TreeUtils	This is a helpful interface to retrieve and extract the utilities provided by the Java-Compiler interface provided by the JDK
SummarySorterHelper	An abstract helper class for user-provided SummarySorter
EXPORT_PORTAL	IMPORTANT NOTE: Have a "rocket science" moment, and accept that this file **REALLY** IS **NOT** Rocket-Science! All this is doing is facilitating the "preservation" of the PACKAGE-PRIVATE levels of privacy on these methods, fields and constructors after "The Big Move" Note that "The Big Move" was putting all of the classes that were deemed "HTML Processors" because their functioning as performing modifications to JavaDoc HTML Web-Pages, those classes were no longer in the same Java-Package as the staple-classes (such as "JavaDocHTMLFile" and others like "ReflHTML")
Annotations (Optional Use)
Java Entity	Description
StaticFunctional	Java-Annotation: A Java-Annotation for marking classes as 'Stateless Classes' - used to insert 'The Spaghetti Report' into Java Doc Pages
JDHeaderBackgroundImg	Java-Annotation: A Java-Annotation for inserting a Wooden-Plank Background Image at the top of a Java-Doc Page using External-HTML File's; the image used is configurable, and my be changed by assigning the Annotation-Element Values appropriately
Enums
Java Entity	Description
CIET	CIET: Class, Interface, Enumerated-Type, Annotation (@interface) or Java 17+ Record
Entity	Entity: Exhaustive list of all items that may be defined inside of a Java Type
Excuse	An enumeration used by the StaticFunctional annotation for explaining non-static fields in a type
JDUProcessor	Enumeration containing the complete list of Java-Doc Upgrader Processing classes utilized by this Application
Exceptions & Errors
Java Entity	Description
DetailsException	Exception that may be thrown when erroneous-input is provided to internal-class Details or ReflHTML
HiLiteException	Exception that may be thrown by the HiLiter interface
SummaryTableException	Thrown when an error has occured involving a JavaDoc Summary-Table
UpgradeException	Exception that may be thrown when building an Upgrade class instance
ParseException	Parent class for both SourceCodeParseException and JavaDocHTMLParseException
JavaDocHTMLParseException	Exception when parsing a Java Doc Generated HTML Web-Page File
SourceCodeParseException	Exception parsing a Java Source Code File
HiLiteError	General Purpose Code-Hiliting Error
JavaDocError	General Purpose Program Flow Error