Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class LinkFactoryImpl

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.links.LinkFactory

gw.gosudoc.com.sun.tools.doclets.formats.html.LinkFactoryImpl

@Deprecated
public class LinkFactoryImpl
extends LinkFactory

Deprecated.

A factory that returns a link given the information about it.

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.

Since:

1.5

Field Summary

Fields

Modifier and Type	Field	Description
private HtmlDocletWriter	m_writer	Deprecated.

Constructor Summary

Constructors

Constructor	Description
LinkFactoryImpl(HtmlDocletWriter writer)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected Content	getClassLink(LinkInfo linkInfo)	Deprecated. Return the link to the given class.
private java.lang.String	getClassToolTip(ClassDoc classDoc, boolean isTypeLink)	Deprecated. Given a class, return the appropriate tool tip.
private DocPath	getPath(LinkInfoImpl linkInfo)	Deprecated. Return path to the given file name in the given package.
protected Content	getTypeAnnotationLink(LinkInfo linkInfo, AnnotationDesc annotation)	Deprecated.
Content	getTypeAnnotationLinks(LinkInfo linkInfo)	Deprecated.
protected Content	getTypeParameterLink(LinkInfo linkInfo, Type typeParam)	Deprecated. Return the link to the given type parameter.
protected Content	newContent()	Deprecated. Return an empty instance of a content object.

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.links.LinkFactory

getLink, getTypeParameterLinks, getTypeParameterLinks

Methods inherited from class java.lang.Object

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

Field Detail

m_writer

private HtmlDocletWriter m_writer

Deprecated.

Constructor Detail

LinkFactoryImpl

public LinkFactoryImpl(HtmlDocletWriter writer)

Deprecated.

Method Detail

newContent

protected Content newContent()

Deprecated.

Return an empty instance of a content object.

Specified by:

newContent in class LinkFactory

Returns:

an empty instance of a content object.

getClassLink

protected Content getClassLink(LinkInfo linkInfo)

Deprecated.

Return the link to the given class.

Specified by:

getClassLink in class LinkFactory

Parameters:

linkInfo - the information about the link to construct.

Returns:

the link for the given class.

getTypeParameterLink

protected Content getTypeParameterLink(LinkInfo linkInfo,
                                       Type typeParam)

Deprecated.

Return the link to the given type parameter.

Specified by:

getTypeParameterLink in class LinkFactory

Parameters:

linkInfo - the information about the link to construct.

typeParam - the type parameter to link to.

getTypeAnnotationLink

protected Content getTypeAnnotationLink(LinkInfo linkInfo,
                                        AnnotationDesc annotation)

Deprecated.

Specified by:

getTypeAnnotationLink in class LinkFactory

getTypeAnnotationLinks

public Content getTypeAnnotationLinks(LinkInfo linkInfo)

Deprecated.

Overrides:

getTypeAnnotationLinks in class LinkFactory

getClassToolTip

private java.lang.String getClassToolTip(ClassDoc classDoc,
                                         boolean isTypeLink)

Deprecated.

Given a class, return the appropriate tool tip.

Parameters:

classDoc - the class to get the tool tip for.

Returns:

the tool tip for the appropriate class.

getPath

private DocPath getPath(LinkInfoImpl linkInfo)

Deprecated.

Return path to the given file name in the given package. So if the name passed is "Object.html" and the name of the package is "java.lang", and if the relative path is "../.." then returned string will be "../../java/lang/Object.html"

Parameters:

linkInfo - the information about the link.