Package Torello.JavaDoc

Class EXPORT_PORTAL

java.lang.Object

Torello.JavaDoc.EXPORT_PORTAL

public class EXPORT_PORTAL
extends java.lang.Object

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").

The only two options were to make all of the listed methods, fields and constructors (the ones which are exported by this "portal" - for lack of any other name) the only two options were to have made all of these methods, fields and constructors public or to create this portal class!!

The reason keeping these things package-private is that once this big Java-Doc Upgrader class is truly finished, "The API" that users see should make sense, and they shouldn't be bothered with internal HTML-Processors and other coding/logic decisions that they aren't supposed to use.

The stuff "exported" below, are just method-calls and field-references that are used by the sub-packages 'Torello.JavaDoc.HTMLProcessors' and 'Torello.javaDoc.UserConfigReaders' among others. The end user doesn't need to know a thing about any of these.

Hi-Lited Source-Code:

• View Here: Torello/JavaDoc/EXPORT_PORTAL.java
• Open New Browser-Tab: Torello/JavaDoc/EXPORT_PORTAL.java

File Size: 14,535 Bytes Line Count: 317 '\n' Characters Found

Constructor Summary

Constructors

Constructor
EXPORT_PORTAL()

Method Summary

Modifier and Type	Method
static AnnotationElem	AnnotationElem$Constructor(AnnotationMemberDeclaration amd, String javaSrcFileAsStr)
static AnnotationElem	AnnotationElem$Constructor(AnnotationElem ae, String aeType)
static Constructor	Constructor$Constructor(ConstructorDeclaration cd, String javaSrcFileAsStr, boolean isSignatureOnly)
static Constructor	Constructor$Constructor(Constructor c1, Constructor c2)
static String	Declaration$codeHiLiteString(Declaration d)
static EnumConstant	EnumConstant$Constructor(EnumConstantDeclaration ecd, String javaSrcFileAsStr)
static Field	Field$Constructor(FieldDeclaration fd, String fieldName)
static Field	Field$Constructor(VariableDeclarator vd, NodeList<expr.AnnotationExpr> annotations, NodeList<Modifier> modifiers, Optional<com.github.javaparser.Range> signatureRange, Optional<comments.JavadocComment> javaDocComment, String javaSrcFileAsStr)
static Field	Field$Constructor(Field f1, Field f2)
static Hashtable<String,Integer>	JavaDocHTMLFile$checkValidity(JavaDocHTMLFile jdhf)
static void	JavaDocHTMLFile$commitChanges(JavaDocHTMLFile jdhf)
static void	JavaDocHTMLFile$commitFileToDisk(JavaDocHTMLFile jdhf)
static JavaDocHTMLFile	JavaDocHTMLFile$Constructor(Upgrade u, Vector<HTMLNode> fileVec, String jdHTMLFileName, Torello.JavaDoc.SourceParse.JavaSourceCodeFile jscf, String dotDots, Ret6<String,String,CIET,String[],String,String> htmlFileHeaderFacts)
static Ret6<String, String, CIET, String[], String, String>	JavaDocHTMLFile$extractHeaderData(Vector<HTMLNode> fileVec)
static Method	Method$Constructor(MethodDeclaration md, String javaSrcFileAsStr, boolean isSignatureOnly)
static Method	Method$Constructor(Method m1, Method m2)
static NestedType	NestedType$Constructor(TypeDeclaration<?> td, CIET ciet, String javaSrcFileAsStr)
static Torello.JavaDoc.Annotations.AnnotationsMirror	ParsedFile$annotationsMirror(ParsedFile pf)
static Constructor	ParsedFile$findConstructor(ParsedFile pf, Constructor c)
static Method	ParsedFile$findMethod(ParsedFile pf, Method m)
static void	Stats$addStatsButton(Vector<HTMLNode> page, String dotDots, String packageName)
static boolean	Stats$addStatsButton(Vector<HTMLNode> navBarTop, Vector<HTMLNode> navBarBottom, String dotDots, String packageName)
static void	Stats$incrementTag(Stats stats, String packageName, String embedTag, boolean globalTagOrPackageTag)
static void	Stats$registerPackage(Stats stats, String packageName, Map<String,String> packageTagsMap, Stats topLevelStatsInstance)
static void	Stats$run(Stats stats, Torello.JavaDoc.SourceParse.JavaSourceCodeFile jscf, JavaDocHTMLFile jdhf, int numHLM, int numHLC, int numHLF, int numHLAE, int numHLEC, int numHLD)
static TagNodeIndex	SummaryTableHTML$cinzelH3(SummaryTableHTML<?> stHTML)
static Vector<HTMLNode>	SummaryTableHTML$headerRow(SummaryTableHTML<?> stHTML)
static <ENTITY extends Declaration> void	SummaryTableHTML$setTableRows(SummaryTableHTML<ENTITY> stHTML, Vector<Vector<HTMLNode>> tableRows, Vector<ENTITY> rowEntities)
static boolean	Upgrade$checkBalance(Upgrade u)
static Iterator<String>	Upgrade$CINZEL_FONT_FILES()
static TreeSet<String>	Upgrade$getPackageTypesList(Upgrade u, String packageName)
static HiLiter	Upgrade$hiLiter(Upgrade u)
static String	Upgrade$jdCSS(Upgrade u)
static Torello.JavaDoc.HTMLProcessors.LinksChecker	Upgrade$linksChecker(Upgrade u)
static boolean	Upgrade$logFileNotNull(Upgrade u)
static Consumer<Vector<HTMLNode>>	Upgrade$packageSummaryCleaner(Upgrade u)
static void	Upgrade$putMasterSrcHTMLList(Upgrade u, List<String> srcHTMLFiles)
static void	Upgrade$putMasterTypesList(Upgrade u, String packageName, TreeSet<String> packageTypesList)
static boolean	Upgrade$VERBOSE_PRINT_STEPS(Upgrade u)
static Iterator<String>	Upgrade$WOOD_PLANK_IMAGE_FILES()
static void	UpgradeIfLinksCheckerRegisterPage(Upgrade u, JavaDocHTMLFile jdhf)

Methods inherited from class java.lang.Object

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

Constructor Detail

EXPORT_PORTAL

🡇 ⇈

public EXPORT_PORTAL()

Method Detail

Upgrade$linksChecker

🡅 🡇 ⇈ ⮫

public static Torello.JavaDoc.HTMLProcessors.LinksChecker Upgrade$linksChecker
            (Upgrade u)

Code:

Exact Method Body:

 return u.linksChecker;

Upgrade$checkBalance

🡅 🡇 ⇈ ⮫

public static boolean Upgrade$checkBalance(Upgrade u)

Code:

Exact Method Body:

 return u.checkBalance;

Upgrade$logFileNotNull

🡅 🡇 ⇈ ⮫

public static boolean Upgrade$logFileNotNull(Upgrade u)

Code:

Exact Method Body:

 return u.logFile != null;

Upgrade$jdCSS

🡅 🡇 ⇈ ⮫

public static java.lang.String Upgrade$jdCSS(Upgrade u)

Code:

Exact Method Body:

 return u.jdCSS;

Upgrade$VERBOSE_PRINT_STEPS

🡅 🡇 ⇈ ⮫

public static boolean Upgrade$VERBOSE_PRINT_STEPS(Upgrade u)

Code:

Exact Method Body:

 return u.VERBOSE_PRINT_STEPS;

Upgrade$hiLiter

🡅 🡇 ⇈ ⮫

public static HiLiter Upgrade$hiLiter(Upgrade u)

Code:

Exact Method Body:

 return u.hiLiter;

Upgrade$packageSummaryCleaner

🡅 🡇 ⇈ ⮫

public static java.util.function.Consumer<java.util.Vector<HTMLNode>> Upgrade$packageSummaryCleaner
            (Upgrade u)

Code:

Exact Method Body:

 return u.packageSummaryCleaner;

Upgrade$putMasterSrcHTMLList

🡅 🡇 ⇈ ⮫

public static void Upgrade$putMasterSrcHTMLList
            (Upgrade u,
             java.util.List<java.lang.String> srcHTMLFiles)

Code:

Exact Method Body:

 u.putMasterSrcHTMLList(srcHTMLFiles);

Upgrade$getPackageTypesList

🡅 🡇 ⇈ ⮫

public static java.util.TreeSet<java.lang.String> Upgrade$getPackageTypesList
            (Upgrade u,
             java.lang.String packageName)

Code:

Exact Method Body:

 return u.getPackageTypesList(packageName);

Upgrade$putMasterTypesList

🡅 🡇 ⇈ ⮫

public static void Upgrade$putMasterTypesList
            (Upgrade u,
             java.lang.String packageName,
             java.util.TreeSet<java.lang.String> packageTypesList)

Code:

Exact Method Body:

 u.putMasterTypesList(packageName, packageTypesList);

Upgrade$CINZEL_FONT_FILES

🡅 🡇 ⇈ ⮫

public static java.util.Iterator<java.lang.String> Upgrade$CINZEL_FONT_FILES
            ()

Code:

Exact Method Body:

 return Arrays.asList(Upgrade.CINZEL_FONT_FILES).iterator();

Upgrade$WOOD_PLANK_IMAGE_FILES

🡅 🡇 ⇈ ⮫

public static java.util.Iterator<java.lang.String> Upgrade$WOOD_PLANK_IMAGE_FILES
            ()

Code:

Exact Method Body:

 return Arrays.asList(Upgrade.WOOD_PLANK_IMAGE_FILES).iterator();

Stats$registerPackage

🡅 🡇 ⇈ ⮫

public static void Stats$registerPackage
            (Stats stats,
             java.lang.String packageName,
             java.util.Map<java.lang.String,java.lang.String> packageTagsMap,
             Stats topLevelStatsInstance)

Code:

Exact Method Body:

 stats.registerPackage(packageName, packageTagsMap, topLevelStatsInstance);

Stats$incrementTag

🡅 🡇 ⇈ ⮫

public static void Stats$incrementTag(Stats stats,
                                      java.lang.String packageName,
                                      java.lang.String embedTag,
                                      boolean globalTagOrPackageTag)

Code:

Exact Method Body:

 stats.incrementTag(packageName, embedTag, globalTagOrPackageTag);

Stats$run

🡅 🡇 ⇈ ⮫

public static void Stats$run
            (Stats stats,
             Torello.JavaDoc.SourceParse.JavaSourceCodeFile jscf,
             JavaDocHTMLFile jdhf,
             int numHLM,
             int numHLC,
             int numHLF,
             int numHLAE,
             int numHLEC,
             int numHLD)

Code:

Exact Method Body:

 stats.run(jscf, jdhf, numHLM, numHLC, numHLF, numHLAE, numHLEC, numHLD);

Stats$addStatsButton

🡅 🡇 ⇈ ⮫

public static boolean Stats$addStatsButton
            (java.util.Vector<HTMLNode> navBarTop,
             java.util.Vector<HTMLNode> navBarBottom,
             java.lang.String dotDots,
             java.lang.String packageName)

Code:

Exact Method Body:

 return Stats.addStatsButton(navBarTop, navBarBottom, dotDots, packageName);

Stats$addStatsButton

🡅 🡇 ⇈ ⮫

public static void Stats$addStatsButton(java.util.Vector<HTMLNode> page,
                                        java.lang.String dotDots,
                                        java.lang.String packageName)

Code:

Exact Method Body:

 Stats.addStatsButton(page, dotDots, packageName);

ParsedFile$annotationsMirror

🡅 🡇 ⇈ ⮫

public static Torello.JavaDoc.Annotations.AnnotationsMirror ParsedFile$annotationsMirror
            (ParsedFile pf)

Code:

Exact Method Body:

 return pf.annotationsMirror;

ParsedFile$findMethod

🡅 🡇 ⇈ ⮫

public static Method ParsedFile$findMethod(ParsedFile pf,
                                           Method m)

Code:

Exact Method Body:

 return pf.findMethod(m);

ParsedFile$findConstructor

🡅 🡇 ⇈ ⮫

public static Constructor ParsedFile$findConstructor(ParsedFile pf,
                                                     Constructor c)

Code:

Exact Method Body:

 return pf.findConstructor(c);

Declaration$codeHiLiteString

🡅 🡇 ⇈ ⮫

public static java.lang.String Declaration$codeHiLiteString(Declaration d)

Code:

Exact Method Body:

 return d.codeHiLiteString();

Method$Constructor

🡅 🡇 ⇈ ⮫

public static Method Method$Constructor(Method m1,
                                        Method m2)

Code:

Exact Method Body:

 return new Method(m1, m2);

Constructor$Constructor

🡅 🡇 ⇈ ⮫

public static Constructor Constructor$Constructor(Constructor c1,
                                                  Constructor c2)

Code:

Exact Method Body:

 return new Constructor(c1, c2);

Field$Constructor

🡅 🡇 ⇈ ⮫

public static Field Field$Constructor
            (com.github.javaparser.ast.body.FieldDeclaration fd,
             java.lang.String fieldName)

Code:

Exact Method Body:

 return new Field(fd, fieldName);

Field$Constructor

🡅 🡇 ⇈ ⮫

public static Field Field$Constructor(Field f1,
                                      Field f2)

Code:

Exact Method Body:

 return new Field(f1, f2);

AnnotationElem$Constructor

🡅 🡇 ⇈ ⮫

public static AnnotationElem AnnotationElem$Constructor
            (AnnotationElem ae,
             java.lang.String aeType)

Code:

Exact Method Body:

 return new AnnotationElem(ae, aeType);

Method$Constructor

🡅 🡇 ⇈ ⮫

public static Method Method$Constructor
            (com.github.javaparser.ast.body.MethodDeclaration md,
             java.lang.String javaSrcFileAsStr,
             boolean isSignatureOnly)

Code:

Exact Method Body:

 return new Method(md, javaSrcFileAsStr, isSignatureOnly);

Constructor$Constructor

🡅 🡇 ⇈ ⮫

public static Constructor Constructor$Constructor
            (com.github.javaparser.ast.body.ConstructorDeclaration cd,
             java.lang.String javaSrcFileAsStr,
             boolean isSignatureOnly)

Code:

Exact Method Body:

 return new Constructor(cd, javaSrcFileAsStr, isSignatureOnly);

Field$Constructor

🡅 🡇 ⇈ ⮫

public static Field Field$Constructor
            (com.github.javaparser.ast.body.VariableDeclarator vd,
             com.github.javaparser.ast.NodeList<com.github.javaparser.ast.expr.AnnotationExpr> annotations,
             com.github.javaparser.ast.NodeList<com.github.javaparser.ast.Modifier> modifiers,
             java.util.Optional<com.github.javaparser.Range> signatureRange,
             java.util.Optional<com.github.javaparser.ast.comments.JavadocComment> javaDocComment,
             java.lang.String javaSrcFileAsStr)

Code:

Exact Method Body:

 return new Field
     (vd, annotations, modifiers,  signatureRange, javaDocComment, javaSrcFileAsStr);

EnumConstant$Constructor

🡅 🡇 ⇈ ⮫

public static EnumConstant EnumConstant$Constructor
            (com.github.javaparser.ast.body.EnumConstantDeclaration ecd,
             java.lang.String javaSrcFileAsStr)

Code:

Exact Method Body:

 return new EnumConstant(ecd, javaSrcFileAsStr);

AnnotationElem$Constructor

🡅 🡇 ⇈ ⮫

public static AnnotationElem AnnotationElem$Constructor
            (com.github.javaparser.ast.body.AnnotationMemberDeclaration amd,
             java.lang.String javaSrcFileAsStr)

Code:

Exact Method Body:

 return new AnnotationElem(amd, javaSrcFileAsStr);

NestedType$Constructor

🡅 🡇 ⇈ ⮫

public static NestedType NestedType$Constructor
            (com.github.javaparser.ast.body.TypeDeclaration<?> td,
             CIET ciet,
             java.lang.String javaSrcFileAsStr)

Code:

Exact Method Body:

 return new NestedType(td, ciet, javaSrcFileAsStr);

JavaDocHTMLFile$commitChanges

🡅 🡇 ⇈ ⮫

public static void JavaDocHTMLFile$commitChanges(JavaDocHTMLFile jdhf)

Code:

Exact Method Body:

 jdhf.commitChanges();

JavaDocHTMLFile$checkValidity

🡅 🡇 ⇈ ⮫

public static java.util.Hashtable<java.lang.String,java.lang.Integer> JavaDocHTMLFile$checkValidity
            (JavaDocHTMLFile jdhf)

Code:

Exact Method Body:

 return jdhf.checkValidity();

UpgradeIfLinksCheckerRegisterPage

🡅 🡇 ⇈ ⮫

public static void UpgradeIfLinksCheckerRegisterPage(Upgrade u,
                                                     JavaDocHTMLFile jdhf)

Code:

Exact Method Body:

 if (u.linksChecker != null) u.linksChecker.registerPage(jdhf);

JavaDocHTMLFile$commitFileToDisk

🡅 🡇 ⇈ ⮫

public static void JavaDocHTMLFile$commitFileToDisk(JavaDocHTMLFile jdhf)
                                             throws java.io.IOException

Throws:

java.io.IOException

Code:

Exact Method Body:

 jdhf.commitFileToDisk();

JavaDocHTMLFile$extractHeaderData

🡅 🡇 ⇈ ⮫

public static final Ret6<java.lang.String,java.lang.String,CIET,java.lang.String[],java.lang.String,java.lang.String> JavaDocHTMLFile$extractHeaderData
            (java.util.Vector<HTMLNode> fileVec)

Code:

Exact Method Body:

 return JavaDocHTMLFile.extractHeaderData(fileVec);

JavaDocHTMLFile$Constructor

🡅 🡇 ⇈ ⮫

public static final JavaDocHTMLFile JavaDocHTMLFile$Constructor
            (Upgrade u,
             java.util.Vector<HTMLNode> fileVec,
             java.lang.String jdHTMLFileName,
             Torello.JavaDoc.SourceParse.JavaSourceCodeFile jscf,
             java.lang.String dotDots,
             Ret6<java.lang.String,java.lang.String,CIET,java.lang.String[],java.lang.String,java.lang.String> htmlFileHeaderFacts)

Code:

Exact Method Body:

 return new JavaDocHTMLFile(u, fileVec, jdHTMLFileName, jscf, dotDots, htmlFileHeaderFacts);

SummaryTableHTML$setTableRows

🡅 🡇 ⇈ ⮫

public static <ENTITY extends Declaration> void SummaryTableHTML$setTableRows
            (SummaryTableHTML<ENTITY> stHTML,
             java.util.Vector<java.util.Vector<HTMLNode>> tableRows,
             java.util.Vector<ENTITY> rowEntities)

Code:

Exact Method Body:

 stHTML.setTableRows(tableRows, rowEntities);

SummaryTableHTML$headerRow

🡅 🡇 ⇈ ⮫

public static java.util.Vector<HTMLNode> SummaryTableHTML$headerRow
            (SummaryTableHTML<?> stHTML)

Code:

Exact Method Body:

 return stHTML.headerRow;

SummaryTableHTML$cinzelH3

🡅 ⇈ ⮫

public static TagNodeIndex SummaryTableHTML$cinzelH3
            (SummaryTableHTML<?> stHTML)

Code:

Exact Method Body:

 return stHTML.cinzelH3;