Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class ConfigurationImpl

  • @Deprecated
public class ConfigurationImpl
extends Configuration
    Deprecated.
    Configure the output based on the command line options.

    Also determine the length of the command line option. For example, for a option "-header" there will be a string argument associated, then the the length of option "-header" is two. But for option "-nohelp" no argument is needed so it's length is 1.

    Also do the error checking on the options used. For example it is illegal to use "-helpfile" option when already "-nohelp" option is used.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    • Field Detail

      • BUILD_DATE

        public static final java.lang.String BUILD_DATE
        Deprecated.
        The build date. Note: For now, we will use a version number instead of a date.

      • header

        public java.lang.String header
        Deprecated.
        Argument for command line option "-header".

      • packagesheader

        public java.lang.String packagesheader
        Deprecated.
        Argument for command line option "-packagesheader".

      • footer

        public java.lang.String footer
        Deprecated.
        Argument for command line option "-footer".

      • doctitle

        public java.lang.String doctitle
        Deprecated.
        Argument for command line option "-doctitle".

      • windowtitle

        public java.lang.String windowtitle
        Deprecated.
        Argument for command line option "-windowtitle".

      • top

        public java.lang.String top
        Deprecated.
        Argument for command line option "-top".

      • bottom

        public java.lang.String bottom
        Deprecated.
        Argument for command line option "-bottom".

      • helpfile

        public java.lang.String helpfile
        Deprecated.
        Argument for command line option "-helpfile".

      • stylesheetfile

        public java.lang.String stylesheetfile
        Deprecated.
        Argument for command line option "-stylesheetfile".

      • docrootparent

        public java.lang.String docrootparent
        Deprecated.
        Argument for command line option "-Xdocrootparent".

      • nohelp

        public boolean nohelp
        Deprecated.
        True if command line option "-nohelp" is used. Default value is false.

      • splitindex

        public boolean splitindex
        Deprecated.
        True if command line option "-splitindex" is used. Default value is false.

      • createindex

        public boolean createindex
        Deprecated.
        False if command line option "-noindex" is used. Default value is true.

      • classuse

        public boolean classuse
        Deprecated.
        True if command line option "-use" is used. Default value is false.

      • createtree

        public boolean createtree
        Deprecated.
        False if command line option "-notree" is used. Default value is true.

      • nodeprecatedlist

        public boolean nodeprecatedlist
        Deprecated.
        True if command line option "-nodeprecated" is used. Default value is false.

      • nonavbar

        public boolean nonavbar
        Deprecated.
        True if command line option "-nonavbar" is used. Default value is false.

      • nooverview

        private boolean nooverview
        Deprecated.
        True if command line option "-nooverview" is used. Default value is false

      • overview

        public boolean overview
        Deprecated.
        True if command line option "-overview" is used. Default value is false.

      • createoverview

        public boolean createoverview
        Deprecated.
        This is true if option "-overview" is used or option "-overview" is not used and number of packages is more than one.

      • htmlVersion

        public HtmlVersion htmlVersion
        Deprecated.
        This is the HTML version of the generated pages. HTML 4.01 is the default output version.

      • doclintOpts

        public java.util.Set<java.lang.String> doclintOpts
        Deprecated.
        Collected set of doclint options

      • allowScriptInComments

        private boolean allowScriptInComments
        Deprecated.
        Whether or not to check for JavaScript in doc comments.

      • standardmessage

        public final MessageRetriever standardmessage
        Deprecated.
        Unique Resource Handler for this package.

      • topFile

        public DocPath topFile
        Deprecated.
        First file to appear in the right-hand frame in the generated documentation.

      • currentcd

        public ClassDoc currentcd
        Deprecated.
        The classdoc for the class file getting generated.

      • memberSearchIndex

        protected java.util.List<SearchIndexItem> memberSearchIndex
        Deprecated.

      • packageSearchIndex

        protected java.util.List<SearchIndexItem> packageSearchIndex
        Deprecated.

      • tagSearchIndex

        protected java.util.List<SearchIndexItem> tagSearchIndex
        Deprecated.

      • typeSearchIndex

        protected java.util.List<SearchIndexItem> typeSearchIndex
        Deprecated.

      • tagSearchIndexMap

        protected java.util.Map<java.lang.Character,​java.util.List<SearchIndexItem>> tagSearchIndexMap
        Deprecated.

      • tagSearchIndexKeys

        protected java.util.Set<java.lang.Character> tagSearchIndexKeys
        Deprecated.

      • versionRBName

        private final java.lang.String versionRBName
        Deprecated.
        See Also:
        Constant Field Values

      • versionRB

        private java.util.ResourceBundle versionRB
        Deprecated.

      • fileManager

        private javax.tools.JavaFileManager fileManager
        Deprecated.

    • Constructor Detail

      • ConfigurationImpl

        public ConfigurationImpl()
        Deprecated.
        Constructor. Initializes resource for the MessageRetriever.

    • Method Detail

      • getDocletSpecificBuildDate

        public java.lang.String getDocletSpecificBuildDate()
        Deprecated.
        Return the build date for the doclet.
        Specified by:
        getDocletSpecificBuildDate in class Configuration

      • setSpecificDocletOptions

        public void setSpecificDocletOptions​(java.lang.String[][] options)
        Deprecated.
        Depending upon the command line options provided by the user, set configure the output generation environment.
        Specified by:
        setSpecificDocletOptions in class Configuration
        Parameters:
        options - The array of option names and values.

      • checkJavaScript

        private void checkJavaScript​(JavaScriptScanner jss,
                             java.lang.String opt,
                             java.lang.String value)
        Deprecated.

      • optionLength

        public int optionLength​(java.lang.String option)
        Deprecated.
        Returns the "length" of a given option. If an option takes no arguments, its length is one. If it takes one argument, it's length is two, and so on. This method is called by JavaDoc to parse the options it does not recognize. It then calls validOptions(String[][], gw.gosudoc.com.sun.javadoc.DocErrorReporter) to validate them. Note:
        The options arrive as case-sensitive strings. For options that are not case-sensitive, use toLowerCase() on the option string before comparing it.
        Overrides:
        optionLength in class Configuration
        Parameters:
        option - Command line option under consideration.
        Returns:
        number of arguments + 1 for a option. Zero return means option not known. Negative value means error occurred.

      • validOptions

        public boolean validOptions​(java.lang.String[][] options,
                            DocErrorReporter reporter)
        Deprecated.
        Perform error checking on the given options.
        Specified by:
        validOptions in class Configuration
        Parameters:
        options - the given options to check.
        reporter - the reporter used to report errors.

      • isOutputHtml5

        public boolean isOutputHtml5()
        Deprecated.
        Return true if the generated output is HTML5.

      • allowTag

        public boolean allowTag​(HtmlTag htmlTag)
        Deprecated.
        Return true if the tag is allowed for this specific version of HTML.

      • setTopFile

        protected void setTopFile​(RootDoc root)
        Deprecated.
        Decide the page which will appear first in the right-hand frame. It will be "overview-summary.html" if "-overview" option is used or no "-overview" but the number of packages is more than one. It will be "package-summary.html" of the respective package if there is only one package to document. It will be a class page(first in the sorted order), if only classes are provided on the command line.
        Parameters:
        root - Root of the program structure.

      • getValidClass

        protected ClassDoc getValidClass​(ClassDoc[] classarr)
        Deprecated.

      • checkForDeprecation

        protected boolean checkForDeprecation​(RootDoc root)
        Deprecated.

      • setCreateOverview

        protected void setCreateOverview()
        Deprecated.
        Generate "overview.html" page if option "-overview" is used or number of packages is more than one. Sets createoverview field to true.

      • getMemberComparator

        public java.util.Comparator<ProgramElementDoc> getMemberComparator()
        Deprecated.
        Return the comparator that will be used to sort member documentation. To no do any sorting, return null.
        Specified by:
        getMemberComparator in class Configuration
        Returns:
        the Comparator used to sort members.

      • getLocale

        public java.util.Locale getLocale()
        Deprecated.
        Return the Locale for this document.
        Specified by:
        getLocale in class Configuration

      • getFileManager

        public javax.tools.JavaFileManager getFileManager()
        Deprecated.
        Return the current file manager.
        Specified by:
        getFileManager in class Configuration

      • buildSearchTagIndex

        protected void buildSearchTagIndex()
        Deprecated.

      • isAllowScriptInComments

        public boolean isAllowScriptInComments()
        Deprecated.
        Returns whether or not to allow JavaScript in comments. Default is off; can be set true from a command line option.
        Returns:
        the allowScriptInComments