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

Field Summary

Modifier and Type	Field and Description
public final Content	allClassesAndInterfacesLabel
public final Content	allImplementedInterfacesLabel
public final Content	allModulesLabel
public final Content	allPackagesLabel
public final Content	allSuperinterfacesLabel
public final Content	also
public final Content	annotateTypeOptionalMemberSummaryLabel
public final Content	annotateTypeRequiredMemberSummaryLabel
public final Content	annotationType
public final Content	annotationTypeDetailsLabel
public final Content	annotationTypeMemberDetail
public final Content	annotationTypeOptionalMemberLabel
public final Content	annotationTypeRequiredMemberLabel
public final Content	annotationtypes
public final Content	annotationTypes
public final Content	classes
public final Content	classLabel
public final Content	constantFieldLabel
public final Content	constantsSummaryTitle
public final Content	constructorDetailsLabel
public final Content	constructorLabel
public final Content	constructors
public final Content	constructorSummaryLabel
public final Content	contentsHeading
public final Content	default_
public final Content	defaultPackageLabel
public final Content	deprecatedAPI
public final Content	deprecatedForRemovalPhrase
public final Content	deprecatedLabel
public final Content	deprecatedPhrase
public final Content	descriptionFromClassLabel
public final Content	descriptionFromInterfaceLabel
public final Content	descriptionLabel
public final Content	detailLabel
public final Content	enclosingClassLabel
public final Content	enclosingInterfaceLabel
public final Content	enum_
public final Content	enumConstantDetailLabel
public final Content	enumConstantLabel
public final Content	enumConstantSummary
public final Content	enums
public final Content	exceptionClass
public final Content	exceptionClasses
public final Content	exportedTo
public final Content	externalSpecifications
public final Content	fieldDetailsLabel
public final Content	fieldLabel
public final Content	fields
public final Content	fieldSummaryLabel
public final Content	fromLabel
public final Content	functionalInterface
public final Content	functionalInterfaceMessage
public final Content	helpLabel
public final Content	helpSubNavLabel
public final Content	hideSidebar
public final Content	hierarchyForAllPackages
public final Content	implementation
public final Content	implementingClassesLabel
public final Content	inClass
public final Content	indexLabel
public final Content	inInterface
public final Content	interfaceLabel
public final Content	interfaces
public final Content	methodDetailLabel
public final Content	methodLabel
public final Content	methods
public final Content	methodSummary
public final Content	modifierAndTypeLabel
public final Content	modifierLabel
public final Content	module_
public final Content	moduleLabel
public final Content	modulesLabel
public final Content	moduleSubNavLabel
public final Content	navAnnotationTypeMember
public final Content	navAnnotationTypeOptionalMember
public final Content	navAnnotationTypeRequiredMember
public final Content	navClassesAndInterfaces
public final Content	navConstructor
public final Content	navDescription
public final Content	navEnum
public final Content	navField
public final Content	navHelpNavigation
public final Content	navHelpPages
private final EnumMap<VisibleMemberTable.Kind, Content>	navLinkLabels
public final Content	navMethod
public final Content	navModules
public final Content	navNested
public final Content	navPackages
public final Content	navProperty
public final Content	navServices
public final Content	nestedClassSummary
public final Content	newAPI
public final Content	newLabel
public final Content	noScriptMessage
public final Content	openedTo
public final Content	openModuleLabel
public final Content	overridesLabel
public final Content	overviewLabel
public final Content	package_
public final Content	packageHierarchies
public final Content	packageLabel
public final Content	packagesLabel
public final Content	packageSubNavLabel
public final Content	packageSummaryLabel
public final Content	parameters
public final Content	previewAPI
public final Content	previewLabel
public final Content	previewMark
public final Content	previewPhrase
public final Content	properties
public final Content	propertyDetailsLabel
public final Content	propertyLabel
public final Content	propertySummaryLabel
public final Content	recordComponents
public final Content	records
public final Content	referencedIn
public final Content	relatedPackages
private final Resources	resources
public final Content	restrictedMark
public final Content	restrictedMethods
public final Content	restrictedPhrase
public final Content	returns
public final Content	searchLabel
public final Content	searchTagsLabel
public final Content	seeAlso
public final Content	serializedForm
public final Content	servicesLabel
public final Content	showSidebar
public final Content	specificationLabel
public final Content	specifiedByLabel
public final Content	subclassesLabel
public final Content	subinterfacesLabel
public final Content	summaryLabel
public final Content	systemPropertiesLabel
public final Content	systemPropertiesSummaryLabel
public final Content	tableOfContentsLabel
public final Content	throws_
public final Content	treeLabel
public final Content	typeLabel
public final Content	typeParameters
public final Content	useLabel
public final Content	valueLabel

