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 java.lang.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	Extern.Fault	Deprecated.
private class	Extern.Item	Deprecated. Stores the info for one external doc set

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration	Deprecated. The global configuration information for this run.
private boolean	linkoffline	Deprecated. True if we are using -linkoffline and false if -link is used instead.
private java.util.Map<java.lang.String,Extern.Item>	packageToItemMap	Deprecated. Map package names onto Extern Item objects.

Constructor Summary

Constructors

Constructor	Description
Extern(Configuration configuration)	Deprecated.

Method Summary

Modifier and Type	Method	Description
private java.lang.String	adjustEndFileSeparator(java.lang.String url)	Deprecated. If the URL or Directory path is missing end file separator, add that.
private Extern.Item	findPackageItem(java.lang.String pkgName)	Deprecated. Get the Extern Item object associated with this package name.
DocLink	getExternalLink(java.lang.String pkgName, DocPath relativepath, java.lang.String filename)	Deprecated. Convert a link to be an external link if appropriate.
DocLink	getExternalLink(java.lang.String pkgName, DocPath relativepath, java.lang.String filename, java.lang.String memberName)	Deprecated.
boolean	isExternal(ProgramElementDoc doc)	Deprecated. Determine if a doc item is externally documented.
boolean	isUrl(java.lang.String urlCandidate)	Deprecated.
boolean	link(java.lang.String url, java.lang.String pkglisturl, DocErrorReporter reporter, boolean linkoffline)	Deprecated. Build the extern package list from given URL or the directory path.
private void	readPackageList(java.io.InputStream input, java.lang.String path, boolean relative)	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.
private void	readPackageListFromFile(java.lang.String path, DocFile pkgListPath)	Deprecated. Read the "package-list" file which is available locally.
private void	readPackageListFromURL(java.lang.String urlpath, java.net.URL pkglisturlpath)	Deprecated. Fetch the URL and read the "package-list" file.
private java.net.URL	toURL(java.lang.String url)	Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

packageToItemMap

private java.util.Map<java.lang.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 Detail

Extern

public Extern(Configuration configuration)

Deprecated.

Method Detail

isExternal

public boolean isExternal(ProgramElementDoc doc)

Deprecated.

Determine if a doc item is externally documented.

Parameters:

doc - A ProgramElementDoc.

getExternalLink

public DocLink getExternalLink(java.lang.String pkgName,
                               DocPath relativepath,
                               java.lang.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(java.lang.String pkgName,
                               DocPath relativepath,
                               java.lang.String filename,
                               java.lang.String memberName)

Deprecated.

link

public boolean link(java.lang.String url,
                    java.lang.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 java.net.URL toURL(java.lang.String url)
                    throws Extern.Fault

Deprecated.

Throws:

Extern.Fault

findPackageItem

private Extern.Item findPackageItem(java.lang.String pkgName)

Deprecated.

Get the Extern Item object associated with this package name.

Parameters:

pkgName - Package name.

adjustEndFileSeparator

private java.lang.String adjustEndFileSeparator(java.lang.String url)

Deprecated.

If the URL or Directory path is missing end file separator, add that.

readPackageListFromURL

private void readPackageListFromURL(java.lang.String urlpath,
                                    java.net.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(java.lang.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(java.io.InputStream input,
                             java.lang.String path,
                             boolean relative)
                      throws java.io.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:

java.io.IOException

isUrl

public boolean isUrl(java.lang.String urlCandidate)

Deprecated.