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.

    Author:
    Robert Field., Atul Dambalkar., Jamie Ho, Bhavesh Patel (Modified)

    • Field Detail

      • BUILD_DATE

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

      • header

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

      • packagesheader

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

      • footer

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

      • doctitle

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

      • windowtitle

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

      • top

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

      • bottom

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

      • helpfile

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

      • stylesheetfile

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

      • docrootparent

        public 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.

      • 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 Set<String> doclintOpts
        Deprecated.
        Collected set of doclint options

      • 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.

      • tagSearchIndexKeys

        protected Set<Character> tagSearchIndexKeys
        Deprecated.

    • Constructor Detail

      • ConfigurationImpl

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

    • Method Detail

      • setSpecificDocletOptions

        public void setSpecificDocletOptions​(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.

      • optionLength

        public int optionLength​(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​(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.

      • 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