Access	Constructor and Description
pack-priv	Contents(HtmlConfiguration the configuration in which to find the resources used to look up resource keys, and other details. configuration) Creates a `Contents` object.

Method Summary

Modifier and Type	Method and Description
public Content	Returns: the string getContent(String the key for the desired string key) Gets a `Content` object, containing the string for a given key in the doclet's resources.
public Content	Returns: the string getContent(String the key for the desired string key, Object string or content argument to be formatted into the result o0) Gets a `Content` object, containing the string for a given key in the doclet's resources, formatted with given arguments.
public Content	Returns: the string getContent(String the key for the desired string key, Object string or content argument to be formatted into the result o0, Object string or content argument to be formatted into the result o1) Gets a `Content` object, containing the string for a given key in the doclet's resources, formatted with given arguments.
public Content	Returns: the string getContent(String the key for the desired string key, Object string or content argument to be formatted into the result o0, Object string or content argument to be formatted into the result o1, Object string or content argument to be formatted into the result o2) Gets a `Content` object, containing the string for a given key in the doclet's resources, formatted with given arguments.
public Content	Returns: a label that describes the VisibleMemberTable kind getNavLinkLabelContent(VisibleMemberTable.Kind the visible member table kind. kind) Returns a label that describes the VisibleMemberTable kind.
private Content	Returns: the string getNonBreakResource(String the key for the desired string key) Gets a `Content` object, containing the string for a given key in the doclet's resources, substituting for any space characters found in the named resource string.
public Content	Returns: the string content getNonBreakString(String the string text) Gets a `Content` object for a string, substituting for any space characters found in the named resource string.
public Content	Returns: the composition join(Content the separator separator, Collection<? extends Content> the items items) Returns content composed of items joined together with the specified separator.

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

Field Detail

allClassesAndInterfacesLabel	back to summary
public final Content allClassesAndInterfacesLabel

allImplementedInterfacesLabel	back to summary
public final Content allImplementedInterfacesLabel

allModulesLabel	back to summary
public final Content allModulesLabel

allPackagesLabel	back to summary
public final Content allPackagesLabel

allSuperinterfacesLabel	back to summary
public final Content allSuperinterfacesLabel

also	back to summary
public final Content also

annotateTypeOptionalMemberSummaryLabel	back to summary
public final Content annotateTypeOptionalMemberSummaryLabel

annotateTypeRequiredMemberSummaryLabel	back to summary
public final Content annotateTypeRequiredMemberSummaryLabel

annotationType	back to summary
public final Content annotationType

annotationTypeDetailsLabel	back to summary
public final Content annotationTypeDetailsLabel

annotationTypeMemberDetail	back to summary
public final Content annotationTypeMemberDetail

annotationTypeOptionalMemberLabel	back to summary
public final Content annotationTypeOptionalMemberLabel

annotationTypeRequiredMemberLabel	back to summary
public final Content annotationTypeRequiredMemberLabel

annotationtypes	back to summary
public final Content annotationtypes

annotationTypes	back to summary
public final Content annotationTypes

classes	back to summary
public final Content classes

classLabel	back to summary
public final Content classLabel

constantFieldLabel	back to summary
public final Content constantFieldLabel

constantsSummaryTitle	back to summary
public final Content constantsSummaryTitle

constructorDetailsLabel	back to summary
public final Content constructorDetailsLabel

constructorLabel	back to summary
public final Content constructorLabel

constructors	back to summary
public final Content constructors

constructorSummaryLabel	back to summary
public final Content constructorSummaryLabel

contentsHeading	back to summary
public final Content contentsHeading

default_	back to summary
public final Content default_

defaultPackageLabel	back to summary
public final Content defaultPackageLabel

deprecatedAPI	back to summary
public final Content deprecatedAPI

deprecatedForRemovalPhrase	back to summary
public final Content deprecatedForRemovalPhrase

deprecatedLabel	back to summary
public final Content deprecatedLabel

deprecatedPhrase	back to summary
public final Content deprecatedPhrase

descriptionFromClassLabel	back to summary
public final Content descriptionFromClassLabel

descriptionFromInterfaceLabel	back to summary
public final Content descriptionFromInterfaceLabel

