de.unkrig.commons.doclet.html

Class Html.ExternalJavadocsLinkMaker

java.lang.Object

de.unkrig.commons.doclet.html.Html.ExternalJavadocsLinkMaker

All Implemented Interfaces:

Html.LinkMaker

Enclosing class:

Html

public static final class Html.ExternalJavadocsLinkMaker
extends java.lang.Object
implements Html.LinkMaker

See the documentation of the '-linkoffline' option of the JAVADOC tool.

Constructor Summary

Constructors

Constructor and Description
ExternalJavadocsLinkMaker(java.util.Map<java.lang.String,java.net.URL> externalJavadocs, Html.LinkMaker delegate)

Method Summary

Modifier and Type	Method and Description
java.lang.String	makeDefaultLabel(com.sun.javadoc.Doc from, com.sun.javadoc.Doc to, com.sun.javadoc.RootDoc rootDoc) Generates the "default label" for the link that refers from the HTML page on which from is described to the place where to is described.
java.lang.String	makeHref(com.sun.javadoc.Doc from, com.sun.javadoc.Doc to, com.sun.javadoc.RootDoc rootDoc) Generates an "href" that refers from the HTML page on which from is described to the HTML page (and possibly the anchor) that describes to.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalJavadocsLinkMaker

public ExternalJavadocsLinkMaker(java.util.Map<java.lang.String,java.net.URL> externalJavadocs,
                                 Html.LinkMaker delegate)

Method Detail

makeHref

@Nullable
public java.lang.String makeHref(com.sun.javadoc.Doc from,
                                            com.sun.javadoc.Doc to,
                                            com.sun.javadoc.RootDoc rootDoc)
                                     throws Longjump

Description copied from interface: Html.LinkMaker

Generates an "href" that refers from the HTML page on which from is described to the HTML page (and possibly the anchor) that describes to.

Specified by:

makeHref in interface Html.LinkMaker

Returns:

null if the bare label should be displayed instead of a link

Throws:

Longjump - A link href could be determined, but for some reason it was forbidden to link there

makeDefaultLabel

public java.lang.String makeDefaultLabel(com.sun.javadoc.Doc from,
                                         com.sun.javadoc.Doc to,
                                         com.sun.javadoc.RootDoc rootDoc)
                                  throws Longjump

Description copied from interface: Html.LinkMaker

Generates the "default label" for the link that refers from the HTML page on which from is described to the place where to is described.

Specified by:

makeDefaultLabel in interface Html.LinkMaker

Throws:

Longjump