Modifier and Type	Class and Description
public static enum	HtmlLinkInfo.Kind Enumeration of different kinds of links.

Modifier and Type	Field and Description
private boolean	addLineBreakOpportunitiesInTypeParameters
private final HtmlConfiguration	configuration
private HtmlLinkInfo.Kind	context
private ExecutableElement	executableElement
private String	fragment
private boolean	isVarArg
private Content	label
private boolean	linkToSelf
private boolean	linkTypeParameters
private boolean	showTypeBounds
private boolean	showTypeParameterAnnotations
private boolean	skipPreview
private HtmlStyle	style
private Element	targetMember
private String	title
private TypeMirror	type
private TypeElement	typeElement

Access	Constructor and Description
public	HtmlLinkInfo(HtmlConfiguration the configuration data for the doclet configuration, HtmlLinkInfo.Kind the context of the link. context, ExecutableElement the member to link to. ee) Construct a LinkInfo object.
public	HtmlLinkInfo(HtmlConfiguration the configuration data for the doclet configuration, HtmlLinkInfo.Kind the context of the link. context, TypeElement the class to link to. typeElement) Construct a LinkInfo object.
public	HtmlLinkInfo(HtmlConfiguration the configuration data for the doclet configuration, HtmlLinkInfo.Kind the context of the link. context, TypeMirror the class to link to. type) Construct a LinkInfo object.

Method Summary

Modifier and Type	Method and Description
public HtmlLinkInfo	Returns: this object addLineBreakOpportunitiesInTypeParameters(boolean the new value addLineBreakOpportunities) Sets the addLineBreakOpportunitiesInTypeParameters flag for this link.
public boolean	Returns: true if line break opportunities should be added to type parameters addLineBreakOpportunitiesInTypeParameters() Returns true if line break opportunities should be added to type parameters.
public HtmlLinkInfo	Returns: the new link info forType(TypeMirror the type mirror type) Creates a copy of this HtmlLinkInfo instance with a different TypeMirror.
public HtmlLinkInfo	Returns: this object fragment(String the new fragment value fragment) Set the fragment specifier for the link.
public Content	Returns: the label for this class link. getClassLinkLabel(BaseConfiguration the current configuration of the doclet. configuration) Return the label for this class link.
public HtmlLinkInfo.Kind	Returns: the link context getContext() Returns the link context.
public ExecutableElement	getExecutableElement() The executable element we want to link to.
public String	Returns: the fragment of the link getFragment() Returns the fragment of the link.
public Content	Returns: the label for the link getLabel() Returns the label for the link.
public HtmlStyle	Returns: the optional style for the link getStyle() Returns the optional style for the link.
public Element	Returns: the member this link points to (if any) getTargetMember() Returns the member this link points to (if any).
public String	Returns: the value of the title attribute getTitle() Returns the value of the title attribute.
public TypeMirror	getType() The Type we want to link to.
public TypeElement	getTypeElement() The class we want to link to.
public boolean	Returns: true if this link is linkable and false if we can't link to the desired place. isLinkable() Return true if this link is linkable and false if we can't link to the desired place.
public boolean	Returns: `true` if the link target is the top level page or one of its summary sections isPageOrSummaryLink() Returns `true` if the link target is the top level page or one of its summary sections.
public boolean	Returns: true iff the preview flags should be skipped for this link isSkipPreview() Returns true iff the preview flags should be skipped for this link.
public boolean	Returns: true if this is a link to a vararg member isVarArg() Returns true if this is a link to a vararg member.
public HtmlLinkInfo	Returns: this object label(CharSequence plain-text label for the link label) Set the label for the link.
public HtmlLinkInfo	Returns: this object label(Content the new value label) Set the label for the link.
public HtmlLinkInfo	Returns: this object linkToSelf(boolean the new value linkToSelf) Set the linkToSelf flag for this link.
public boolean	Returns: true if we should generate links to the current page linkToSelf() Returns true if we should generate links to the current page.
public boolean	Returns: true if type parameters should be rendered as links linkTypeParameters() Returns true if type parameters should be rendered as links.
protected Content	Returns: a new instance of a content object newContent() Returns a new instance of a content object.
private void	setContext(HtmlLinkInfo.Kind the context id to set. c) This method sets the link attributes to the appropriate values based on the context.
public void	setTypeElement(TypeElement the new typeElement object typeElement) Sets the typeElement
public void	showTypeBounds(boolean the new value showTypeBounds) Set the showTypeBounds flag for this link
public boolean	Returns: true if we should print the type bounds for the type parameter showTypeBounds() Returns true if we should print the type bounds for the type parameter.
public HtmlLinkInfo	Returns: this object showTypeParameterAnnotations(boolean the new value showTypeParameterAnnotations) Set the showTypeParameterAnnotations flag for this link.
public boolean	Returns: true if annotations on type parameters should be shown showTypeParameterAnnotations() Returns true if annotations on type parameters should be shown.
public boolean	Returns: true if type parameter links should be included showTypeParameters() Returns true if links to declared types should include type parameters.
public HtmlLinkInfo	Returns: this object skipPreview(boolean the new value skipPreview) Set whether or not the preview flags should be skipped for this link.
public HtmlLinkInfo	Returns: this object style(HtmlStyle the new style value style) Sets the style to be used for the link.
public HtmlLinkInfo	Returns: this object targetMember(Element the new member value el) Set the member this link points to (if any).
public HtmlLinkInfo	Returns: this object title(String the value of the title attribute title) Sets the title attribute for the link.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public HtmlLinkInfo	Returns: this object varargs(boolean the new value varargs) Set whether or not this is a link to a varargs parameter.

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

