Class Configuration
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.Configuration
- Direct Known Subclasses:
ConfigurationImpl
Deprecated.
Configure the output based on the options. Doclets should sub-class
Configuration, to configure and add their own options. This class contains
all user options which are supported by the 1.1 doclet and the standard
doclet.
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 ClassesModifier and TypeClassDescriptionstatic class
Deprecated.Exception used to report a problem during setOptions. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected BuilderFactory
Deprecated.The factory for builders.Deprecated.The path to the builder XML input file.Deprecated.The META charset tag used for cross-platform viewing.Deprecated.The catalog of classes specified on the command-lineboolean
Deprecated.True if we should recursively copy the doc-file subdirectoriesprivate static final String
Deprecated.The default path to the builder XML.Deprecated.Destination directory name, in which doclet will generate the entire documentation.Deprecated.Encoding for this document.Deprecated.Destination directory name, in which doclet will copy the doc-files to.Deprecated.Encoding for this document.Deprecated.The list of doc-file subdirectories to excludeDeprecated.The list of qualifiers to excludeboolean
Deprecated.final Extern
Deprecated.The tracker of external package links.final Group
Deprecated.The package grouping instance.boolean
Deprecated.Generate documentation for JavaFX getters and setters automatically by copying it from the appropriate property definition.boolean
Deprecated.True if user wants to add member names as meta keywords.boolean
Deprecated.True if we should generate browsable sources.Deprecated.Message Retriever for the doclet, to retrieve message from the resource file for this Configuration, which is common for 1.1 and standard doclets.final MetaKeywords
Deprecated.The meta tag keywords instance.boolean
Deprecated.True if user wants to suppress descriptions and tags.boolean
Deprecated.Don't generate deprecated API information at all, if -nodeprecated option is used.boolean
Deprecated.True if command line option "-nosince" is used.boolean
Deprecated.True if user wants to suppress time stamp in output.Deprecated.A sorted set of packages specified on the command-line merged with a collection of packages that contain the classes specified on the command-line.Deprecated.The Root of the generated Program Structure from the Doclet API.boolean
Deprecated.This is true if option "-serialwarn" is used.boolean
Deprecated.Generate author specific information for all the classes if @author tag is used in the doc comment and if -author option is used.boolean
Deprecated.Generate version specific information for the all the classes if @version tag is used in the doc comment and if -version option is used.int
Deprecated.The specified amount of space between tab stops.Deprecated.Deprecated.The taglet manager.Deprecated.The path to TagletsDeprecated.An utility class for commonly used helpers -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Deprecated.static String
addTrailingFileSep
(String path) Deprecated.Add a trailing file separator, if not found.private boolean
checkOutputFileEncoding
(String docencoding, DocErrorReporter reporter) Deprecated.Check the validity of the given Source or Output File encoding on this platform.private void
Deprecated.boolean
generalValidOptions
(String[][] options, DocErrorReporter reporter) Deprecated.This checks for the validity of the options used by the user.Deprecated.Return the builder factory for this doclet.Deprecated.Return the input stream to the builder XML.getClassName
(ClassDoc cd) Deprecated.Return the qualified name of theClassDoc
if it's qualifier is not excluded.abstract String
Deprecated.Return the build date for the doclet.abstract MessageRetriever
Deprecated.Return the doclet specificMessageRetriever
abstract JavaFileManager
Deprecated.Return the current file manager.abstract Locale
Deprecated.Return the Locale for this document.abstract JavaFileManager.Location
Deprecated.abstract Comparator<ProgramElementDoc>
Deprecated.Return the comparator that will be used to sort member documentation.getResource
(String key) Deprecated.Get the configuration string as a content.getResource
(String key, Object o) Deprecated.Get the configuration string as a content.getResource
(String key, Object o1, Object o2) Deprecated.Get the configuration string as a content.getResource
(String key, Object o0, Object o1, Object o2) Deprecated.Get the configuration string as a content.Deprecated.Deprecated.Deprecated.Deprecated.abstract WriterFactory
Deprecated.Return the doclet specific instance of a writer factory.private void
Deprecated.private void
initTagletManager
(Set<String[]> customTagStrs) Deprecated.Initialize the taglet manager.boolean
Deprecated.Return true if the ClassDoc element is getting documented, depending upon -nodeprecated option and the deprecation information.abstract Content
Deprecated.int
optionLength
(String option) Deprecated.This method should be defined in all those doclets which want to inherit from this Configuration.void
Deprecated.Set the command line options supported by this configuration.void
setOptions
(String[][] options) Deprecated.Set the command line options supported by this configuration.abstract void
setSpecificDocletOptions
(String[][] options) Deprecated.This method should be defined in all those doclets(configurations), which want to derive themselves from this Configuration.private void
setTabWidth
(int n) Deprecated.boolean
shouldExcludeDocFileDir
(String docfilesubdir) Deprecated.Return true if the given doc-file subdirectory should be excluded and false otherwise.boolean
shouldExcludeQualifier
(String qualifier) Deprecated.Return true if the given qualifier should be excluded and false otherwise.abstract boolean
showMessage
(SourcePosition pos, String key) Deprecated.private String[]
Deprecated.Given a string, return an array of tokens.abstract boolean
validOptions
(String[][] options, DocErrorReporter reporter) Deprecated.Perform error checking on the given options.
-
Field Details
-
builderFactory
Deprecated.The factory for builders. -
tagletManager
Deprecated.The taglet manager. -
builderXMLPath
Deprecated.The path to the builder XML input file. -
DEFAULT_BUILDER_XML
Deprecated.The default path to the builder XML.- See Also:
-
tagletpath
Deprecated.The path to Taglets -
serialwarn
public boolean serialwarnDeprecated.This is true if option "-serialwarn" is used. Defualt value is false to suppress excessive warnings about serial tag. -
sourcetab
public int sourcetabDeprecated.The specified amount of space between tab stops. -
tabSpaces
Deprecated. -
linksource
public boolean linksourceDeprecated.True if we should generate browsable sources. -
nosince
public boolean nosinceDeprecated.True if command line option "-nosince" is used. Default value is false. -
copydocfilesubdirs
public boolean copydocfilesubdirsDeprecated.True if we should recursively copy the doc-file subdirectories -
charset
Deprecated.The META charset tag used for cross-platform viewing. -
keywords
public boolean keywordsDeprecated.True if user wants to add member names as meta keywords. Set to false because meta keywords are ignored in general by most Internet search engines. -
metakeywords
Deprecated.The meta tag keywords instance. -
excludedDocFileDirs
Deprecated.The list of doc-file subdirectories to exclude -
excludedQualifiers
Deprecated.The list of qualifiers to exclude -
root
Deprecated.The Root of the generated Program Structure from the Doclet API. -
utils
Deprecated.An utility class for commonly used helpers -
destDirName
Deprecated.Destination directory name, in which doclet will generate the entire documentation. Default is current directory. -
docFileDestDirName
Deprecated.Destination directory name, in which doclet will copy the doc-files to. -
docencoding
Deprecated.Encoding for this document. Default is default encoding for this platform. -
nocomment
public boolean nocommentDeprecated.True if user wants to suppress descriptions and tags. -
encoding
Deprecated.Encoding for this document. Default is default encoding for this platform. -
showauthor
public boolean showauthorDeprecated.Generate author specific information for all the classes if @author tag is used in the doc comment and if -author option is used.showauthor
is set to true if -author option is used. Default is don't show author information. -
javafx
public boolean javafxDeprecated.Generate documentation for JavaFX getters and setters automatically by copying it from the appropriate property definition. -
showversion
public boolean showversionDeprecated.Generate version specific information for the all the classes if @version tag is used in the doc comment and if -version option is used.showversion
is set to true if -version option is used.Default is don't show version information. -
nodeprecated
public boolean nodeprecatedDeprecated.Don't generate deprecated API information at all, if -nodeprecated option is used.nodepracted
is set to true if -nodeprecated option is used. Default is generate deprected API information. -
classDocCatalog
Deprecated.The catalog of classes specified on the command-line -
message
Deprecated.Message Retriever for the doclet, to retrieve message from the resource file for this Configuration, which is common for 1.1 and standard doclets. TODO: Make this private!!! -
notimestamp
public boolean notimestampDeprecated.True if user wants to suppress time stamp in output. Default is false. -
group
Deprecated.The package grouping instance. -
extern
Deprecated.The tracker of external package links. -
packages
Deprecated.A sorted set of packages specified on the command-line merged with a collection of packages that contain the classes specified on the command-line. -
exportInternalAPI
public boolean exportInternalAPIDeprecated.
-
-
Constructor Details
-
Configuration
public Configuration()Deprecated.Constructor. Constructs the message retriever with resource file.
-
-
Method Details
-
getDocletSpecificBuildDate
Deprecated.Return the build date for the doclet. -
setSpecificDocletOptions
Deprecated.This method should be defined in all those doclets(configurations), which want to derive themselves from this Configuration. This method can be used to set its own command line options.- Parameters:
options
- The array of option names and values.- Throws:
DocletAbortException
Configuration.Fault
-
getDocletSpecificMsg
Deprecated.Return the doclet specificMessageRetriever
- Returns:
- the doclet specific MessageRetriever.
-
getBuilderFactory
Deprecated.Return the builder factory for this doclet.- Returns:
- the builder factory for this doclet.
-
optionLength
Deprecated.This method should be defined in all those doclets which want to inherit from this Configuration. This method should return the number of arguments to the command line option (including the option name). For example, -notimestamp is a single-argument option, so this method would return 1.- Parameters:
option
- Command line option under consideration.- Returns:
- number of arguments to option (including the option name). Zero return means option not known. Negative value means error occurred.
-
validOptions
Deprecated.Perform error checking on the given options.- Parameters:
options
- the given options to check.reporter
- the reporter used to report errors.
-
initPackages
private void initPackages()Deprecated. -
setOptions
Deprecated.Set the command line options supported by this configuration.- Parameters:
options
- the two dimensional array of options.- Throws:
Configuration.Fault
-
setOptions
Deprecated.Set the command line options supported by this configuration. -
ensureOutputDirExists
Deprecated.- Throws:
Configuration.Fault
-
initTagletManager
Deprecated.Initialize the taglet manager. The strings to initialize the simple custom tags should be in the following format: "[tag name]:[location str]:[heading]".- Parameters:
customTagStrs
- the set two dimensional arrays of strings. These arrays contain either -tag or -taglet arguments.
-
tokenize
Deprecated.Given a string, return an array of tokens. The separator can be escaped with the '\' character. The '\' character may also be escaped by the '\' character.- Parameters:
s
- the string to tokenize.separator
- the separator char.maxTokens
- the maximum number of tokens returned. If the max is reached, the remaining part of s is appended to the end of the last token.- Returns:
- an array of tokens.
-
addToSet
Deprecated. -
addTrailingFileSep
Deprecated.Add a trailing file separator, if not found. Remove superfluous file separators if any. Preserve the front double file separator for UNC paths.- Parameters:
path
- Path under consideration.- Returns:
- String Properly constructed path string.
-
generalValidOptions
Deprecated.This checks for the validity of the options used by the user. This works exactly likeDoclet.validOptions(String[][], gw.gosudoc.com.sun.javadoc.DocErrorReporter)
. This will validate the options which are shared by our doclets. For example, this method will flag an error using the DocErrorReporter if user has used "-nohelp" and "-helpfile" option together.- Parameters:
options
- options used on the command line.reporter
- used to report errors.- Returns:
- true if all the options are valid.
-
checkOutputFileEncoding
Deprecated.Check the validity of the given Source or Output File encoding on this platform.- Parameters:
docencoding
- output file encoding.reporter
- used to report errors.
-
shouldExcludeDocFileDir
Deprecated.Return true if the given doc-file subdirectory should be excluded and false otherwise.- Parameters:
docfilesubdir
- the doc-files subdirectory to check.
-
shouldExcludeQualifier
Deprecated.Return true if the given qualifier should be excluded and false otherwise.- Parameters:
qualifier
- the qualifier to check.
-
getClassName
Deprecated.Return the qualified name of theClassDoc
if it's qualifier is not excluded. Otherwise, return the unqualifiedClassDoc
name.- Parameters:
cd
- theClassDoc
to check.
-
getText
Deprecated. -
getText
Deprecated. -
getText
Deprecated. -
getText
Deprecated. -
newContent
Deprecated. -
getResource
Deprecated.Get the configuration string as a content.- Parameters:
key
- the key to look for in the configuration file- Returns:
- a content tree for the text
-
getResource
Deprecated.Get the configuration string as a content.- Parameters:
key
- the key to look for in the configuration fileo
- string or content argument added to configuration text- Returns:
- a content tree for the text
-
getResource
Deprecated.Get the configuration string as a content.- Parameters:
key
- the key to look for in the configuration fileo
- string or content argument added to configuration text- Returns:
- a content tree for the text
-
getResource
Deprecated.Get the configuration string as a content.- Parameters:
key
- the key to look for in the configuration fileo1
- string or content argument added to configuration texto2
- string or content argument added to configuration text- Returns:
- a content tree for the text
-
isGeneratedDoc
Deprecated.Return true if the ClassDoc element is getting documented, depending upon -nodeprecated option and the deprecation information. Return true if -nodeprecated is not used. Return false if -nodeprecated is used and if either ClassDoc element is deprecated or the containing package is deprecated.- Parameters:
cd
- the ClassDoc for which the page generation is checked
-
getWriterFactory
Deprecated.Return the doclet specific instance of a writer factory.- Returns:
- the
WriterFactory
for the doclet.
-
getBuilderXML
Deprecated.Return the input stream to the builder XML.- Returns:
- the input steam to the builder XML.
- Throws:
FileNotFoundException
- when the given XML file cannot be found.IOException
-
getLocale
Deprecated.Return the Locale for this document. -
getFileManager
Deprecated.Return the current file manager. -
getMemberComparator
Deprecated.Return the comparator that will be used to sort member documentation. To no do any sorting, return null.- Returns:
- the
Comparator
used to sort members.
-
setTabWidth
private void setTabWidth(int n) Deprecated. -
showMessage
Deprecated. -
getLocationForPackage
Deprecated.
-