| java.lang.Object
 com.sun.tools.doclets.internal.toolkit.Configuration
All known Subclasses: com.sun.tools.doclets.formats.html.ConfigurationImpl,
| Configuration | | abstract public class Configuration (Code) | | 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 code is not part of an API.
It is implementation that is subject to change.
Do not use it as an API
author:
Robert Field.
author:
Atul Dambalkar.
author:
Jamie Ho |
| Field Summary | |
| protected BuilderFactory | builderFactory
The factory for builders. | | public String | builderXMLPath
The path to the builder XML input file. | | public String | charset
The META charset tag used for cross-platform viewing. | | public ClassDocCatalog | classDocCatalog
| | public boolean | copydocfilesubdirs
| | public String | destDirName
Destination directory name, in which doclet will generate the entire
documentation. | | public String | docFileDestDirName
Destination directory name, in which doclet will copy the doc-files to. | | public String | docencoding
Encoding for this document. | | public String | encoding
Encoding for this document. | | protected Set | excludedDocFileDirs
| | protected Set | excludedQualifiers
| | final public Extern | extern
The tracker of external package links (sole-instance). | | final public Group | group
The package grouping sole-instance. | | public boolean | keywords
True if user wants to add member names as meta keywords. | | public boolean | linksource
True if we should generate browsable sources. | | public MessageRetriever | message
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 public MetaKeywords | metakeywords
The meta tag keywords sole-instance. | | public boolean | nocomment
True if user wants to suppress descriptions and tags. | | public boolean | nodeprecated
Don't generate deprecated API information at all, if -nodeprecated
option is used. | | public boolean | nosince
True if command line option "-nosince" is used. | | public boolean | notimestamp
True if user wants to suppress time stamp in output. | | public PackageDoc[] | packages
An array of the packages specified on the command-line merged
with the array of packages that contain the classes specified on the
command-line. | | public RootDoc | root
The Root of the generated Program Structure from the Doclet API. | | public boolean | serialwarn
This is true if option "-serialwarn" is used. | | public boolean | showauthor
Generate author specific information for all the classes if @author
tag is used in the doc comment and if -author option is used. | | public boolean | showversion
Generate version specific information for the all the classes
if @version tag is used in the doc comment and if -version option is
used. | | public String | sourcepath
Sourcepath from where to read the source files. | | public int | sourcetab
The specified amount of space between tab stops. | | public TagletManager | tagletManager
The taglet manager. | | public String | tagletpath
|
| Method Summary | |
| String | addTrailingFileSep(String path)
Add a traliling file separator, if not found or strip off extra trailing
file separators if any.
Parameters:
path - Path under consideration. | | public boolean | generalValidOptions(String options, DocErrorReporter reporter)
This checks for the validity of the options used by the user.
This works exactly like
com.sun.javadoc.Doclet.validOptions(String[][]DocErrorReporter) . | | public BuilderFactory | getBuilderFactory()
Return the builder factory for this doclet. | | public InputStream | getBuilderXML()
Return the input stream to the builder XML. | | public String | getClassName(ClassDoc cd)
Return the qualified name of the ClassDoc if it's qualifier is not excluded. | | abstract public String | getDocletSpecificBuildDate()
Return the build date for the doclet. | | abstract public MessageRetriever | getDocletSpecificMsg()
| | abstract public Comparator | getMemberComparator()
Return the comparator that will be used to sort member documentation. | | public String | getText(String key)
| | public String | getText(String key, String a1)
| | public String | getText(String key, String a1, String a2)
| | public String | getText(String key, String a1, String a2, String a3)
| | abstract public WriterFactory | getWriterFactory()
Return the doclet specific instance of a writer factory. | | public boolean | isGeneratedDoc(Doc doc)
Return true if the doc element is getting documented, depending upon
-nodeprecated option and @deprecated tag used. | | public int | optionLength(String option)
This method should be defined in all those doclets
which want to inherit from this Configuration. | | public void | setOptions(String[][] options)
Set the command line options supported by this configuration. | | public void | setOptions()
Set the command line options supported by this configuration. | | abstract public void | setSpecificDocletOptions(String[][] options)
This method should be defined in all those doclets(configurations),
which want to derive themselves from this Configuration. | | public boolean | shouldExcludeDocFileDir(String docfilesubdir)
Return true if the given doc-file subdirectory should be excluded and
false otherwise. | | public boolean | shouldExcludeQualifier(String qualifier)
Return true if the given qualifier should be excluded and false otherwise. | | abstract public boolean | validOptions(String options, DocErrorReporter reporter)
Perform error checking on the given options. |
| builderXMLPath | | public String builderXMLPath(Code) | | The path to the builder XML input file.
|
| charset | | public String charset(Code) | | The META charset tag used for cross-platform viewing.
|
| classDocCatalog | | public ClassDocCatalog classDocCatalog(Code) | | The catalog of classes specified on the command-line
|
| copydocfilesubdirs | | public boolean copydocfilesubdirs(Code) | | True if we should recursively copy the doc-file subdirectories
|
| destDirName | | public String destDirName(Code) | | Destination directory name, in which doclet will generate the entire
documentation. Default is current directory.
|
| docFileDestDirName | | public String docFileDestDirName(Code) | | Destination directory name, in which doclet will copy the doc-files to.
|
| docencoding | | public String docencoding(Code) | | Encoding for this document. Default is default encoding for this
platform.
|
| encoding | | public String encoding(Code) | | Encoding for this document. Default is default encoding for this
platform.
|
| excludedDocFileDirs | | protected Set excludedDocFileDirs(Code) | | The list of doc-file subdirectories to exclude
|
| excludedQualifiers | | protected Set excludedQualifiers(Code) | | The list of qualifiers to exclude
|
| extern | | final public Extern extern(Code) | | The tracker of external package links (sole-instance).
|
| group | | final public Group group(Code) | | The package grouping sole-instance.
|
| keywords | | public boolean keywords(Code) | | 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.
|
| linksource | | public boolean linksource(Code) | | True if we should generate browsable sources.
|
| message | | public MessageRetriever message(Code) | | 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!!!
|
| metakeywords | | final public MetaKeywords metakeywords(Code) | | The meta tag keywords sole-instance.
|
| nocomment | | public boolean nocomment(Code) | | True if user wants to suppress descriptions and tags.
|
| nodeprecated | | public boolean nodeprecated(Code) | | 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.
|
| nosince | | public boolean nosince(Code) | | True if command line option "-nosince" is used. Default value is
false.
|
| notimestamp | | public boolean notimestamp(Code) | | True if user wants to suppress time stamp in output.
Default is false.
|
| packages | | public PackageDoc[] packages(Code) | | An array of the packages specified on the command-line merged
with the array of packages that contain the classes specified on the
command-line. The array is sorted.
|
| root | | public RootDoc root(Code) | | The Root of the generated Program Structure from the Doclet API.
|
| serialwarn | | public boolean serialwarn(Code) | | This is true if option "-serialwarn" is used. Defualt value is false to
supress excessive warnings about serial tag.
|
| showauthor | | public boolean showauthor(Code) | | 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.
|
| showversion | | public boolean showversion(Code) | | 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.
|
| sourcepath | | public String sourcepath(Code) | | Sourcepath from where to read the source files. Default is classpath.
|
| sourcetab | | public int sourcetab(Code) | | The specified amount of space between tab stops.
|
| tagletpath | | public String tagletpath(Code) | | The path to Taglets
|
| Configuration | | public Configuration()(Code) | | Constructor. Constructs the message retriever with resource file.
|
| addTrailingFileSep | | String addTrailingFileSep(String path)(Code) | | Add a traliling file separator, if not found or strip off extra trailing
file separators if any.
Parameters:
path - Path under consideration. String Properly constructed path string. |
| generalValidOptions | | public boolean generalValidOptions(String options, DocErrorReporter reporter)(Code) | | This checks for the validity of the options used by the user.
This works exactly like
com.sun.javadoc.Doclet.validOptions(String[][]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.
Parameters:
reporter - used to report errors. true if all the options are valid. |
| getBuilderFactory | | public BuilderFactory getBuilderFactory()(Code) | | Return the builder factory for this doclet.
the builder factory for this doclet. |
| getClassName | | public String getClassName(ClassDoc cd)(Code) | | Return the qualified name of the ClassDoc if it's qualifier is not excluded. Otherwise,
return the unqualified ClassDoc name.
Parameters:
cd - the ClassDoc to check. |
| getDocletSpecificBuildDate | | abstract public String getDocletSpecificBuildDate()(Code) | | Return the build date for the doclet.
|
| getMemberComparator | | abstract public Comparator getMemberComparator()(Code) | | Return the comparator that will be used to sort member documentation.
To no do any sorting, return null.
the java.util.Comparator used to sort members. |
| getWriterFactory | | abstract public WriterFactory getWriterFactory()(Code) | | Return the doclet specific instance of a writer factory.
the WriterFactory for the doclet. |
| isGeneratedDoc | | public boolean isGeneratedDoc(Doc doc)(Code) | | Return true if the doc element is getting documented, depending upon
-nodeprecated option and @deprecated tag used. Return true if
-nodeprecated is not used or @deprecated tag is not used.
|
| optionLength | | public int optionLength(String option)(Code) | | 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. number of arguments to option (including theoption name). Zero return means option not known.Negative value means error occurred. |
| setOptions | | public void setOptions(String[][] options)(Code) | | Set the command line options supported by this configuration.
Parameters:
options - the two dimensional array of options. |
| setOptions | | public void setOptions()(Code) | | Set the command line options supported by this configuration.
throws:
DocletAbortException - |
| setSpecificDocletOptions | | abstract public void setSpecificDocletOptions(String[][] options)(Code) | | 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 - |
| shouldExcludeDocFileDir | | public boolean shouldExcludeDocFileDir(String docfilesubdir)(Code) | | Return true if the given doc-file subdirectory should be excluded and
false otherwise.
Parameters:
docfilesubdir - the doc-files subdirectory to check. |
| shouldExcludeQualifier | | public boolean shouldExcludeQualifier(String qualifier)(Code) | | Return true if the given qualifier should be excluded and false otherwise.
Parameters:
qualifier - the qualifier to check. |
| validOptions | | abstract public boolean validOptions(String options, DocErrorReporter reporter)(Code) | | Perform error checking on the given options.
Parameters:
options - the given options to check.
Parameters:
reporter - the reporter used to report errors. |
|
|