| java.lang.Object com.sun.tools.doclets.internal.toolkit.util.Extern
Extern | public class Extern (Code) | | 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 code is not part of an API.
It is implementation that is subject to change.
Do not use it as an API
author: Atul M Dambalkar author: Robert Field |
Method Summary | |
public String | getExternalLink(String pkgName, String relativepath, String link) Convert a link to be an external link if appropriate.
Parameters: pkgName - The package name. Parameters: relativepath - The relative path. Parameters: link - The link to convert. | public boolean | isExternal(ProgramElementDoc doc) Determine if a doc item is externally documented. | public boolean | isUrl(String urlCandidate) | public boolean | url(String url, String pkglisturl, DocErrorReporter reporter, boolean linkoffline) Build the extern package list from given URL or the directory path. |
getExternalLink | public String getExternalLink(String pkgName, String relativepath, String link)(Code) | | Convert a link to be an external link if appropriate.
Parameters: pkgName - The package name. Parameters: relativepath - The relative path. Parameters: link - The link to convert. if external return converted link else return null |
isExternal | public boolean isExternal(ProgramElementDoc doc)(Code) | | Determine if a doc item is externally documented.
Parameters: doc - A ProgramElementDoc. |
url | public boolean url(String url, String pkglisturl, DocErrorReporter reporter, boolean linkoffline)(Code) | | 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. Parameters: pkglisturl - This can be another URL for "package-list" or ordinaryfile. Parameters: reporter - The DocErrorReporter used to report errors. Parameters: linkoffline - True if -linkoffline isused and false if -link is used. |
|
|