Class ConfigurationImpl
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.Configuration
gw.gosudoc.com.sun.tools.doclets.formats.html.ConfigurationImpl
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.Configuration
Configuration.Fault
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Deprecated.Whether or not to check for JavaScript in doc comments.Deprecated.Argument for command line option "-bottom".static final String
Deprecated.The build date.boolean
Deprecated.True if command line option "-use" is used.boolean
Deprecated.False if command line option "-noindex" is used.boolean
Deprecated.This is true if option "-overview" is used or option "-overview" is not used and number of packages is more than one.boolean
Deprecated.False if command line option "-notree" is used.Deprecated.The classdoc for the class file getting generated.Deprecated.Collected set of doclint optionsDeprecated.Argument for command line option "-Xdocrootparent".Deprecated.Argument for command line option "-doctitle".private JavaFileManager
Deprecated.Deprecated.Argument for command line option "-footer".Deprecated.Argument for command line option "-header".Deprecated.Argument for command line option "-helpfile".Deprecated.This is the HTML version of the generated pages.protected List<SearchIndexItem>
Deprecated.boolean
Deprecated.True if command line option "-nodeprecated" is used.boolean
Deprecated.True if command line option "-nohelp" is used.boolean
Deprecated.True if command line option "-nonavbar" is used.private boolean
Deprecated.True if command line option "-nooverview" is used.boolean
Deprecated.True if command line option "-overview" is used.protected List<SearchIndexItem>
Deprecated.Deprecated.Argument for command line option "-packagesheader".boolean
Deprecated.True if command line option "-splitindex" is used.final MessageRetriever
Deprecated.Unique Resource Handler for this package.Deprecated.Argument for command line option "-stylesheetfile".protected List<SearchIndexItem>
Deprecated.Deprecated.protected Map<Character,
List<SearchIndexItem>> Deprecated.Deprecated.Argument for command line option "-top".Deprecated.First file to appear in the right-hand frame in the generated documentation.protected List<SearchIndexItem>
Deprecated.private ResourceBundle
Deprecated.private final String
Deprecated.Deprecated.Argument for command line option "-windowtitle".Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.Configuration
builderFactory, builderXMLPath, charset, classDocCatalog, copydocfilesubdirs, destDirName, docencoding, docFileDestDirName, encoding, excludedDocFileDirs, excludedQualifiers, exportInternalAPI, extern, group, javafx, keywords, linksource, message, metakeywords, nocomment, nodeprecated, nosince, notimestamp, packages, root, serialwarn, showauthor, showversion, sourcetab, tabSpaces, tagletManager, tagletpath, utils
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.Return true if the tag is allowed for this specific version of HTML.protected void
Deprecated.protected boolean
checkForDeprecation
(RootDoc root) Deprecated.private void
checkJavaScript
(JavaScriptScanner jss, String opt, String value) Deprecated.Deprecated.Return the build date for the doclet.Deprecated.Return the doclet specificMessageRetriever
Deprecated.Return the current file manager.Deprecated.Return the Locale for this document.Deprecated.Deprecated.Return the comparator that will be used to sort member documentation.protected ClassDoc
getValidClass
(ClassDoc[] classarr) Deprecated.Deprecated.Return the doclet specific instance of a writer factory.boolean
Deprecated.Returns whether or not to allow JavaScript in comments.boolean
Deprecated.Return true if the generated output is HTML5.Deprecated.int
optionLength
(String option) Deprecated.Returns the "length" of a given option.protected void
Deprecated.Generate "overview.html" page if option "-overview" is used or number of packages is more than one.void
setSpecificDocletOptions
(String[][] options) Deprecated.Depending upon the command line options provided by the user, set configure the output generation environment.protected void
setTopFile
(RootDoc root) Deprecated.Decide the page which will appear first in the right-hand frame.boolean
showMessage
(SourcePosition pos, String key) Deprecated.boolean
validOptions
(String[][] options, DocErrorReporter reporter) Deprecated.Perform error checking on the given options.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.Configuration
addTrailingFileSep, generalValidOptions, getBuilderFactory, getBuilderXML, getClassName, getResource, getResource, getResource, getResource, getText, getText, getText, getText, isGeneratedDoc, setOptions, setOptions, shouldExcludeDocFileDir, shouldExcludeQualifier
-
Field Details
-
BUILD_DATE
Deprecated.The build date. Note: For now, we will use a version number instead of a date. -
header
Deprecated.Argument for command line option "-header". -
packagesheader
Deprecated.Argument for command line option "-packagesheader". -
doctitle
Deprecated.Argument for command line option "-doctitle". -
windowtitle
Deprecated.Argument for command line option "-windowtitle". -
top
Deprecated.Argument for command line option "-top". -
bottom
Deprecated.Argument for command line option "-bottom". -
helpfile
Deprecated.Argument for command line option "-helpfile". -
stylesheetfile
Deprecated.Argument for command line option "-stylesheetfile". -
docrootparent
Deprecated.Argument for command line option "-Xdocrootparent". -
nohelp
public boolean nohelpDeprecated.True if command line option "-nohelp" is used. Default value is false. -
splitindex
public boolean splitindexDeprecated.True if command line option "-splitindex" is used. Default value is false. -
createindex
public boolean createindexDeprecated.False if command line option "-noindex" is used. Default value is true. -
classuse
public boolean classuseDeprecated.True if command line option "-use" is used. Default value is false. -
createtree
public boolean createtreeDeprecated.False if command line option "-notree" is used. Default value is true. -
nodeprecatedlist
public boolean nodeprecatedlistDeprecated.True if command line option "-nodeprecated" is used. Default value is false. -
nooverview
private boolean nooverviewDeprecated.True if command line option "-nooverview" is used. Default value is false -
overview
public boolean overviewDeprecated.True if command line option "-overview" is used. Default value is false. -
createoverview
public boolean createoverviewDeprecated.This is true if option "-overview" is used or option "-overview" is not used and number of packages is more than one. -
htmlVersion
Deprecated.This is the HTML version of the generated pages. HTML 4.01 is the default output version. -
doclintOpts
Deprecated.Collected set of doclint options -
allowScriptInComments
private boolean allowScriptInCommentsDeprecated.Whether or not to check for JavaScript in doc comments. -
standardmessage
Deprecated.Unique Resource Handler for this package. -
topFile
Deprecated.First file to appear in the right-hand frame in the generated documentation. -
currentcd
Deprecated.The classdoc for the class file getting generated. -
memberSearchIndex
Deprecated. -
packageSearchIndex
Deprecated. -
tagSearchIndex
Deprecated. -
typeSearchIndex
Deprecated. -
tagSearchIndexMap
Deprecated. -
tagSearchIndexKeys
Deprecated. -
versionRBName
Deprecated.- See Also:
-
versionRB
Deprecated. -
fileManager
Deprecated.
-
-
Constructor Details
-
ConfigurationImpl
public ConfigurationImpl()Deprecated.Constructor. Initializes resource for theMessageRetriever
.
-
-
Method Details
-
getDocletSpecificBuildDate
Deprecated.Return the build date for the doclet.- Specified by:
getDocletSpecificBuildDate
in classConfiguration
-
setSpecificDocletOptions
Deprecated.Depending upon the command line options provided by the user, set configure the output generation environment.- Specified by:
setSpecificDocletOptions
in classConfiguration
- Parameters:
options
- The array of option names and values.
-
checkJavaScript
Deprecated. -
optionLength
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 callsvalidOptions(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 classConfiguration
- 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
Deprecated.Perform error checking on the given options.- Specified by:
validOptions
in classConfiguration
- 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
Deprecated.Return true if the tag is allowed for this specific version of HTML. -
getDocletSpecificMsg
Deprecated.Return the doclet specificMessageRetriever
- Specified by:
getDocletSpecificMsg
in classConfiguration
- Returns:
- the doclet specific MessageRetriever.
-
setTopFile
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
Deprecated. -
checkForDeprecation
Deprecated. -
setCreateOverview
protected void setCreateOverview()Deprecated.Generate "overview.html" page if option "-overview" is used or number of packages is more than one. Setscreateoverview
field to true. -
getWriterFactory
Deprecated.Return the doclet specific instance of a writer factory.- Specified by:
getWriterFactory
in classConfiguration
- Returns:
- the
WriterFactory
for the doclet.
-
getMemberComparator
Deprecated.Return the comparator that will be used to sort member documentation. To no do any sorting, return null.- Specified by:
getMemberComparator
in classConfiguration
- Returns:
- the
Comparator
used to sort members.
-
getLocale
Deprecated.Return the Locale for this document.- Specified by:
getLocale
in classConfiguration
-
getFileManager
Deprecated.Return the current file manager.- Specified by:
getFileManager
in classConfiguration
-
showMessage
Deprecated.- Specified by:
showMessage
in classConfiguration
-
newContent
Deprecated.- Specified by:
newContent
in classConfiguration
-
getLocationForPackage
Deprecated.- Specified by:
getLocationForPackage
in classConfiguration
-
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
-