org.freehep.tools.doclet
Class Extern

java.lang.Object
  org.freehep.tools.doclet.Extern

public class Extern

extends Object

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.

Author:

Atul M Dambalkar, Robert Field

Source Code:

Extern.java

Constructor Summary

Extern(ConfigurationStandard configuration)

Method Summary

String	getExternalLink(String pkgName, String relativepath, String link) Convert a link to be an external link if appropriate.
boolean	isExternal(com.sun.javadoc.ProgramElementDoc doc) Determine if a doc item is externally documented.
boolean	isUrl(String urlCandidate)
com.sun.tools.doclets.MessageRetriever	msg()
boolean	url(String url, String pkglisturl, com.sun.javadoc.DocErrorReporter reporter, boolean linkoffline) 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 Detail

Extern

public Extern(ConfigurationStandard configuration)

Method Detail

isExternal

public boolean isExternal(com.sun.javadoc.ProgramElementDoc doc)

Determine if a doc item is externally documented.

Parameters:

doc - A ProgramElementDoc.

getExternalLink

public String getExternalLink(String pkgName,
                              String relativepath,
                              String link)

Convert a link to be an external link if appropriate.

Parameters:

pkgName - The package name.

relativepath - The relative path.

link - The link to convert.

Returns:

if external return converted link else return null

url

public boolean url(String url,
                   String pkglisturl,
                   com.sun.javadoc.DocErrorReporter reporter,
                   boolean linkoffline)

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 isused and false if -link is used.

msg

public com.sun.tools.doclets.MessageRetriever msg()

isUrl

public boolean isUrl(String urlCandidate)