OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.HtmlLinkFactory

Modifier and Type	Field and Description
private final DocPaths	docPaths
private final HtmlDocletWriter	m_writer
private final Utils	utils

Access	Constructor and Description
public	HtmlLinkFactory(HtmlDocletWriter the HTML doclet writer writer) Constructs a new link factory.

Method Summary

Modifier and Type	Method and Description
private void	addSuperscript(Content the content to add to content, Set<Utils.ElementFlag> the flags flags, DocPath file name to link to, or null if no local link target fileName, TypeElement external type to link to, or null if no external link typeElement, Element preview link target element previewTarget, ExecutableElement restricted link target element restrictedTarget) Adds PREVIEW and RESTRICTED superscript labels.
private HtmlLinkInfo	getBoundsLinkInfo(HtmlLinkInfo linkInfo, TypeMirror bound)
protected Content	Returns: the link for the given class. getClassLink(HtmlLinkInfo the information about the link to construct linkInfo) Returns a link to the given class.
private String	Returns: the tool tip for the appropriate class. getClassToolTip(TypeElement the class to get the tool tip for. typeElement, boolean true if link target is a type parameter isTypeParamLink) Given a class, return the appropriate tool tip.
public Content	Returns: the link. getLink(HtmlLinkInfo the information about the link. linkInfo) Constructs a link from the given link information.
private DocPath	getPath(HtmlLinkInfo the information about the link. linkInfo) Return path to the given file name in the given package.
private Content	Returns: superscript content getSuperscript(DocPath local file name to link to, or null if no local link target fileName, TypeElement external type to link to, or null if no external link typeElement, HtmlId the id fragment to link to id, Content the label content label) Returns PREVIEW or RESTRICTED superscript as either local or external link or as plain text.
public Content	Returns: the links to the type annotations getTypeAnnotationLinks(HtmlLinkInfo the information about the link to construct linkInfo) Returns links to the type annotations.
protected Content	Returns: the links to the type parameters getTypeParameterLinks(HtmlLinkInfo the information about the link to construct linkInfo) Returns links to the type parameters.
protected Content	Returns: a new instance of a content object newContent() Returns a new instance of a content object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

docPaths	back to summary
private final DocPaths docPaths

m_writer	back to summary
private final HtmlDocletWriter m_writer

utils	back to summary
private final Utils utils

HtmlLinkFactory	back to summary
public HtmlLinkFactory(HtmlDocletWriter writer) Constructs a new link factory. Parameters writer:HtmlDocletWriter the HTML doclet writer

Method Detail

addSuperscript	back to summary
private void addSuperscript(Content content, Set<Utils.ElementFlag> flags, DocPath fileName, TypeElement typeElement, Element previewTarget, ExecutableElement restrictedTarget) Adds PREVIEW and RESTRICTED superscript labels. Depending on the parameter values, labels will be formatted as local or external links or plain text. Parameters content:Content the content to add to flags:Set<Utils.ElementFlag> the flags fileName:DocPath file name to link to, or null if no local link target typeElement:TypeElement external type to link to, or null if no external link previewTarget:Element preview link target element restrictedTarget:ExecutableElement restricted link target element

addSuperscript

back to summary

private void addSuperscript(Content content, Set<Utils.ElementFlag> flags, DocPath fileName, TypeElement typeElement, Element previewTarget, ExecutableElement restrictedTarget)

Adds PREVIEW and RESTRICTED superscript labels. Depending on the parameter values, labels will be formatted as local or external links or plain text.

Parameters

content:Content: the content to add to
flags:Set<Utils.ElementFlag>: the flags
fileName:DocPath: file name to link to, or null if no local link target
typeElement:TypeElement: external type to link to, or null if no external link
previewTarget:Element: preview link target element
restrictedTarget:ExecutableElement: restricted link target element

getBoundsLinkInfo	back to summary
private HtmlLinkInfo getBoundsLinkInfo(HtmlLinkInfo linkInfo, TypeMirror bound)

getClassLink	back to summary
protected Content getClassLink(HtmlLinkInfo linkInfo) Returns a link to the given class. Parameters linkInfo:HtmlLinkInfo the information about the link to construct Returns:Content the link for the given class.

getClassLink

back to summary

protected Content getClassLink(HtmlLinkInfo linkInfo)

Returns a link to the given class.

Parameters

linkInfo:HtmlLinkInfo: the information about the link to construct

Returns:Content

the link for the given class.

getClassToolTip	back to summary
private String getClassToolTip(TypeElement typeElement, boolean isTypeParamLink) Given a class, return the appropriate tool tip. Parameters typeElement:TypeElement the class to get the tool tip for. isTypeParamLink:boolean true if link target is a type parameter Returns:String the tool tip for the appropriate class.

getClassToolTip

back to summary

private String getClassToolTip(TypeElement typeElement, boolean isTypeParamLink)

Given a class, return the appropriate tool tip.

Parameters

typeElement:TypeElement: the class to get the tool tip for.
isTypeParamLink:boolean: true if link target is a type parameter

Returns:String

the tool tip for the appropriate class.

getLink	back to summary
public Content getLink(HtmlLinkInfo linkInfo) Constructs a link from the given link information. Parameters linkInfo:HtmlLinkInfo the information about the link. Returns:Content the link.

getLink

back to summary

public Content getLink(HtmlLinkInfo linkInfo)

Constructs a link from the given link information.

Parameters

linkInfo:HtmlLinkInfo: the information about the link.

Returns:Content

the link.

getPath	back to summary
private DocPath getPath(HtmlLinkInfo linkInfo) 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:HtmlLinkInfo the information about the link.

getPath

back to summary

private DocPath getPath(HtmlLinkInfo linkInfo)

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:HtmlLinkInfo: the information about the link.

getSuperscript	back to summary
private Content getSuperscript(DocPath fileName, TypeElement typeElement, HtmlId id, Content label) Returns PREVIEW or RESTRICTED superscript as either local or external link or as plain text. Parameters fileName:DocPath local file name to link to, or null if no local link target typeElement:TypeElement external type to link to, or null if no external link id:HtmlId the id fragment to link to label:Content the label content Returns:Content superscript content

getSuperscript

back to summary

private Content getSuperscript(DocPath fileName, TypeElement typeElement, HtmlId id, Content label)

Returns PREVIEW or RESTRICTED superscript as either local or external link or as plain text.

Parameters

fileName:DocPath: local file name to link to, or null if no local link target
typeElement:TypeElement: external type to link to, or null if no external link
id:HtmlId: the id fragment to link to
label:Content: the label content

Returns:Content

superscript content

getTypeAnnotationLinks	back to summary
public Content getTypeAnnotationLinks(HtmlLinkInfo linkInfo) Returns links to the type annotations. Parameters linkInfo:HtmlLinkInfo the information about the link to construct Returns:Content the links to the type annotations

getTypeAnnotationLinks

back to summary

public Content getTypeAnnotationLinks(HtmlLinkInfo linkInfo)

Returns links to the type annotations.

Parameters

linkInfo:HtmlLinkInfo: the information about the link to construct

Returns:Content

the links to the type annotations

getTypeParameterLinks	back to summary
protected Content getTypeParameterLinks(HtmlLinkInfo linkInfo) Returns links to the type parameters. Parameters linkInfo:HtmlLinkInfo the information about the link to construct Returns:Content the links to the type parameters

getTypeParameterLinks

back to summary

protected Content getTypeParameterLinks(HtmlLinkInfo linkInfo)

Returns links to the type parameters.

Parameters

linkInfo:HtmlLinkInfo: the information about the link to construct

Returns:Content

the links to the type parameters

newContent	back to summary
protected Content newContent() Returns a new instance of a content object. Returns:Content a new instance of a content object

newContent

back to summary

protected Content newContent()

Returns a new instance of a content object.

Returns:Content: a new instance of a content object

public Class HtmlLinkFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail