Package Torello.JavaDoc

This package utilizes the value of both an HTML-Parser and an AST Source-Code Parser for helping a user to transform, modify, add-to, and delete HTML (automatically) to & from JavaDoc-Generated Web-Pages.

The advanced features of the classes in Torello.HTML combined with the meticulously constructred Reflection-Classes of Torello.JavaDoc allow a programmer to perform just about any transformation on the Web-Pages generated by Java-Doc.

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-HTML Classes
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
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
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
PackageSummaryHTML	A class that parses and encapsulates the contents of a 'package-summary
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
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
Reflection Classes
Java Entity	Description
AnnotationElem	Reflection Class: Holds all information extracted from '.java' Annotation (@interface) Source-Files about all Elements identified in that file
Constructor	Reflection Class: Holds all information extracted from '.java' Source-Files about Constructor's identified in that file
EnumConstant	Reflection Class: Holds all information extracted from '.java' enum Source-Files about Enumerated-Constants's identified in that 'enum' file
Field	Reflection Class: Holds all information extracted from '.java' Source-Files about Field's identified in that file
Method	Reflection Class: Holds all information extracted from '.java' Source-Files about Method's identified in that file
NestedType	Reflection Class: Holds all information extracted from '.java' Source-Files regarding Nested-Types (Inner-Classes)
Callable	Reflection Class: Common-Root Ancestor Class of both Method and Constructor
Declaration	Reflection Class: Common-Root Ancestor Class of all Bridge Data-Classes
Cascading Style Sheets
Java Entity	Description
CSSFiles	A class for encapsulating all four JavaDoc Upgrader '
CSSTags	Complete List of CSS CLASS and ID Attributes that are inserted by the HTML Processor Classes CSSTagsTopAndSumm and CSSTagsDetails
Annotations
Java Entity	Description
CSSLinks	This Annotation allows a user to request that a CSS Link-Import be included in the Header Portion of any CIET/Type's respective Java-Doc Web-Page
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
LinkJavaSource
StaticFunctional	Java-Annotation: A Java-Annotation for marking classes as 'Stateless Classes' - used to insert 'The Spaghetti Report' into Java Doc Pages
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
Utility Classes
Java Entity	Description
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
Location	Location Information storing line-number, column-number and character-number for items inside of a Java Source-Code File (a '
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
RelativePathStr	Keeps a copy of the String as a series of '
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 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" to sub-directories & sub-packages
Exceptions
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