descriptionLabel	back to summary
public final Content descriptionLabel

detailLabel	back to summary
public final Content detailLabel

enclosingClassLabel	back to summary
public final Content enclosingClassLabel

enclosingInterfaceLabel	back to summary
public final Content enclosingInterfaceLabel

enum_	back to summary
public final Content enum_

enumConstantDetailLabel	back to summary
public final Content enumConstantDetailLabel

enumConstantLabel	back to summary
public final Content enumConstantLabel

enumConstantSummary	back to summary
public final Content enumConstantSummary

enums	back to summary
public final Content enums

exceptionClass	back to summary
public final Content exceptionClass

exceptionClasses	back to summary
public final Content exceptionClasses

exportedTo	back to summary
public final Content exportedTo

externalSpecifications	back to summary
public final Content externalSpecifications

fieldDetailsLabel	back to summary
public final Content fieldDetailsLabel

fieldLabel	back to summary
public final Content fieldLabel

fields	back to summary
public final Content fields

fieldSummaryLabel	back to summary
public final Content fieldSummaryLabel

fromLabel	back to summary
public final Content fromLabel

functionalInterface	back to summary
public final Content functionalInterface

functionalInterfaceMessage	back to summary
public final Content functionalInterfaceMessage

helpLabel	back to summary
public final Content helpLabel

helpSubNavLabel	back to summary
public final Content helpSubNavLabel

hideSidebar	back to summary
public final Content hideSidebar

hierarchyForAllPackages	back to summary
public final Content hierarchyForAllPackages

implementation	back to summary
public final Content implementation

implementingClassesLabel	back to summary
public final Content implementingClassesLabel

inClass	back to summary
public final Content inClass

indexLabel	back to summary
public final Content indexLabel

inInterface	back to summary
public final Content inInterface

interfaceLabel	back to summary
public final Content interfaceLabel

interfaces	back to summary
public final Content interfaces

methodDetailLabel	back to summary
public final Content methodDetailLabel

methodLabel	back to summary
public final Content methodLabel

methods	back to summary
public final Content methods

methodSummary	back to summary
public final Content methodSummary

modifierAndTypeLabel	back to summary
public final Content modifierAndTypeLabel

modifierLabel	back to summary
public final Content modifierLabel

module_	back to summary
public final Content module_

moduleLabel	back to summary
public final Content moduleLabel

modulesLabel	back to summary
public final Content modulesLabel

moduleSubNavLabel	back to summary
public final Content moduleSubNavLabel

navAnnotationTypeMember	back to summary
public final Content navAnnotationTypeMember

navAnnotationTypeOptionalMember	back to summary
public final Content navAnnotationTypeOptionalMember

navAnnotationTypeRequiredMember	back to summary
public final Content navAnnotationTypeRequiredMember

navClassesAndInterfaces	back to summary
public final Content navClassesAndInterfaces

navConstructor	back to summary
public final Content navConstructor

navDescription	back to summary
public final Content navDescription

navEnum	back to summary
public final Content navEnum

navField	back to summary
public final Content navField

navHelpNavigation	back to summary
public final Content navHelpNavigation

navHelpPages	back to summary
public final Content navHelpPages

navLinkLabels	back to summary
private final EnumMap<VisibleMemberTable.Kind, Content> navLinkLabels

navMethod	back to summary
public final Content navMethod

navModules	back to summary
public final Content navModules

navNested	back to summary
public final Content navNested

navPackages	back to summary
public final Content navPackages

navProperty	back to summary
public final Content navProperty

navServices	back to summary
public final Content navServices

nestedClassSummary	back to summary
public final Content nestedClassSummary

newAPI	back to summary
public final Content newAPI

newLabel	back to summary
public final Content newLabel

noScriptMessage	back to summary
public final Content noScriptMessage

openedTo	back to summary
public final Content openedTo

openModuleLabel	back to summary
public final Content openModuleLabel

overridesLabel	back to summary
public final Content overridesLabel

overviewLabel	back to summary
public final Content overviewLabel

package_	back to summary
public final Content package_

packageHierarchies	back to summary
public final Content packageHierarchies

packageLabel	back to summary
public final Content packageLabel

packagesLabel	back to summary
public final Content packagesLabel

packageSubNavLabel	back to summary
public final Content packageSubNavLabel

packageSummaryLabel	back to summary
public final Content packageSummaryLabel

parameters	back to summary
public final Content parameters

previewAPI	back to summary
public final Content previewAPI

previewLabel	back to summary
public final Content previewLabel

