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

Field Summary

Modifier and Type	Field and Description
public static final DocPath	ALLCLASSES_INDEX The name of the file for all classes index.
public static final DocPath	ALLPACKAGES_INDEX The name of the file for all packages index.
public static final DocPath	CLASS_USE The name of the sub-directory for storing class usage info.
public static final DocPath	CLIPBOARD_SVG The name of the copy-to-clipboard icon file.
public static final DocPath	CONSTANT_VALUES The name of the file for constant values.
public static final DocPath	DEJAVU_CSS The name of the DejaVu web fonts CSS file.
public static final DocPath	DEJAVU_MD The name of the dejavu file for legal notices.
public static final DocPath	DEPRECATED_LIST The name of the file for deprecated elements.
public static final DocPath	DOC_FILES The name of the subdirectory for user-provided additional documentation files.
public static final DocPath	DOT_DOT
public static final DocPath	DOWN_SVG The name of the downwards pointing angle icon.
public static final DocPath	ELEMENT_LIST The name of the file for the element list.
public static final DocPath	EXTERNAL_SPECS The name of the file for all references to external specifications.
public static final DocPath	FONTS The name of the sub-directory containing font resources.
public static final DocPath	GLASS_SVG The name of the svg file showing a magnifying glass on the search box.
public static final DocPath	HELP_DOC The name of the file for help info.
public static final DocPath	HIGHLIGHT_CSS The name of the syntax highlighting style sheet.
public static final DocPath	HIGHLIGHT_JS The name of the syntax highlighting script file.
public static final DocPath	INDEX The name of the main index file.
public static final DocPath	INDEX_ALL The name of the single index file for all classes.
public static final DocPath	INDEX_FILES The name of the directory for the split index files.
public static final DocPath	LEFT_SVG The name of the left pointing angle icon.
public static final DocPath	LEGAL The name of the directory for legal files.
public static final DocPath	LINK_SVG The name of the link icon file.
public static final DocPath	MEMBER_SEARCH_INDEX_JS The name of the member search index js file.
public static final DocPath	MODULE_SEARCH_INDEX_JS The name of the module search index js file.
private final String	moduleSeparator
public static final DocPath	MOON_SVG The name of the moon icon for the dark theme.
public static final DocPath	NEW_LIST The name of the file for new elements.
public static final DocPath	OVERVIEW_SUMMARY The name of the file for the overview summary.
public static final DocPath	OVERVIEW_TREE The name of the file for the overview tree.
public static final DocPath	PACKAGE_LIST The name of the file for the package list.
public static final DocPath	PACKAGE_SEARCH_INDEX_JS The name of the package search index js file.
public static final DocPath	PACKAGE_SUMMARY The name of the file for the package summary.
public static final DocPath	PACKAGE_TREE The name of the file for the package tree.
public static final DocPath	PACKAGE_USE The name of the file for the package usage info.
public static final DocPath	PREVIEW_LIST The name of the file for preview elements.
public static final DocPath	RESOURCE_FILES The name of the directory for the resource files.
public static final DocPath	RESOURCES The name of the sub-package from which resources are read.
public static final DocPath	RESTRICTED_DOC The name of the doc-file for restricted methods.
public static final DocPath	RESTRICTED_LIST The name of the file for restricted methods.
public static final DocPath	RIGHT_SVG The name of the right pointing angle icon.
public static final DocPath	SCRIPT_FILES The name of the directory for the script files.
public static final DocPath	SCRIPT_JS The name of the default javascript file.
public static final DocPath	SCRIPT_JS_TEMPLATE The name of the template of the default javascript file.
public static final DocPath	SEARCH_JS The name of the search javascript file.
public static final DocPath	SEARCH_JS_TEMPLATE The name of the template for the search javascript file.
public static final DocPath	SEARCH_PAGE The name of the file for search page.
public static final DocPath	SEARCH_TAGS The name of the file for search tags index page.
public static final DocPath	SERIALIZED_FORM The name of the file for the serialized form info.
public static final DocPath	SORT_A_Z_SVG The name of the table of contents toggle icon file.
public static final DocPath	SOURCE_OUTPUT The name of the directory in which HTML versions of the source code are generated.
public static final DocPath	STYLESHEET The name of the default stylesheet.
public static final DocPath	SUN_SVG The name of the sun icon for the light theme.
public static final DocPath	SYSTEM_PROPERTIES The name of the file for all system properties.
public static final DocPath	TAG_SEARCH_INDEX_JS The name of the tag search index js file.
public static final DocPath	TYPE_SEARCH_INDEX_JS The name of the type search index js file.
private final Utils	utils
public static final DocPath	X_SVG The name of the svg file for undo button on the search box.

