Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util

Class Extern

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.Extern
@Deprecated public class Extern extends Object
Deprecated.
Process and manage "-link" and "-linkoffline" to external packages. The options "-link" and "-linkoffline" both depend on the fact that Javadoc now generates "package-list"(lists all the packages which are getting documented) file in the current or the destination directory, while generating the documentation.

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

    • packageToItemMap

      private Map<String,Extern.Item> packageToItemMap
      Deprecated.
      Map package names onto Extern Item objects. Lazily initialized.

    • configuration

      private final Configuration configuration
      Deprecated.
      The global configuration information for this run.

    • linkoffline

      private boolean linkoffline
      Deprecated.
      True if we are using -linkoffline and false if -link is used instead.

  • Constructor Details

    • Extern

      public Extern(Configuration configuration)
      Deprecated.

  • Method Details

    • isExternal

      public boolean isExternal(ProgramElementDoc doc)
      Deprecated.
      Determine if a doc item is externally documented.
      Parameters:
      doc - A ProgramElementDoc.

    • getExternalLink

      public DocLink getExternalLink(String pkgName, DocPath relativepath, String filename)
      Deprecated.
      Convert a link to be an external link if appropriate.
      Parameters:
      pkgName - The package name.
      relativepath - The relative path.
      filename - The link to convert.
      Returns:
      if external return converted link else return null

    • getExternalLink

      public DocLink getExternalLink(String pkgName, DocPath relativepath, String filename, String memberName)
      Deprecated.

    • link

      public boolean link(String url, String pkglisturl, DocErrorReporter reporter, boolean linkoffline)
      Deprecated.
      Build the extern package list from given URL or the directory path. Flag error if the "-link" or "-linkoffline" option is already used.
      Parameters:
      url - URL or Directory path.
      pkglisturl - This can be another URL for "package-list" or ordinary file.
      reporter - The DocErrorReporter used to report errors.
      linkoffline - True if -linkoffline is used and false if -link is used.

    • toURL

      private URL toURL(String url) throws Extern.Fault
      Deprecated.
      Throws:
      Extern.Fault

    • findPackageItem

      private Extern.Item findPackageItem(String pkgName)
      Deprecated.
      Get the Extern Item object associated with this package name.
      Parameters:
      pkgName - Package name.

    • adjustEndFileSeparator

      private String adjustEndFileSeparator(String url)
      Deprecated.
      If the URL or Directory path is missing end file separator, add that.

    • readPackageListFromURL

      private void readPackageListFromURL(String urlpath, URL pkglisturlpath) throws Extern.Fault
      Deprecated.
      Fetch the URL and read the "package-list" file.
      Parameters:
      urlpath - Path to the packages.
      pkglisturlpath - URL or the path to the "package-list" file.
      Throws:
      Extern.Fault

    • readPackageListFromFile

      private void readPackageListFromFile(String path, DocFile pkgListPath) throws Extern.Fault
      Deprecated.
      Read the "package-list" file which is available locally.
      Parameters:
      path - URL or directory path to the packages.
      pkgListPath - Path to the local "package-list" file.
      Throws:
      Extern.Fault

    • readPackageList

      private void readPackageList(InputStream input, String path, boolean relative) throws IOException
      Deprecated.
      Read the file "package-list" and for each package name found, create Extern object and associate it with the package name in the map.
      Parameters:
      input - InputStream from the "package-list" file.
      path - URL or the directory path to the packages.
      relative - Is path relative?
      Throws:
      IOException

    • isUrl

      public boolean isUrl(String urlCandidate)
      Deprecated.