previewMark	back to summary
public final Content previewMark

previewPhrase	back to summary
public final Content previewPhrase

properties	back to summary
public final Content properties

propertyDetailsLabel	back to summary
public final Content propertyDetailsLabel

propertyLabel	back to summary
public final Content propertyLabel

propertySummaryLabel	back to summary
public final Content propertySummaryLabel

recordComponents	back to summary
public final Content recordComponents

records	back to summary
public final Content records

referencedIn	back to summary
public final Content referencedIn

relatedPackages	back to summary
public final Content relatedPackages

resources	back to summary
private final Resources resources

restrictedMark	back to summary
public final Content restrictedMark

restrictedMethods	back to summary
public final Content restrictedMethods

restrictedPhrase	back to summary
public final Content restrictedPhrase

returns	back to summary
public final Content returns

searchLabel	back to summary
public final Content searchLabel

searchTagsLabel	back to summary
public final Content searchTagsLabel

seeAlso	back to summary
public final Content seeAlso

serializedForm	back to summary
public final Content serializedForm

servicesLabel	back to summary
public final Content servicesLabel

showSidebar	back to summary
public final Content showSidebar

specificationLabel	back to summary
public final Content specificationLabel

specifiedByLabel	back to summary
public final Content specifiedByLabel

subclassesLabel	back to summary
public final Content subclassesLabel

subinterfacesLabel	back to summary
public final Content subinterfacesLabel

summaryLabel	back to summary
public final Content summaryLabel

systemPropertiesLabel	back to summary
public final Content systemPropertiesLabel

systemPropertiesSummaryLabel	back to summary
public final Content systemPropertiesSummaryLabel

tableOfContentsLabel	back to summary
public final Content tableOfContentsLabel

throws_	back to summary
public final Content throws_

treeLabel	back to summary
public final Content treeLabel

typeLabel	back to summary
public final Content typeLabel

typeParameters	back to summary
public final Content typeParameters

useLabel	back to summary
public final Content useLabel

valueLabel	back to summary
public final Content valueLabel

Constructor Detail

Contents back to summary

pack-priv Contents(HtmlConfiguration configuration)

Creates a Contents object.

Parameters

configuration:HtmlConfiguration: the configuration in which to find the resources used to look up resource keys, and other details.

Method Detail

getContent back to summary

public Content getContent(String key)

Gets a Content object, containing the string for a given key in the doclet's resources.

Parameters

key:String: the key for the desired string

Returns:Content

the string

getContent back to summary

public Content getContent(String key, Object o0)

Gets a Content object, containing the string for a given key in the doclet's resources, formatted with given arguments.

Parameters

key:String: the key for the desired string
o0:Object: string or content argument to be formatted into the result

Returns:Content

the string

getContent back to summary

public Content getContent(String key, Object o0, Object o1)

Gets a Content object, containing the string for a given key in the doclet's resources, formatted with given arguments.

Parameters

key:String: the key for the desired string
o0:Object: string or content argument to be formatted into the result
o1:Object: string or content argument to be formatted into the result

Returns:Content

the string

getContent back to summary

public Content getContent(String key, Object o0, Object o1, Object o2)

Gets a Content object, containing the string for a given key in the doclet's resources, formatted with given arguments.

Parameters

key:String: the key for the desired string
o0:Object: string or content argument to be formatted into the result
o1:Object: string or content argument to be formatted into the result
o2:Object: string or content argument to be formatted into the result

Returns:Content

the string

getNavLinkLabelContent

back to summary

public Content getNavLinkLabelContent(VisibleMemberTable.Kind kind)

Returns a label that describes the VisibleMemberTable kind.

Parameters

kind:VisibleMemberTable.Kind: the visible member table kind.

Returns:Content

a label that describes the VisibleMemberTable kind

getNonBreakResource back to summary

private Content getNonBreakResource(String key)

Gets a Content object, containing the string for a given key in the doclet's resources, substituting for any space characters found in the named resource string.

Parameters

key:String: the key for the desired string

Returns:Content

the string

getNonBreakString back to summary

public Content getNonBreakString(String text)

Gets a Content object for a string, substituting for any space characters found in the named resource string.

Parameters

text:String: the string

Returns:Content

the string content

join

back to summary

public Content join(Content separator, Collection<? extends Content> items)

Returns content composed of items joined together with the specified separator.

Parameters

separator:Content: the separator
items:Collection<? extends Content>: the items

Returns:Content

the composition

public Class Contents

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail