001package Torello.JavaDoc;
002
003import java.util.*;
004import java.util.function.*;
005
006import Torello.Java.ReadOnly.ReadOnlyMap;
007import Torello.Java.ReadOnly.ReadOnlyList;
008
009import Torello.HTML.HTMLNode;
010import Torello.HTML.TagNodeIndex;
011import Torello.HTML.DotPair;
012
013import Torello.Java.Additional.Ret6;
014
015import Torello.Java.Build.BuildPackage;
016
017import Torello.JDUInternal.SimpleFeatures.LinksChecker;
018
019import Torello.JDUInternal.Parse.Java.JSCF.JavaSourceCodeFile;
020import Torello.JDUInternal.Parse.HTML.TheREFL.D1_PrimaryRefl;
021
022import com.sun.source.tree.MethodTree;
023import com.sun.source.tree.VariableTree;
024import com.sun.source.tree.ClassTree;
025
026/**
027 * IMPORTANT NOTE: Have a "rocket science" moment, and accept that all this is doing is
028 * facilitating the "preservation" of the PACKAGE-PRIVATE levels of privacy on these methods,
029 * fields and constructors after "The Big Move"
030 * 
031 * <BR /><BR />
032 * Note that "The Big Move" was putting all of the classes that were deemed "HTML Processors" to
033 * sub-directories &amp; sub-packages.  Primary User-API classes (such as "JavaDocHTMLFile" and
034 * others like "ReflHTML") are still in the main-directory / main-package.
035 * 
036 * <BR /><BR />
037 * The only two options were to make all of these methods, fields and constructors public or to
038 * create this portal class!!
039 * 
040 * <BR /><BR />
041 * The reason keeping these methods, fields &amp; constructors package-private is that once this
042 * the Upgrader is truly finished, "The API" that users see should make sense, and they shouldn't
043 * be bothered with internal coding/logic decisions that they aren't supposed to use. 
044 * 
045 * <BR /><BR />
046 * The stuff "exported" below are used by the sub-packages, which are not exported to the API at
047 * all.  The end user doesn't need to know a thing about any of these.  <B>YES</B> it would be easy
048 * to cheat using these, but there is no point.  The "readability" of the classes that are listed
049 * above is still preserved.  Knock yourself out, there would be no point...
050 * 
051 * <BR /><BR />
052 * All "Details Sections" in this class have been removed.
053 */
054@StaticFunctional
055public class EXPORT_PORTAL
056{
057    private EXPORT_PORTAL() { }
058
059
060    // ********************************************************************************************
061    // ********************************************************************************************
062    // Declaration
063    // ********************************************************************************************
064    // ********************************************************************************************
065
066
067    // INVOKED:  HiLiteDetails
068    public static String Declaration$codeHiLiteString(final Declaration d)
069    { return d.codeHiLiteString(); }
070
071
072    // ********************************************************************************************
073    // ********************************************************************************************
074    // JavaDocHTMLFile
075    // ********************************************************************************************
076    // ********************************************************************************************
077
078
079    // INVOKED:  MainFilesProcessor.PART_TWO_Do_The_Rest
080    public static void JavaDocHTMLFile$commitChanges(final JavaDocHTMLFile jdhf)
081    { jdhf.commitChanges(); }
082
083    // INVOKED: MainFilesProcessor.PART_TWO_Do_The_Rest
084    public static Hashtable<String, Integer> JavaDocHTMLFile$checkValidity
085        (final JavaDocHTMLFile jdhf)
086    { return jdhf.checkValidity(); }
087
088    // INVOKED: MainFilesProcessor.PART_TWO_Do_The_Rest
089    public static void JavaDocHTMLFile$commitFileToDisk(final JavaDocHTMLFile jdhf)
090        throws java.io.IOException
091    { jdhf.commitFileToDisk();  }
092
093
094    // ********************************************************************************************
095    // ********************************************************************************************
096    // SummaryTableHTML
097    // ********************************************************************************************
098    // ********************************************************************************************
099
100
101    // INVOKED: RearrangeEntitySummaries
102    public static <ENTITY extends Declaration> void SummaryTableHTML$setTableRows(
103        final SummaryTableHTML<ENTITY>      stHTML,
104            final Vector<Vector<HTMLNode>>  tableRows,
105            final Vector<ENTITY>            rowEntities
106        )
107    { stHTML.setTableRows(tableRows, rowEntities); }
108
109    // INVOKED: CleanSummaries, RearrangeEntitySummaries
110    public static Vector<HTMLNode> SummaryTableHTML$headerRow(final SummaryTableHTML<?> stHTML)
111    { return stHTML.headerRow; }
112
113    // INVOKED: CSSTagsTopAndSumm
114    public static TagNodeIndex SummaryTableHTML$openingCinzelH3 (final SummaryTableHTML<?> stHTML)
115    { return stHTML.openingCinzelH3; }
116
117
118    // ********************************************************************************************
119    // ********************************************************************************************
120    // PackageSummaryHTML
121    // ********************************************************************************************
122    // ********************************************************************************************
123
124
125    // INVOKED: Uranus
126    // public static Torello.JDUInternal.Features.SORT_TYPES_FRAMES_SUMMARIES.D1_PkgSort
127    //     PackageSummaryHTML$sorter(final PackageSummaryHTML psHTML)
128    // { return psHTML.sorter(); }
129
130
131    // ********************************************************************************************
132    // ********************************************************************************************
133    // Upgrade
134    // ********************************************************************************************
135    // ********************************************************************************************
136
137
138    public static void Upgrade$registerEliminatedBuildPackages(
139            final Upgrade                       upgrade,
140            final ReadOnlyList<BuildPackage>    eliminatedBuildPackages
141        )
142    { upgrade.registerEliminatedBuildPackages(eliminatedBuildPackages); }
143
144}