OpenJDK 27 · jdk.javadoc.internal.doclets.toolkit.util.DocLink

Abstraction for simple relative URIs, consisting of a path and an optional fragment. DocLink objects can be created by the constructors below or from a DocPath using the convenience fragment method.

Modifier and Type	Field and Description
pack-priv final String	fragment
pack-priv final DocPath	path

Constructor Summary

Access	Constructor and Description
public	DocLink(DocPath the path path) Creates a DocLink representing the URI `path`.
public	DocLink(DocPath the path path, String the fragment fragment) Creates a DocLink representing the URI `path#fragment`.
public	DocLink(String the path path, String the fragment fragment) Creates a DocLink representing the URI `path#fragment`.

Method Summary

Modifier and Type	Method and Description
public static DocLink	Returns: the DocLink fragment(String the fragment fragment) Creates a DocLink representing the URI `#fragment`.
private boolean	isAbsoluteURL(DocPath path)
public DocLink	Returns: the DocLink relativizeAgainst(DocPath the base base) Creates a DocLink formed by relativizing the path against a given base.
public String	Returns: the string toString() Overrides java.lang.Object.toString. Returns the link in the form "path#fragment", omitting any empty components.
public DocLink	withFragment(String fragment)

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

Field Detail

fragment	back to summary
pack-priv final String fragment

path	back to summary
pack-priv final DocPath path

Constructor Detail

DocLink back to summary

DocLink	back to summary
public DocLink(DocPath path) Creates a DocLink representing the URI `path`. Parameters path:DocPath the path

public DocLink(DocPath path)

Creates a DocLink representing the URI path.

Parameters

path:DocPath: the path

DocLink back to summary

DocLink	back to summary
public DocLink(DocPath path, String fragment) Creates a DocLink representing the URI `path#fragment`. Any of the component parts may be null. Parameters path:DocPath the path fragment:String the fragment

public DocLink(DocPath path, String fragment)

Creates a DocLink representing the URI path#fragment. Any of the component parts may be null.

Parameters

path:DocPath: the path
fragment:String: the fragment

DocLink back to summary

DocLink	back to summary
public DocLink(String path, String fragment) Creates a DocLink representing the URI `path#fragment`. Any of the component parts may be null. Parameters path:String the path fragment:String the fragment

public DocLink(String path, String fragment)

Creates a DocLink representing the URI path#fragment. Any of the component parts may be null.

Parameters

path:String: the path
fragment:String: the fragment

Method Detail

fragment back to summary

fragment	back to summary
public static DocLink fragment(String fragment) Creates a DocLink representing the URI `#fragment`. Parameters fragment:String the fragment Returns:DocLink the DocLink

public static DocLink fragment(String fragment)

Creates a DocLink representing the URI #fragment.

Parameters

fragment:String: the fragment

Returns:DocLink

the DocLink

isAbsoluteURL	back to summary
private boolean isAbsoluteURL(DocPath path)

relativizeAgainst	back to summary
public DocLink relativizeAgainst(DocPath base) Creates a DocLink formed by relativizing the path against a given base. Parameters base:DocPath the base Returns:DocLink the DocLink

relativizeAgainst

back to summary

public DocLink relativizeAgainst(DocPath base)

Creates a DocLink formed by relativizing the path against a given base.

Parameters

base:DocPath: the base

Returns:DocLink

the DocLink

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the link in the form "path#fragment", omitting any empty components. Returns:String the string Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the link in the form "path#fragment", omitting any empty components.

Returns:String

the string

Annotations

@Override

withFragment	back to summary
public DocLink withFragment(String fragment)

public Class DocLink

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail