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.

Author:

Atul M Dambalkar, Robert Field

Constructor Summary

Constructors

Constructor	Description
Extern(Configuration configuration)	Deprecated.

Method Summary

Modifier and Type	Method	Description
DocLink	getExternalLink(String pkgName, DocPath relativepath, String filename)	Deprecated. Convert a link to be an external link if appropriate.
DocLink	getExternalLink(String pkgName, DocPath relativepath, String filename, String memberName)	Deprecated.
boolean	isExternal(ProgramElementDoc doc)	Deprecated. Determine if a doc item is externally documented.
boolean	isUrl(String urlCandidate)	Deprecated.
boolean	link(String url, String pkglisturl, DocErrorReporter reporter, boolean linkoffline)	Deprecated. Build the extern package list from given URL or the directory path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

isUrl

public boolean isUrl(String urlCandidate)

Deprecated.