Constructor Summary

Access	Constructor and Description
public	DocPaths(Utils utils)

Method Summary

Modifier and Type	Method and Description
private DocPath	createModulePath(ModuleElement mdle, String path)
private DocPath	createModulePath(String moduleName, String path)
public DocPath	Returns: the path forClass(TypeElement the type element typeElement) Returns the path for a type element.
public static DocPath	forModule(ModuleElement mdle)
public DocPath	Returns: the path forName(TypeElement the type element typeElement) Returns the path for the simple name of a type element.
public DocPath	Returns: the path forPackage(TypeElement the type element typeElement) Returns the path for the package of a type element.
public DocPath	Returns: the path forPackage(PackageElement the package element pkgElement) Returns the path for a package.
public static DocPath	Returns: the path forRoot(PackageElement the package element pkgElement) Returns the inverse path for a package.
public static DocPath	Returns: the path indexN(int the position in the index n) Generate the name of one of the files in the split index.
public DocPath	Returns: the module documentation path modulePath(ModuleElement the module mdle, String the path to append to the module path path) Returns the path for a file within a module documentation output directory.
public DocPath	Returns: the path moduleSummary(ModuleElement the module mdle) The path for the file for a module's summary page.
public DocPath	Returns: the path moduleSummary(String the module mdleName) The path for the file for a module's summary page.
public DocPath	Returns: the path relativePath(PackageElement the origin of the relative path from, PackageElement the destination of the relative path to) Returns a relative path from one package to another.

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

Field Detail

ALLCLASSES_INDEX	back to summary
public static final DocPath ALLCLASSES_INDEX The name of the file for all classes index.

ALLPACKAGES_INDEX	back to summary
public static final DocPath ALLPACKAGES_INDEX The name of the file for all packages index.

CLASS_USE	back to summary
public static final DocPath CLASS_USE The name of the sub-directory for storing class usage info.

CLIPBOARD_SVG	back to summary
public static final DocPath CLIPBOARD_SVG The name of the copy-to-clipboard icon file.

CONSTANT_VALUES	back to summary
public static final DocPath CONSTANT_VALUES The name of the file for constant values.

DEJAVU_CSS	back to summary
public static final DocPath DEJAVU_CSS The name of the DejaVu web fonts CSS file.

DEJAVU_MD	back to summary
public static final DocPath DEJAVU_MD The name of the dejavu file for legal notices.

DEPRECATED_LIST	back to summary
public static final DocPath DEPRECATED_LIST The name of the file for deprecated elements.

DOC_FILES	back to summary
public static final DocPath DOC_FILES The name of the subdirectory for user-provided additional documentation files.

DOT_DOT	back to summary
public static final DocPath DOT_DOT

DOWN_SVG	back to summary
public static final DocPath DOWN_SVG The name of the downwards pointing angle icon.

ELEMENT_LIST	back to summary
public static final DocPath ELEMENT_LIST The name of the file for the element list.

EXTERNAL_SPECS	back to summary
public static final DocPath EXTERNAL_SPECS The name of the file for all references to external specifications.

FONTS	back to summary
public static final DocPath FONTS The name of the sub-directory containing font resources.

GLASS_SVG	back to summary
public static final DocPath GLASS_SVG The name of the svg file showing a magnifying glass on the search box.

HELP_DOC	back to summary
public static final DocPath HELP_DOC The name of the file for help info.

HIGHLIGHT_CSS	back to summary
public static final DocPath HIGHLIGHT_CSS The name of the syntax highlighting style sheet.

HIGHLIGHT_JS	back to summary
public static final DocPath HIGHLIGHT_JS The name of the syntax highlighting script file.

INDEX	back to summary
public static final DocPath INDEX The name of the main index file.

INDEX_ALL	back to summary
public static final DocPath INDEX_ALL The name of the single index file for all classes.

INDEX_FILES	back to summary
public static final DocPath INDEX_FILES The name of the directory for the split index files.

LEFT_SVG	back to summary
public static final DocPath LEFT_SVG The name of the left pointing angle icon.

LEGAL	back to summary
public static final DocPath LEGAL The name of the directory for legal files.

LINK_SVG	back to summary
public static final DocPath LINK_SVG The name of the link icon file.

MEMBER_SEARCH_INDEX_JS	back to summary
public static final DocPath MEMBER_SEARCH_INDEX_JS The name of the member search index js file.

MODULE_SEARCH_INDEX_JS	back to summary
public static final DocPath MODULE_SEARCH_INDEX_JS The name of the module search index js file.

moduleSeparator	back to summary
private final String moduleSeparator

MOON_SVG	back to summary
public static final DocPath MOON_SVG The name of the moon icon for the dark theme.

NEW_LIST	back to summary
public static final DocPath NEW_LIST The name of the file for new elements.

OVERVIEW_SUMMARY	back to summary
public static final DocPath OVERVIEW_SUMMARY The name of the file for the overview summary.

OVERVIEW_TREE	back to summary
public static final DocPath OVERVIEW_TREE The name of the file for the overview tree.

PACKAGE_LIST	back to summary
public static final DocPath PACKAGE_LIST The name of the file for the package list. This is to support the legacy mode.

PACKAGE_SEARCH_INDEX_JS	back to summary
public static final DocPath PACKAGE_SEARCH_INDEX_JS The name of the package search index js file.

PACKAGE_SUMMARY	back to summary
public static final DocPath PACKAGE_SUMMARY The name of the file for the package summary.

PACKAGE_TREE	back to summary
public static final DocPath PACKAGE_TREE The name of the file for the package tree.

PACKAGE_USE	back to summary
public static final DocPath PACKAGE_USE The name of the file for the package usage info.

PREVIEW_LIST	back to summary
public static final DocPath PREVIEW_LIST The name of the file for preview elements.

RESOURCE_FILES	back to summary
public static final DocPath RESOURCE_FILES The name of the directory for the resource files.

RESOURCES	back to summary
public static final DocPath RESOURCES The name of the sub-package from which resources are read.

RESTRICTED_DOC	back to summary
public static final DocPath RESTRICTED_DOC The name of the doc-file for restricted methods.

RESTRICTED_LIST	back to summary
public static final DocPath RESTRICTED_LIST The name of the file for restricted methods.

RIGHT_SVG	back to summary
public static final DocPath RIGHT_SVG The name of the right pointing angle icon.

SCRIPT_FILES	back to summary
public static final DocPath SCRIPT_FILES The name of the directory for the script files.

SCRIPT_JS	back to summary
public static final DocPath SCRIPT_JS The name of the default javascript file.

SCRIPT_JS_TEMPLATE	back to summary
public static final DocPath SCRIPT_JS_TEMPLATE The name of the template of the default javascript file.

SEARCH_JS	back to summary
public static final DocPath SEARCH_JS The name of the search javascript file.

SEARCH_JS_TEMPLATE	back to summary
public static final DocPath SEARCH_JS_TEMPLATE The name of the template for the search javascript file.

SEARCH_PAGE	back to summary
public static final DocPath SEARCH_PAGE The name of the file for search page.

SEARCH_TAGS	back to summary
public static final DocPath SEARCH_TAGS The name of the file for search tags index page.

SERIALIZED_FORM	back to summary
public static final DocPath SERIALIZED_FORM The name of the file for the serialized form info.

SORT_A_Z_SVG	back to summary
public static final DocPath SORT_A_Z_SVG The name of the table of contents toggle icon file.

SOURCE_OUTPUT	back to summary
public static final DocPath SOURCE_OUTPUT The name of the directory in which HTML versions of the source code are generated.

STYLESHEET	back to summary
public static final DocPath STYLESHEET The name of the default stylesheet.

SUN_SVG	back to summary
public static final DocPath SUN_SVG The name of the sun icon for the light theme.

SYSTEM_PROPERTIES	back to summary
public static final DocPath SYSTEM_PROPERTIES The name of the file for all system properties.

TAG_SEARCH_INDEX_JS	back to summary
public static final DocPath TAG_SEARCH_INDEX_JS The name of the tag search index js file.

TYPE_SEARCH_INDEX_JS	back to summary
public static final DocPath TYPE_SEARCH_INDEX_JS The name of the type search index js file.

utils	back to summary
private final Utils utils

X_SVG	back to summary
public static final DocPath X_SVG The name of the svg file for undo button on the search box.

Constructor Detail

DocPaths	back to summary
public DocPaths(Utils utils)

Method Detail

createModulePath	back to summary
private DocPath createModulePath(ModuleElement mdle, String path)

createModulePath	back to summary
private DocPath createModulePath(String moduleName, String path)

forClass back to summary

public DocPath forClass(TypeElement typeElement)

Returns the path for a type element. For example, if the type element is java.lang.Object, the path is java/lang/Object.html.

Parameters

typeElement:TypeElement: the type element

Returns:DocPath

the path

forModule	back to summary
public static DocPath forModule(ModuleElement mdle)

forName back to summary

public DocPath forName(TypeElement typeElement)

Returns the path for the simple name of a type element. For example, if the type element is java.lang.Object, the path is Object.html.

Parameters

typeElement:TypeElement: the type element

Returns:DocPath

the path

forPackage back to summary

public DocPath forPackage(TypeElement typeElement)

Returns the path for the package of a type element. For example, if the type element is java.lang.Object, the path is java/lang.

Parameters

typeElement:TypeElement: the type element

Returns:DocPath

the path

forPackage back to summary

public DocPath forPackage(PackageElement pkgElement)

Returns the path for a package. For example, if the package is java.lang, the path is java/lang.

Parameters

pkgElement:PackageElement: the package element

Returns:DocPath

the path

forRoot back to summary

public static DocPath forRoot(PackageElement pkgElement)

Returns the inverse path for a package. For example, if the package is java.lang, the inverse path is ../...

Parameters

pkgElement:PackageElement: the package element

Returns:DocPath

the path

indexN

back to summary

public static DocPath indexN(int n)

Generate the name of one of the files in the split index.

Parameters

n:int: the position in the index

Returns:DocPath

the path

modulePath

back to summary

public DocPath modulePath(ModuleElement mdle, String path)

Returns the path for a file within a module documentation output directory.

Parameters

mdle:ModuleElement: the module
path:String: the path to append to the module path

Returns:DocPath

the module documentation path

moduleSummary

back to summary

public DocPath moduleSummary(ModuleElement mdle)

The path for the file for a module's summary page.

Parameters

mdle:ModuleElement: the module

Returns:DocPath

the path

moduleSummary

back to summary

public DocPath moduleSummary(String mdleName)

The path for the file for a module's summary page.

Parameters

mdleName:String: the module

Returns:DocPath

the path

relativePath

back to summary

public DocPath relativePath(PackageElement from, PackageElement to)

Returns a relative path from one package to another.

Parameters

from:PackageElement: the origin of the relative path
to:PackageElement: the destination of the relative path

Returns:DocPath

the path

public Class DocPaths

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail