java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.Configuration
Direct Known Subclasses:
ConfigurationImpl

@Deprecated public abstract class Configuration extends Object
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.

  • Field Details

    • builderFactory

      protected BuilderFactory builderFactory
      Deprecated.
      The factory for builders.
    • tagletManager

      public TagletManager tagletManager
      Deprecated.
      The taglet manager.
    • builderXMLPath

      public String builderXMLPath
      Deprecated.
      The path to the builder XML input file.
    • DEFAULT_BUILDER_XML

      private static final String DEFAULT_BUILDER_XML
      Deprecated.
      The default path to the builder XML.
      See Also:
    • tagletpath

      public String tagletpath
      Deprecated.
      The path to Taglets
    • serialwarn

      public boolean serialwarn
      Deprecated.
      This is true if option "-serialwarn" is used. Defualt value is false to suppress excessive warnings about serial tag.
    • sourcetab

      public int sourcetab
      Deprecated.
      The specified amount of space between tab stops.
    • tabSpaces

      public String tabSpaces
      Deprecated.
    • linksource

      public boolean linksource
      Deprecated.
      True if we should generate browsable sources.
    • nosince

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

      public boolean copydocfilesubdirs
      Deprecated.
      True if we should recursively copy the doc-file subdirectories
    • charset

      public String charset
      Deprecated.
      The META charset tag used for cross-platform viewing.
    • keywords

      public boolean keywords
      Deprecated.
      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

      public final MetaKeywords metakeywords
      Deprecated.
      The meta tag keywords instance.
    • excludedDocFileDirs

      protected Set<String> excludedDocFileDirs
      Deprecated.
      The list of doc-file subdirectories to exclude
    • excludedQualifiers

      protected Set<String> excludedQualifiers
      Deprecated.
      The list of qualifiers to exclude
    • root

      public RootDoc root
      Deprecated.
      The Root of the generated Program Structure from the Doclet API.
    • utils

      public Utils utils
      Deprecated.
      An utility class for commonly used helpers
    • destDirName

      public String destDirName
      Deprecated.
      Destination directory name, in which doclet will generate the entire documentation. Default is current directory.
    • docFileDestDirName

      public String docFileDestDirName
      Deprecated.
      Destination directory name, in which doclet will copy the doc-files to.
    • docencoding

      public String docencoding
      Deprecated.
      Encoding for this document. Default is default encoding for this platform.
    • nocomment

      public boolean nocomment
      Deprecated.
      True if user wants to suppress descriptions and tags.
    • encoding

      public String encoding
      Deprecated.
      Encoding for this document. Default is default encoding for this platform.
    • showauthor

      public boolean showauthor
      Deprecated.
      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 javafx
      Deprecated.
      Generate documentation for JavaFX getters and setters automatically by copying it from the appropriate property definition.
    • showversion

      public boolean showversion
      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. showversion is set to true if -version option is used.Default is don't show version information.
    • nodeprecated

      public boolean nodeprecated
      Deprecated.
      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

      public ClassDocCatalog classDocCatalog
      Deprecated.
      The catalog of classes specified on the command-line
    • message

      public MessageRetriever 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 notimestamp
      Deprecated.
      True if user wants to suppress time stamp in output. Default is false.
    • group

      public final Group group
      Deprecated.
      The package grouping instance.
    • extern

      public final Extern extern
      Deprecated.
      The tracker of external package links.
    • packages

      public SortedSet<PackageDoc> 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 exportInternalAPI
      Deprecated.
  • Constructor Details

    • Configuration

      public Configuration()
      Deprecated.
      Constructor. Constructs the message retriever with resource file.
  • Method Details

    • getDocletSpecificBuildDate

      public abstract String getDocletSpecificBuildDate()
      Deprecated.
      Return the build date for the doclet.
    • setSpecificDocletOptions

      public abstract void setSpecificDocletOptions(String[][] options) throws Configuration.Fault
      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

      public abstract MessageRetriever getDocletSpecificMsg()
      Deprecated.
      Return the doclet specific MessageRetriever
      Returns:
      the doclet specific MessageRetriever.
    • getBuilderFactory

      public BuilderFactory getBuilderFactory()
      Deprecated.
      Return the builder factory for this doclet.
      Returns:
      the builder factory for this doclet.
    • optionLength

      public int optionLength(String option)
      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

      public abstract boolean validOptions(String[][] options, DocErrorReporter reporter)
      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

      public void setOptions(String[][] options) throws Configuration.Fault
      Deprecated.
      Set the command line options supported by this configuration.
      Parameters:
      options - the two dimensional array of options.
      Throws:
      Configuration.Fault
    • setOptions

      public void setOptions() throws Configuration.Fault
      Deprecated.
      Set the command line options supported by this configuration.
      Throws:
      DocletAbortException
      Configuration.Fault
    • ensureOutputDirExists

      private void ensureOutputDirExists() throws Configuration.Fault
      Deprecated.
      Throws:
      Configuration.Fault
    • initTagletManager

      private void initTagletManager(Set<String[]> customTagStrs)
      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

      private String[] tokenize(String s, char separator, int maxTokens)
      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

      private void addToSet(Set<String> s, String str)
      Deprecated.
    • addTrailingFileSep

      public static String addTrailingFileSep(String path)
      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

      public boolean generalValidOptions(String[][] options, DocErrorReporter reporter)
      Deprecated.
      This checks for the validity of the options used by the user. This works exactly like Doclet.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

      private boolean checkOutputFileEncoding(String docencoding, DocErrorReporter reporter)
      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

      public boolean shouldExcludeDocFileDir(String docfilesubdir)
      Deprecated.
      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)
      Deprecated.
      Return true if the given qualifier should be excluded and false otherwise.
      Parameters:
      qualifier - the qualifier to check.
    • getClassName

      public String getClassName(ClassDoc cd)
      Deprecated.
      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.
    • getText

      public String getText(String key)
      Deprecated.
    • getText

      public String getText(String key, String a1)
      Deprecated.
    • getText

      public String getText(String key, String a1, String a2)
      Deprecated.
    • getText

      public String getText(String key, String a1, String a2, String a3)
      Deprecated.
    • newContent

      public abstract Content newContent()
      Deprecated.
    • getResource

      public Content getResource(String key)
      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

      public Content getResource(String key, Object o)
      Deprecated.
      Get the configuration string as a content.
      Parameters:
      key - the key to look for in the configuration file
      o - string or content argument added to configuration text
      Returns:
      a content tree for the text
    • getResource

      public Content getResource(String key, Object o1, Object o2)
      Deprecated.
      Get the configuration string as a content.
      Parameters:
      key - the key to look for in the configuration file
      o - string or content argument added to configuration text
      Returns:
      a content tree for the text
    • getResource

      public Content getResource(String key, Object o0, Object o1, Object o2)
      Deprecated.
      Get the configuration string as a content.
      Parameters:
      key - the key to look for in the configuration file
      o1 - string or content argument added to configuration text
      o2 - string or content argument added to configuration text
      Returns:
      a content tree for the text
    • isGeneratedDoc

      public boolean isGeneratedDoc(ClassDoc cd)
      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

      public abstract WriterFactory getWriterFactory()
      Deprecated.
      Return the doclet specific instance of a writer factory.
      Returns:
      the WriterFactory for the doclet.
    • getBuilderXML

      public InputStream getBuilderXML() throws IOException
      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

      public abstract Locale getLocale()
      Deprecated.
      Return the Locale for this document.
    • getFileManager

      public abstract JavaFileManager getFileManager()
      Deprecated.
      Return the current file manager.
    • getMemberComparator

      public abstract Comparator<ProgramElementDoc> 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

      public abstract boolean showMessage(SourcePosition pos, String key)
      Deprecated.
    • getLocationForPackage

      public abstract JavaFileManager.Location getLocationForPackage(PackageDoc pd)
      Deprecated.