```
public interface UserProcessorPage
```
An interface that may be implemented by a user to execute detailed customizations and modifications to a specific Java-Doc Web Page. This interface should be implemented by a class that has the same name as the class being processed, but ending with a '$'.

After writing a Java Class which implements this interface, simply copy it to the directory in your file-system that contains the Java CIET/Type - in a sub-directory that has the following name:

upgrade-files/user-processors/MyClassName$.java

Notice that the name of the this particular class ends with a '$'. The first part of the class' name is being utilized to identify to the Java-Doc Upgrader logic the name of the actual class/CIET/Type that your processor-class is going to process.

If you had a class named 'BigNumberCruncher.java' that was a Java 'class', and you wanted to write an HTML-Processor to insert several notices into the JavaDoc Page for the BigNumberCruncher type - you would write a user-processor named 'BigNumberCruncher$.java'. You would make sure to leave the processor in the following Java Source-Code Directory:

../com/MyCompany/MyPackage/upgrade-files/user-processors/BigNumberCruncher$.class

The class that you write would implement this interface 'UserProcessorPage'. During the JavaDoc Upgrader phase of your build, the upgrader logic would invoke your user-processor and pass it the relevant HTML Data from the Java-Doc HTML Web-Page that had been created by the Java-Doc Tool to your processor.
Hi-Lited Source-Code:
- View Here: Torello/JavaDoc/UserProcessorPage.java
- Open New Browser-Tab: Torello/JavaDoc/UserProcessorPage.java
File Size: 9,561 Bytes Line Count: 193 '\n' Characters Found

Method Summary

Dispatch-Accessor Methods

Modifier and Type	Method
`default void`	`process(JavaDocHTMLFile jdhf)`
`default void`	`processHeaderFooter(HeaderFooterHTML headerFooter)`

Summary Table HTML Dispatch-Accessor Methods
Modifier and Type	Method
`default void`	`processAESumm(SummaryTableHTML<AnnotationElem> oaeSummaries, SummaryTableHTML<AnnotationElem> raeSummaries)`
`default void`	`processCtorSumm(SummaryTableHTML<Constructor> constructorSummaries)`
`default void`	`processECSumm(SummaryTableHTML<EnumConstant> ecSummaries)`
`default void`	`processFieldSumm(SummaryTableHTML<Field> fieldSummaries)`
`default void`	`processMethodSumm(SummaryTableHTML<Method> methodSummaries)`

Detail HTML Dispatch-Accessor Methods
Modifier and Type	Method
`default void`	`processAEDetails(Stream<ReflHTML<AnnotationElem>> aeDetails)`
`default void`	`processCtorDetails(Stream<ReflHTML<Constructor>> constructorDetails)`
`default void`	`processECDetails(Stream<ReflHTML<EnumConstant>> ecDetails)`
`default void`	`processFieldDetails(Stream<ReflHTML<Field>> fieldDetails)`
`default void`	`processMethodDetails(Stream<ReflHTML<Method>> methodDetails)`

- Method Detail
  - process
    
    🡇 ⇈ ⮫
```
default void process(JavaDocHTMLFile jdhf)
```
    Process a complete Java-Doc Generated Web-Page
    Parameters:
    
    jdhf - An instance of the fully parsed HTML Page.
    
    Code:
    
    Exact Method Body:
  - processHeaderFooter
    
    🡅 🡇 ⇈ ⮫
```
default void processHeaderFooter(HeaderFooterHTML headerFooter)
```
    Interface' hook method for performing HTML-Processing on the Header & Footer parts of a JavaDoc Generated Web-Page.
    Parameters:
    
    headerFooter - The Header-Footer HTML
    
    NOTE: An instance of this object may also be obtained by referencing the field JavaDocHTMLFile.headerFooter.
    
    See Also:
    
    JavaDocHTMLFile.headerFooter
    
    Code:
    
    Exact Method Body:
  - processFieldSumm
    
    🡅 🡇 ⇈ ⮫
```
default void processFieldSumm(SummaryTableHTML<Field> fieldSummaries)
```
    Interface' hook method for performing HTML-Processing on the Field Summary Table of a JavaDoc Generated Web-Page.
    Parameters:
    
    fieldSummaries - The Field Summary Table HTML
    
    NOTE: An instance of this object may also be obtained by referencing the field JavaDocHTMLFile.fieldSummaryTable.
    
    See Also:
    
    JavaDocHTMLFile.fieldSummaryTable
    
    Code:
    
    Exact Method Body:
  - processCtorSumm
    
    🡅 🡇 ⇈ ⮫
```
default void processCtorSumm
            (SummaryTableHTML<Constructor> constructorSummaries)
```
    Interface' hook method for performing HTML-Processing on the Constructor Summary Table of a JavaDoc Generated Web-Page.
    Parameters:
    
    constructorSummaries - The Constructor Summary Table HTML
    
    NOTE: An instance of this object may also be obtained by referencing the field JavaDocHTMLFile.constructorSummaryTable.
    
    See Also:
    
    JavaDocHTMLFile.constructorSummaryTable
    
    Code:
    
    Exact Method Body:
  - processMethodSumm
    
    🡅 🡇 ⇈ ⮫
```
default void processMethodSumm(SummaryTableHTML<Method> methodSummaries)
```
    Interface' hook method for performing HTML-Processing on the Method Summary Table of a JavaDoc Generated Web-Page.
    Parameters:
    
    methodSummaries - The Method Summary Table HTML
    
    NOTE: An instance of this object may also be obtained by referencing the field JavaDocHTMLFile.methodSummaryTable.
    
    See Also:
    
    JavaDocHTMLFile.methodSummaryTable
    
    Code:
    
    Exact Method Body:
  - processECSumm
    
    🡅 🡇 ⇈ ⮫
```
default void processECSumm(SummaryTableHTML<EnumConstant> ecSummaries)
```
    Interface' hook method for performing HTML-Processing on the Enum-Constant Summary Table of a JavaDoc Generated Web-Page.
    
    NOTE: The vast majority of Java Type's (CIET's) will not have any "Enum Constants" - and would therefore not have an Enum-Constant Summary Table! Only Java enum's may have such constants defined.
    Parameters:
    
    ecSummaries - The Enum-Constant Summary Table HTML
    
    NOTE: An instance of this object may also be obtained by referencing the field JavaDocHTMLFile.ecSummaryTable.
    
    See Also:
    
    JavaDocHTMLFile.ecSummaryTable
    
    Code:
    
    Exact Method Body:
  - processAESumm
    
    🡅 🡇 ⇈ ⮫
```
default void processAESumm(SummaryTableHTML<AnnotationElem> oaeSummaries,
                           SummaryTableHTML<AnnotationElem> raeSummaries)
```
    Interface' hook method for performing HTML-Processing on the Annotation-Element Summary Table of a JavaDoc Generated Web-Page.
    
    NOTE: The vast majority of Java Type's (CIET's) will not have any "Annotation Elements" - and would therefore not have an Annotation Element Summary Table! Only Java @annotations may have such elements defined.
    Parameters:
    
    oaeSummaries - The Annotation-Element Summary Table HTML
    
    NOTE: An instance of this object may also be obtained by referencing the field JavaDocHTMLFile.oaeSummaryTable.
    
    raeSummaries - The Annotation-Element Summary Table HTML
    
    NOTE: An instance of this object may also be obtained by referencing the field JavaDocHTMLFile.raeSummaryTable.
    
    See Also:
    
    JavaDocHTMLFile.oaeSummaryTable, JavaDocHTMLFile.raeSummaryTable
    
    Code:
    
    Exact Method Body:
  - processFieldDetails
    
    🡅 🡇 ⇈ ⮫
```
default void processFieldDetails
            (java.util.stream.Stream<ReflHTML<Field>> fieldDetails)
```
    Interface' hook method for performing HTML-Processing on a Field "detail HTML block" (the explanation portion) of a JavaDoc Generated Web-Page.
    Parameters:
    
    fieldDetails - A Java Stream of ReflHTML objects that each contain all details (as HTML) about a single Java Field.
    
    NOTE: An instance of this Stream may also be obtained by calling the method JavaDocHTMLFile.allFieldDetails()
    
    See Also:
    
    JavaDocHTMLFile.fieldDetailsIterator(), JavaDocHTMLFile.findFieldHTML(Predicate)
    
    Code:
    
    Exact Method Body:
  - processCtorDetails
    
    🡅 🡇 ⇈ ⮫
```
default void processCtorDetails
            (java.util.stream.Stream<ReflHTML<Constructor>> constructorDetails)
```
    Interface' hook method for performing HTML-Processing on a Constructor "detail HTML block" (the explanation portion) of a JavaDoc Generated Web-Page.
    Parameters:
    
    constructorDetails - A Java Stream of ReflHTML objects that each contain all details (as HTML) about a single Java Constructor.
    
    NOTE: An instance of this Stream may also be obtained by calling the method JavaDocHTMLFile.allConstructorDetails()
    
    See Also:
    
    JavaDocHTMLFile.constructorDetailsIterator(), JavaDocHTMLFile.findConstructorHTML(Predicate)
    
    Code:
    
    Exact Method Body:
  - processMethodDetails
    
    🡅 🡇 ⇈ ⮫
```
default void processMethodDetails
            (java.util.stream.Stream<ReflHTML<Method>> methodDetails)
```
    Interface' hook method for performing HTML-Processing on a Method "detail HTML block" (the explanation portion) of a JavaDoc Generated Web-Page.
    Parameters:
    
    methodDetails - A Java Stream of ReflHTML objects that each contain all details (as HTML) about a single Java Method.
    
    NOTE: An instance of this Stream may also be obtained by calling the method JavaDocHTMLFile.allMethodDetails()
    
    See Also:
    
    JavaDocHTMLFile.methodDetailsIterator(), JavaDocHTMLFile.findMethodHTML(Predicate)
    
    Code:
    
    Exact Method Body:
  - processECDetails
    
    🡅 🡇 ⇈ ⮫
```
default void processECDetails
            (java.util.stream.Stream<ReflHTML<EnumConstant>> ecDetails)
```
    Interface' hook method for performing HTML-Processing on a Enum-Constant "detail HTML block" (the explanation portion) of a JavaDoc Generated Web-Page.
    
    NOTE: The vast majority of Java Type's (CIET's) will not have any "Enum Constants" - and would therefore not have an Annotation Element Detail HTML Block! Only Java enum may have such constants defined.
    Parameters:
    
    ecDetails - A Java Stream of ReflHTML objects that each contain all details (as HTML) about a single Java Enum-Constant.
    
    NOTE: An instance of this Stream may also be obtained by calling the method JavaDocHTMLFile.allECDetails()
    
    See Also:
    
    JavaDocHTMLFile.ecDetailsIterator(), JavaDocHTMLFile.findECHTML(Predicate)
    
    Code:
    
    Exact Method Body:
  - processAEDetails
    
    🡅 ⇈ ⮫
```
default void processAEDetails
            (java.util.stream.Stream<ReflHTML<AnnotationElem>> aeDetails)
```
    Interface' hook method for performing HTML-Processing on a Annotation-Element "detail HTML block" (the explanation portion) of a JavaDoc Generated Web-Page.
    
    NOTE: The vast majority of Java Type's (CIET's) will not have any "Annotation Elements" - and would therefore not have an Annotation Element Detail HTML Block! Only Java @annotations may have such elements defined.
    Parameters:
    
    aeDetails - A Java Stream of ReflHTML objects that each contain all details (as HTML) about a single Java Annotation-Element.
    
    NOTE: An instance of this Stream may also be obtained by calling the method JavaDocHTMLFile.allAEDetails()
    
    See Also:
    
    JavaDocHTMLFile.aeDetailsIterator(), JavaDocHTMLFile.findAEHTML(Predicate)
    
    Code:
    
    Exact Method Body:

Methods
void	process(JavaDocHTMLFile jdhf)
void	processAEDetails(Stream aeDetails)
void	processAESumm(SummaryTableHTML oaeSummaries, SummaryTableHTML raeSummaries)
void	processCtorDetails(Stream constructorDetails)
void	processCtorSumm(SummaryTableHTML constructorSummaries)
void	processECDetails(Stream ecDetails)
void	processECSumm(SummaryTableHTML ecSummaries)
void	processFieldDetails(Stream fieldDetails)
void	processFieldSumm(SummaryTableHTML fieldSummaries)
void	processHeaderFooter(HeaderFooterHTML headerFooter)
void	processMethodDetails(Stream methodDetails)
void	processMethodSumm(SummaryTableHTML methodSummaries)

Interface UserProcessorPage

Method Summary

Method Detail

process

processHeaderFooter

processFieldSumm

processCtorSumm

processMethodSumm

processECSumm

processAESumm

processFieldDetails

processCtorDetails

processMethodDetails

processECDetails

processAEDetails