Field Detail

addLineBreakOpportunitiesInTypeParameters	back to summary
private boolean addLineBreakOpportunitiesInTypeParameters

configuration	back to summary
private final HtmlConfiguration configuration

context	back to summary
private HtmlLinkInfo.Kind context

executableElement	back to summary
private ExecutableElement executableElement

fragment	back to summary
private String fragment

isVarArg	back to summary
private boolean isVarArg

label	back to summary
private Content label

linkToSelf	back to summary
private boolean linkToSelf

linkTypeParameters	back to summary
private boolean linkTypeParameters

showTypeBounds	back to summary
private boolean showTypeBounds

showTypeParameterAnnotations	back to summary
private boolean showTypeParameterAnnotations

skipPreview	back to summary
private boolean skipPreview

style	back to summary
private HtmlStyle style

targetMember	back to summary
private Element targetMember

title	back to summary
private String title

type	back to summary
private TypeMirror type

typeElement	back to summary
private TypeElement typeElement

Constructor Detail

HtmlLinkInfo	back to summary
public HtmlLinkInfo(HtmlConfiguration configuration, HtmlLinkInfo.Kind context, ExecutableElement ee) Construct a LinkInfo object. Parameters configuration:HtmlConfiguration the configuration data for the doclet context:HtmlLinkInfo.Kind the context of the link. ee:ExecutableElement the member to link to.

HtmlLinkInfo

back to summary

public HtmlLinkInfo(HtmlConfiguration configuration, HtmlLinkInfo.Kind context, ExecutableElement ee)

Construct a LinkInfo object.

Parameters

configuration:HtmlConfiguration: the configuration data for the doclet
context:HtmlLinkInfo.Kind: the context of the link.
ee:ExecutableElement: the member to link to.

HtmlLinkInfo	back to summary
public HtmlLinkInfo(HtmlConfiguration configuration, HtmlLinkInfo.Kind context, TypeElement typeElement) Construct a LinkInfo object. Parameters configuration:HtmlConfiguration the configuration data for the doclet context:HtmlLinkInfo.Kind the context of the link. typeElement:TypeElement the class to link to.

HtmlLinkInfo

back to summary

public HtmlLinkInfo(HtmlConfiguration configuration, HtmlLinkInfo.Kind context, TypeElement typeElement)

Construct a LinkInfo object.

Parameters

configuration:HtmlConfiguration: the configuration data for the doclet
context:HtmlLinkInfo.Kind: the context of the link.
typeElement:TypeElement: the class to link to.

HtmlLinkInfo	back to summary
public HtmlLinkInfo(HtmlConfiguration configuration, HtmlLinkInfo.Kind context, TypeMirror type) Construct a LinkInfo object. Parameters configuration:HtmlConfiguration the configuration data for the doclet context:HtmlLinkInfo.Kind the context of the link. type:TypeMirror the class to link to.

HtmlLinkInfo

back to summary

public HtmlLinkInfo(HtmlConfiguration configuration, HtmlLinkInfo.Kind context, TypeMirror type)

Construct a LinkInfo object.

Parameters

configuration:HtmlConfiguration: the configuration data for the doclet
context:HtmlLinkInfo.Kind: the context of the link.
type:TypeMirror: the class to link to.

Method Detail

addLineBreakOpportunitiesInTypeParameters	back to summary
public HtmlLinkInfo addLineBreakOpportunitiesInTypeParameters(boolean addLineBreakOpportunities) Sets the addLineBreakOpportunitiesInTypeParameters flag for this link. Parameters addLineBreakOpportunities:boolean the new value Returns:HtmlLinkInfo this object

addLineBreakOpportunitiesInTypeParameters

back to summary

public HtmlLinkInfo addLineBreakOpportunitiesInTypeParameters(boolean addLineBreakOpportunities)

Sets the addLineBreakOpportunitiesInTypeParameters flag for this link.

Parameters

addLineBreakOpportunities:boolean: the new value

Returns:HtmlLinkInfo

this object

addLineBreakOpportunitiesInTypeParameters	back to summary
public boolean addLineBreakOpportunitiesInTypeParameters() Returns true if line break opportunities should be added to type parameters. Returns:boolean true if line break opportunities should be added to type parameters

addLineBreakOpportunitiesInTypeParameters

back to summary

public boolean addLineBreakOpportunitiesInTypeParameters()

Returns true if line break opportunities should be added to type parameters.

Returns:boolean: true if line break opportunities should be added to type parameters

forType	back to summary
public HtmlLinkInfo forType(TypeMirror type) Creates a copy of this HtmlLinkInfo instance with a different TypeMirror. This is used for contained types such as type parameters or array components. Parameters type:TypeMirror the type mirror Returns:HtmlLinkInfo the new link info

forType

back to summary

public HtmlLinkInfo forType(TypeMirror type)

Creates a copy of this HtmlLinkInfo instance with a different TypeMirror. This is used for contained types such as type parameters or array components.

Parameters

type:TypeMirror: the type mirror

Returns:HtmlLinkInfo

the new link info

fragment	back to summary
public HtmlLinkInfo fragment(String fragment) Set the fragment specifier for the link. Parameters fragment:String the new fragment value Returns:HtmlLinkInfo this object

fragment

back to summary

public HtmlLinkInfo fragment(String fragment)

Set the fragment specifier for the link.

Parameters

fragment:String: the new fragment value

Returns:HtmlLinkInfo

this object

getClassLinkLabel	back to summary
public Content getClassLinkLabel(BaseConfiguration configuration) Return the label for this class link. Parameters configuration:BaseConfiguration the current configuration of the doclet. Returns:Content the label for this class link.

getClassLinkLabel

back to summary

public Content getClassLinkLabel(BaseConfiguration configuration)

Return the label for this class link.

Parameters

configuration:BaseConfiguration: the current configuration of the doclet.

Returns:Content

the label for this class link.

getContext	back to summary
public HtmlLinkInfo.Kind getContext() Returns the link context. Returns:HtmlLinkInfo.Kind the link context

getContext

back to summary

public HtmlLinkInfo.Kind getContext()

Returns the link context.

Returns:HtmlLinkInfo.Kind: the link context

getExecutableElement	back to summary
public ExecutableElement getExecutableElement() The executable element we want to link to. Null if we are not linking to an executable element.

getFragment	back to summary
public String getFragment() Returns the fragment of the link. Returns:String the fragment of the link

getFragment

back to summary

public String getFragment()

Returns the fragment of the link.

Returns:String: the fragment of the link

getLabel	back to summary
public Content getLabel() Returns the label for the link. Returns:Content the label for the link

getLabel

back to summary

public Content getLabel()

Returns the label for the link.

Returns:Content: the label for the link

getStyle	back to summary
public HtmlStyle getStyle() Returns the optional style for the link. Returns:HtmlStyle the optional style for the link

getStyle

back to summary

public HtmlStyle getStyle()

Returns the optional style for the link.

Returns:HtmlStyle: the optional style for the link

getTargetMember	back to summary
public Element getTargetMember() Returns the member this link points to (if any). Returns:Element the member this link points to (if any)

getTargetMember

back to summary

public Element getTargetMember()

Returns the member this link points to (if any).

Returns:Element: the member this link points to (if any)

getTitle	back to summary
public String getTitle() Returns the value of the title attribute. Returns:String the value of the title attribute

getTitle

back to summary

public String getTitle()

Returns the value of the title attribute.

Returns:String: the value of the title attribute

getType	back to summary
public TypeMirror getType() The Type we want to link to. Null if we are not linking to a type.

getTypeElement	back to summary
public TypeElement getTypeElement() The class we want to link to. Null if we are not linking to a class.

isLinkable	back to summary
public boolean isLinkable() Return true if this link is linkable and false if we can't link to the desired place. Returns:boolean true if this link is linkable and false if we can't link to the desired place.

isLinkable

back to summary

public boolean isLinkable()

Return true if this link is linkable and false if we can't link to the desired place.

Returns:boolean: true if this link is linkable and false if we can't link to the desired place.

isPageOrSummaryLink back to summary

isPageOrSummaryLink	back to summary
public boolean isPageOrSummaryLink() Returns `true` if the link target is the top level page or one of its summary sections. Returns:boolean `true` if the link target is the top level page or one of its summary sections

public boolean isPageOrSummaryLink()

Returns true if the link target is the top level page or one of its summary sections.

Returns:boolean: true if the link target is the top level page or one of its summary sections

isSkipPreview	back to summary
public boolean isSkipPreview() Returns true iff the preview flags should be skipped for this link. Returns:boolean true iff the preview flags should be skipped for this link

isSkipPreview

back to summary

public boolean isSkipPreview()

Returns true iff the preview flags should be skipped for this link.

Returns:boolean: true iff the preview flags should be skipped for this link

isVarArg	back to summary
public boolean isVarArg() Returns true if this is a link to a vararg member. Returns:boolean true if this is a link to a vararg member

isVarArg

back to summary

public boolean isVarArg()

Returns true if this is a link to a vararg member.

Returns:boolean: true if this is a link to a vararg member

label	back to summary
public HtmlLinkInfo label(CharSequence label) Set the label for the link. Parameters label:CharSequence plain-text label for the link Returns:HtmlLinkInfo this object

label

back to summary

public HtmlLinkInfo label(CharSequence label)

Set the label for the link.

Parameters

label:CharSequence: plain-text label for the link

Returns:HtmlLinkInfo

this object

label	back to summary
public HtmlLinkInfo label(Content label) Set the label for the link. Parameters label:Content the new value Returns:HtmlLinkInfo this object

label

back to summary

public HtmlLinkInfo label(Content label)

Set the label for the link.

Parameters

label:Content: the new value

Returns:HtmlLinkInfo

this object

linkToSelf	back to summary
public HtmlLinkInfo linkToSelf(boolean linkToSelf) Set the linkToSelf flag for this link. Parameters linkToSelf:boolean the new value Returns:HtmlLinkInfo this object

linkToSelf

back to summary

public HtmlLinkInfo linkToSelf(boolean linkToSelf)

Set the linkToSelf flag for this link.

Parameters

linkToSelf:boolean: the new value

Returns:HtmlLinkInfo

this object

linkToSelf	back to summary
public boolean linkToSelf() Returns true if we should generate links to the current page. Returns:boolean true if we should generate links to the current page

linkToSelf

back to summary

public boolean linkToSelf()

Returns true if we should generate links to the current page.

Returns:boolean: true if we should generate links to the current page

linkTypeParameters	back to summary
public boolean linkTypeParameters() Returns true if type parameters should be rendered as links. Returns:boolean true if type parameters should be rendered as links

linkTypeParameters

back to summary

public boolean linkTypeParameters()

Returns true if type parameters should be rendered as links.

Returns:boolean: true if type parameters should be rendered as links

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

setContext	back to summary
private void setContext(HtmlLinkInfo.Kind c) This method sets the link attributes to the appropriate values based on the context. Parameters c:HtmlLinkInfo.Kind the context id to set.

setContext

back to summary

private void setContext(HtmlLinkInfo.Kind c)

This method sets the link attributes to the appropriate values based on the context.

Parameters

c:HtmlLinkInfo.Kind: the context id to set.

setTypeElement	back to summary
public void setTypeElement(TypeElement typeElement) Sets the typeElement Parameters typeElement:TypeElement the new typeElement object

setTypeElement

back to summary

public void setTypeElement(TypeElement typeElement)

Sets the typeElement

Parameters

typeElement:TypeElement: the new typeElement object

showTypeBounds

back to summary

public void showTypeBounds(boolean showTypeBounds)

Set the showTypeBounds flag for this link

Parameters

showTypeBounds:boolean: the new value

showTypeBounds

back to summary

public boolean showTypeBounds()

Returns true if we should print the type bounds for the type parameter.

Returns:boolean: true if we should print the type bounds for the type parameter

showTypeParameterAnnotations

back to summary

public HtmlLinkInfo showTypeParameterAnnotations(boolean showTypeParameterAnnotations)

Set the showTypeParameterAnnotations flag for this link.

Parameters

showTypeParameterAnnotations:boolean: the new value

Returns:HtmlLinkInfo

this object

showTypeParameterAnnotations

back to summary

public boolean showTypeParameterAnnotations()

Returns true if annotations on type parameters should be shown.

Returns:boolean: true if annotations on type parameters should be shown

showTypeParameters

back to summary

public boolean showTypeParameters()

Returns true if links to declared types should include type parameters.

Returns:boolean: true if type parameter links should be included

skipPreview

back to summary

public HtmlLinkInfo skipPreview(boolean skipPreview)

Set whether or not the preview flags should be skipped for this link.

Parameters

skipPreview:boolean: the new value

Returns:HtmlLinkInfo

this object

style

back to summary

public HtmlLinkInfo style(HtmlStyle style)

Sets the style to be used for the link.

Parameters

style:HtmlStyle: the new style value

Returns:HtmlLinkInfo

this object

targetMember

back to summary

public HtmlLinkInfo targetMember(Element el)

Set the member this link points to (if any).

Parameters

el:Element: the new member value

Returns:HtmlLinkInfo

this object

title

back to summary

public HtmlLinkInfo title(String title)

Sets the title attribute for the link.

Parameters

title:String: the value of the title attribute

Returns:HtmlLinkInfo

this object

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

varargs

back to summary

public HtmlLinkInfo varargs(boolean varargs)

Set whether or not this is a link to a varargs parameter.

Parameters

varargs:boolean: the new value

Returns:HtmlLinkInfo

this object

jdk.javadoc.internal.doclets.formats.html back to summary

public final Enum HtmlLinkInfo.Kind

Class Inheritance

extends Enum<HtmlLinkInfo.Kind>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.doclets.formats.html.HtmlLinkInfo.Kind

Enumeration of different kinds of links.

Field Summary

Modifier and Type	Field and Description
public static final HtmlLinkInfo.Kind	LINK_TYPE_PARAMS Link with optional type parameters but no bounds rendered as separate links.
public static final HtmlLinkInfo.Kind	LINK_TYPE_PARAMS_AND_BOUNDS Link with optional type parameters and bounds rendered as separate links.
public static final HtmlLinkInfo.Kind	PLAIN Link with just the element name as label.
public static final HtmlLinkInfo.Kind	SHOW_PREVIEW Link with additional preview flag if appropriate.
public static final HtmlLinkInfo.Kind	SHOW_TYPE_PARAMS Link with optional type parameters appended as plain text.
public static final HtmlLinkInfo.Kind	SHOW_TYPE_PARAMS_AND_BOUNDS Link with optional type parameters and bounds appended as plain text.
public static final HtmlLinkInfo.Kind	SHOW_TYPE_PARAMS_IN_LABEL Link with optional type parameters included in the link label.

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static HtmlLinkInfo.Kind	valueOf(String name)
public static HtmlLinkInfo.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

LINK_TYPE_PARAMS	back to summary
public static final HtmlLinkInfo.Kind LINK_TYPE_PARAMS Link with optional type parameters but no bounds rendered as separate links.

LINK_TYPE_PARAMS_AND_BOUNDS	back to summary
public static final HtmlLinkInfo.Kind LINK_TYPE_PARAMS_AND_BOUNDS Link with optional type parameters and bounds rendered as separate links.

PLAIN	back to summary
public static final HtmlLinkInfo.Kind PLAIN Link with just the element name as label.

SHOW_PREVIEW	back to summary
public static final HtmlLinkInfo.Kind SHOW_PREVIEW Link with additional preview flag if appropriate.

SHOW_TYPE_PARAMS	back to summary
public static final HtmlLinkInfo.Kind SHOW_TYPE_PARAMS Link with optional type parameters appended as plain text.

SHOW_TYPE_PARAMS_AND_BOUNDS	back to summary
public static final HtmlLinkInfo.Kind SHOW_TYPE_PARAMS_AND_BOUNDS Link with optional type parameters and bounds appended as plain text.

SHOW_TYPE_PARAMS_IN_LABEL	back to summary
public static final HtmlLinkInfo.Kind SHOW_TYPE_PARAMS_IN_LABEL Link with optional type parameters included in the link label.

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

valueOf	back to summary
public static HtmlLinkInfo.Kind valueOf(String name)

values	back to summary
public static HtmlLinkInfo.Kind[] values()

public Class HtmlLinkInfo

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum HtmlLinkInfo.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail