Modifier and Type	Class and Description
public static enum	IndexItem.Category The "category" used to group items for the interactive search index.
private static class	IndexItem.JSONBuilder
public static enum	IndexItem.Kind The kind of index item.

Modifier and Type	Field and Description
private String	containingClass The containing class, if any, for the item.
private String	containingModule The containing module, if any, for the item.
private String	containingPackage The containing package, if any, for the item.
private final Element	element The element for the item.
private final IndexItem.Kind	kind The kind of the item.
private final String	label The presentation string for the item.
private String	url The URL pointing to the element, doc tree or page being indexed.

Access	Constructor and Description
private	IndexItem(Element element, String label, IndexItem.Kind kind)
private	IndexItem(Element element, String label, IndexItem.Kind kind, String url)

Method Summary

Modifier and Type	Method and Description
private static String	escapeQuotes(String s)
public IndexItem.Category	Returns: the category getCategory() Returns the category for this item, that indicates the JavaScript file in which this item should be written.
protected IndexItem.Category	getCategory(DocTree docTree)
protected IndexItem.Category	getCategory(Element element)
public TypeElement	Returns: the type element getContainingTypeElement() Returns the type element that is documented as containing a member element, or `null` if this item does not represent a member element.
public String	Returns: the description of the tag getDescription() Returns a description of the tag for this item or an empty string if no description is available for this item.
public DocTree	Returns: the documentation tree node getDocTree() Returns the documentation tree node for this item, of `null` if this item does not represent a documentation tree node.
public Element	Returns: the element getElement() Returns the element associate with this item, or `null`.
public String	Returns: the fully qualified name getFullyQualifiedLabel(Utils the common utilities class utils) Returns the label with a fully-qualified type name.
public String	Returns: the description of the element that owns this item getHolder() Returns a description of the element owning the documentation comment for this item, or `null` if this is not a item for a tag for an item in a documentation tag.
public IndexItem.Kind	Returns: the item kind getKind() Returns the kind of this item.
public String	Returns: the label getLabel() Returns the label of the item.
public String	Returns: the simple name getSimpleName() Returns the part of the label after the last dot, or the whole label if there are no dots.
public String	Returns: the URL for this item, or an empty string if no value has been set getUrl() Returns the URL for this item, or an empty string if no value has been set.
public boolean	Returns: `true` if this index is for an element isElementItem() Returns `true` if this index is for an element.
public boolean	Returns: `true` if this index is for a specific kind of tag in a doc comment isKind(DocTree.Kind kind) Returns `true` if this index is for a specific kind of tag in a doc comment.
public boolean	Returns: `true` if this index is for a tag in a doc comment isTagItem() Returns `true` if this index is for a tag in a doc comment.
public static IndexItem	Returns: the item of(ModuleElement the element moduleElement, Utils the common utilities class utils) Creates an index item for a module element.
public static IndexItem	Returns: the item of(PackageElement the element packageElement, Utils the common utilities class utils) Creates an index item for a package element.
public static IndexItem	Returns: the item of(TypeElement the element typeElement, Utils the common utilities class utils) Creates an index item for a type element.
public static IndexItem	Returns: the item of(TypeElement the element that contains the member typeElement, Element the member member, Utils the common utilities class utils) Creates an index item for a member element.
public static IndexItem	Returns: the item of(Element the element element, DocTree the node in the doc comment docTree, String the label label, String the holder for the comment holder, String the description of the item description, DocLink the root-relative link to the item in the generated docs link) Creates an index item for a node in the doc comment for an element.
public static IndexItem	Returns: the item of(IndexItem.Category the category for the item category, String the label for the item label, DocPath the path for the page path) Creates an index item for a summary page, that is not associated with any element or node in a doc comment.
public IndexItem	Returns: this item setContainingClass(String the class c) Sets the name of the containing class for this item.
public IndexItem	Returns: this item setContainingModule(String the module m) Sets the name of the containing module for this item.
public IndexItem	Returns: this item setContainingPackage(String the package p) Sets the name of the containing package for this item.
public IndexItem	Returns: this item setUrl(String the url u) Sets the URL for the item, when it cannot otherwise be inferred from other fields.
public String	Returns: a string representing this item in JSON notation toJSON() Returns a string representing this item in JSON notation.

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

Field Detail

containingClass	back to summary
private String containingClass The containing class, if any, for the item.

containingModule	back to summary
private String containingModule The containing module, if any, for the item. It will be empty if the element is not in a package, and may be omitted if the name of the package is unique.

containingPackage	back to summary
private String containingPackage The containing package, if any, for the item.

element	back to summary
private final Element element The element for the item. It is only null for items for summary pages that are not associated with any specific element.

kind	back to summary
private final IndexItem.Kind kind The kind of the item.

label	back to summary
private final String label The presentation string for the item. It must be non-empty.

url	back to summary
private String url The URL pointing to the element, doc tree or page being indexed. It may be empty if the information can be determined from other fields.

Constructor Detail

IndexItem	back to summary
private IndexItem(Element element, String label, IndexItem.Kind kind)

IndexItem	back to summary
private IndexItem(Element element, String label, IndexItem.Kind kind, String url)

Method Detail

escapeQuotes	back to summary
private static String escapeQuotes(String s)

getCategory	back to summary
public IndexItem.Category getCategory() Returns the category for this item, that indicates the JavaScript file in which this item should be written. Returns:IndexItem.Category the category

getCategory

back to summary

public IndexItem.Category getCategory()

Returns the category for this item, that indicates the JavaScript file in which this item should be written.

Returns:IndexItem.Category: the category

getCategory	back to summary
protected IndexItem.Category getCategory(DocTree docTree)

getCategory	back to summary
protected IndexItem.Category getCategory(Element element)

getContainingTypeElement back to summary

getContainingTypeElement	back to summary
public TypeElement getContainingTypeElement() Returns the type element that is documented as containing a member element, or `null` if this item does not represent a member element. Returns:TypeElement the type element

public TypeElement getContainingTypeElement()

Returns the type element that is documented as containing a member element, or null if this item does not represent a member element.

Returns:TypeElement: the type element

getDescription	back to summary
public String getDescription() Returns a description of the tag for this item or an empty string if no description is available for this item. Returns:String the description of the tag

getDescription

back to summary

public String getDescription()

Returns a description of the tag for this item or an empty string if no description is available for this item.

Returns:String: the description of the tag

getDocTree back to summary

getDocTree	back to summary
public DocTree getDocTree() Returns the documentation tree node for this item, of `null` if this item does not represent a documentation tree node. Returns:DocTree the documentation tree node

public DocTree getDocTree()

Returns the documentation tree node for this item, of null if this item does not represent a documentation tree node.

Returns:DocTree: the documentation tree node

getElement back to summary

getElement	back to summary
public Element getElement() Returns the element associate with this item, or `null`. Returns:Element the element

public Element getElement()

Returns the element associate with this item, or null.

Returns:Element: the element

getFullyQualifiedLabel	back to summary
public String getFullyQualifiedLabel(Utils utils) Returns the label with a fully-qualified type name. (Used to determine if labels are unique or need to be qualified.) Parameters utils:Utils the common utilities class Returns:String the fully qualified name

getFullyQualifiedLabel

back to summary

public String getFullyQualifiedLabel(Utils utils)

Returns the label with a fully-qualified type name. (Used to determine if labels are unique or need to be qualified.)

Parameters

utils:Utils: the common utilities class

Returns:String

the fully qualified name

getHolder back to summary

getHolder	back to summary
public String getHolder() Returns a description of the element owning the documentation comment for this item, or `null` if this is not a item for a tag for an item in a documentation tag. Returns:String the description of the element that owns this item

public String getHolder()

Returns a description of the element owning the documentation comment for this item, or null if this is not a item for a tag for an item in a documentation tag.

Returns:String: the description of the element that owns this item

getKind	back to summary
public IndexItem.Kind getKind() Returns the kind of this item. Returns:IndexItem.Kind the item kind

getKind

back to summary

public IndexItem.Kind getKind()

Returns the kind of this item.

Returns:IndexItem.Kind: the item kind

getLabel	back to summary
public String getLabel() Returns the label of the item. Returns:String the label

getLabel

back to summary

public String getLabel()

Returns the label of the item.

Returns:String: the label

getSimpleName	back to summary
public String getSimpleName() Returns the part of the label after the last dot, or the whole label if there are no dots. Returns:String the simple name

getSimpleName

back to summary

public String getSimpleName()

Returns the part of the label after the last dot, or the whole label if there are no dots.

Returns:String: the simple name

getUrl	back to summary
public String getUrl() Returns the URL for this item, or an empty string if no value has been set. Returns:String the URL for this item, or an empty string if no value has been set

getUrl

back to summary

public String getUrl()

Returns the URL for this item, or an empty string if no value has been set.

Returns:String: the URL for this item, or an empty string if no value has been set

isElementItem back to summary

isElementItem	back to summary
public boolean isElementItem() Returns `true` if this index is for an element. Returns:boolean `true` if this index is for an element

public boolean isElementItem()

Returns true if this index is for an element.

Returns:boolean: true if this index is for an element

isKind back to summary

isKind	back to summary
public boolean isKind(DocTree.Kind kind) Returns `true` if this index is for a specific kind of tag in a doc comment. Returns:boolean `true` if this index is for a specific kind of tag in a doc comment

public boolean isKind(DocTree.Kind kind)

Returns true if this index is for a specific kind of tag in a doc comment.

Returns:boolean: true if this index is for a specific kind of tag in a doc comment

isTagItem back to summary

isTagItem	back to summary
public boolean isTagItem() Returns `true` if this index is for a tag in a doc comment. Returns:boolean `true` if this index is for a tag in a doc comment

public boolean isTagItem()

Returns true if this index is for a tag in a doc comment.

Returns:boolean: true if this index is for a tag in a doc comment

of	back to summary
public static IndexItem of(ModuleElement moduleElement, Utils utils) Creates an index item for a module element. Parameters moduleElement:ModuleElement the element utils:Utils the common utilities class Returns:IndexItem the item

back to summary

public static IndexItem of(ModuleElement moduleElement, Utils utils)

Creates an index item for a module element.

Parameters

moduleElement:ModuleElement: the element
utils:Utils: the common utilities class

Returns:IndexItem

the item

of	back to summary
public static IndexItem of(PackageElement packageElement, Utils utils) Creates an index item for a package element. Parameters packageElement:PackageElement the element utils:Utils the common utilities class Returns:IndexItem the item

back to summary

public static IndexItem of(PackageElement packageElement, Utils utils)

Creates an index item for a package element.

Parameters

packageElement:PackageElement: the element
utils:Utils: the common utilities class

Returns:IndexItem

the item

of back to summary

of	back to summary
public static IndexItem of(TypeElement typeElement, Utils utils) Creates an index item for a type element. Note use `getElement()` to access this value, not `getTypeElement`. Parameters typeElement:TypeElement the element utils:Utils the common utilities class Returns:IndexItem the item

public static IndexItem of(TypeElement typeElement, Utils utils)

Creates an index item for a type element.

Note

use getElement() to access this value, not getTypeElement.

Parameters

typeElement:TypeElement: the element
utils:Utils: the common utilities class

Returns:IndexItem

the item

of back to summary

of	back to summary
public static IndexItem of(TypeElement typeElement, Element member, Utils utils) Creates an index item for a member element. Note the given type element may not be the same as the enclosing element of the member in cases where the enclosing element is not visible in the documentation. Parameters typeElement:TypeElement the element that contains the member member:Element the member utils:Utils the common utilities class Returns:IndexItem the item See Also `getContainingTypeElement()`

public static IndexItem of(TypeElement typeElement, Element member, Utils utils)

Creates an index item for a member element.

Note

the given type element may not be the same as the enclosing element of the member in cases where the enclosing element is not visible in the documentation.

Parameters

typeElement:TypeElement: the element that contains the member
member:Element: the member
utils:Utils: the common utilities class

Returns:IndexItem

the item

See Also

getContainingTypeElement()

of	back to summary
public static IndexItem of(Element element, DocTree docTree, String label, String holder, String description, DocLink link) Creates an index item for a node in the doc comment for an element. The node should only be one that gives rise to an entry in the index. Parameters element:Element the element docTree:DocTree the node in the doc comment label:String the label holder:String the holder for the comment description:String the description of the item link:DocLink the root-relative link to the item in the generated docs Returns:IndexItem the item

back to summary

public static IndexItem of(Element element, DocTree docTree, String label, String holder, String description, DocLink link)

Creates an index item for a node in the doc comment for an element. The node should only be one that gives rise to an entry in the index.

Parameters

element:Element: the element
docTree:DocTree: the node in the doc comment
label:String: the label
holder:String: the holder for the comment
description:String: the description of the item
link:DocLink: the root-relative link to the item in the generated docs

Returns:IndexItem

the item

of	back to summary
public static IndexItem of(IndexItem.Category category, String label, DocPath path) Creates an index item for a summary page, that is not associated with any element or node in a doc comment. Parameters category:IndexItem.Category the category for the item label:String the label for the item path:DocPath the path for the page Returns:IndexItem the item

back to summary

public static IndexItem of(IndexItem.Category category, String label, DocPath path)

Creates an index item for a summary page, that is not associated with any element or node in a doc comment.

Parameters

category:IndexItem.Category: the category for the item
label:String: the label for the item
path:DocPath: the path for the page

Returns:IndexItem

the item

setContainingClass	back to summary
public IndexItem setContainingClass(String c) Sets the name of the containing class for this item. Parameters c:String the class Returns:IndexItem this item

setContainingClass

back to summary

public IndexItem setContainingClass(String c)

Sets the name of the containing class for this item.

Parameters

c:String: the class

Returns:IndexItem

this item

setContainingModule	back to summary
public IndexItem setContainingModule(String m) Sets the name of the containing module for this item. Parameters m:String the module Returns:IndexItem this item

setContainingModule

back to summary

public IndexItem setContainingModule(String m)

Sets the name of the containing module for this item.

Parameters

m:String: the module

Returns:IndexItem

this item

setContainingPackage	back to summary
public IndexItem setContainingPackage(String p) Sets the name of the containing package for this item. Parameters p:String the package Returns:IndexItem this item

setContainingPackage

back to summary

public IndexItem setContainingPackage(String p)

Sets the name of the containing package for this item.

Parameters

p:String: the package

Returns:IndexItem

this item

setUrl	back to summary
public IndexItem setUrl(String u) Sets the URL for the item, when it cannot otherwise be inferred from other fields. Parameters u:String the url Returns:IndexItem this item

setUrl

back to summary

public IndexItem setUrl(String u)

Sets the URL for the item, when it cannot otherwise be inferred from other fields.

Parameters

u:String: the url

Returns:IndexItem

this item

toJSON	back to summary
public String toJSON() Returns a string representing this item in JSON notation. Returns:String a string representing this item in JSON notation

toJSON

back to summary

public String toJSON()

Returns a string representing this item in JSON notation.

Returns:String: a string representing this item in JSON notation

jdk.javadoc.internal.doclets.toolkit.util back to summary

public final Enum IndexItem.Category

Class Inheritance

extends Enum<IndexItem.Category>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.doclets.toolkit.util.IndexItem.Category

The "category" used to group items for the interactive search index. Categories correspond directly to the JavaScript files that will be generated.

Field Summary

Modifier and Type	Field and Description
public static final IndexItem.Category	MEMBERS
public static final IndexItem.Category	MODULES
public static final IndexItem.Category	PACKAGES
public static final IndexItem.Category	TAGS
public static final IndexItem.Category	TYPES

Constructor Summary

Access	Constructor and Description
private	Category()

Method Summary

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

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

Field Detail

MEMBERS	back to summary
public static final IndexItem.Category MEMBERS

MODULES	back to summary
public static final IndexItem.Category MODULES

PACKAGES	back to summary
public static final IndexItem.Category PACKAGES

TAGS	back to summary
public static final IndexItem.Category TAGS

TYPES	back to summary
public static final IndexItem.Category TYPES

Constructor Detail

Category	back to summary
private Category()

Method Detail

valueOf	back to summary
public static IndexItem.Category valueOf(String name)

values	back to summary
public static IndexItem.Category[] values()

jdk.javadoc.internal.doclets.toolkit.util back to summary

private Class IndexItem.JSONBuilder

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.toolkit.util.IndexItem.JSONBuilder

Field Summary

Modifier and Type	Field and Description
pack-priv StringBuilder	b

Constructor Summary

Access	Constructor and Description
private	JSONBuilder()

Method Summary

Modifier and Type	Method and Description
public IndexItem.JSONBuilder	append(String name, Object value)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

b	back to summary
pack-priv StringBuilder b

Constructor Detail

JSONBuilder	back to summary
private JSONBuilder()

Method Detail

append	back to summary
public IndexItem.JSONBuilder append(String name, Object value)

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

jdk.javadoc.internal.doclets.toolkit.util back to summary

public final Enum IndexItem.Kind

Class Inheritance

extends Enum<IndexItem.Kind>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.doclets.toolkit.util.IndexItem.Kind

The kind of index item. Index items can represent program elements, various doc comment tags, or other resources such as summary pages. Values in this enum must match elements in array itemDesc in JavaScript file search.js.template!

Field Summary

Modifier and Type	Field and Description
public static final IndexItem.Kind	ANNOTATION_ELEMENT
public static final IndexItem.Kind	ANNOTATION_TYPE
public static final IndexItem.Kind	CLASS
public static final IndexItem.Kind	CONSTRUCTOR
public static final IndexItem.Kind	ENUM
public static final IndexItem.Kind	ENUM_CONSTANT
public static final IndexItem.Kind	EXCEPTION_CLASS
public static final IndexItem.Kind	EXTERNAL_SPEC
public static final IndexItem.Kind	FIELD
public static final IndexItem.Kind	INTERFACE
public static final IndexItem.Kind	METHOD
public static final IndexItem.Kind	RECORD
public static final IndexItem.Kind	RECORD_COMPONENT
public static final IndexItem.Kind	SEARCH_ITEM
public static final IndexItem.Kind	SECTION
public static final IndexItem.Kind	STATIC_FIELD
public static final IndexItem.Kind	STATIC_METHOD
public static final IndexItem.Kind	SUMMARY_PAGE
public static final IndexItem.Kind	SYSTEM_PROPERTY

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static IndexItem.Kind	Returns: the kind of index item for a doc comment tag ofDocTree(DocTree tree) Returns the kind of index item for a doc comment tag.
public static IndexItem.Kind	Returns: the kind of index item for a program element ofElement(Element elem, Utils utils) Returns the kind of index item for a program element.
public static IndexItem.Kind	valueOf(String name)
public static IndexItem.Kind[]	values()

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

Field Detail

ANNOTATION_ELEMENT	back to summary
public static final IndexItem.Kind ANNOTATION_ELEMENT

ANNOTATION_TYPE	back to summary
public static final IndexItem.Kind ANNOTATION_TYPE

CLASS	back to summary
public static final IndexItem.Kind CLASS

CONSTRUCTOR	back to summary
public static final IndexItem.Kind CONSTRUCTOR

ENUM	back to summary
public static final IndexItem.Kind ENUM

ENUM_CONSTANT	back to summary
public static final IndexItem.Kind ENUM_CONSTANT

EXCEPTION_CLASS	back to summary
public static final IndexItem.Kind EXCEPTION_CLASS

EXTERNAL_SPEC	back to summary
public static final IndexItem.Kind EXTERNAL_SPEC

FIELD	back to summary
public static final IndexItem.Kind FIELD

INTERFACE	back to summary
public static final IndexItem.Kind INTERFACE

METHOD	back to summary
public static final IndexItem.Kind METHOD

RECORD	back to summary
public static final IndexItem.Kind RECORD

RECORD_COMPONENT	back to summary
public static final IndexItem.Kind RECORD_COMPONENT

SEARCH_ITEM	back to summary
public static final IndexItem.Kind SEARCH_ITEM

SECTION	back to summary
public static final IndexItem.Kind SECTION

STATIC_FIELD	back to summary
public static final IndexItem.Kind STATIC_FIELD

STATIC_METHOD	back to summary
public static final IndexItem.Kind STATIC_METHOD

SUMMARY_PAGE	back to summary
public static final IndexItem.Kind SUMMARY_PAGE

SYSTEM_PROPERTY	back to summary
public static final IndexItem.Kind SYSTEM_PROPERTY

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

ofDocTree

back to summary

public static IndexItem.Kind ofDocTree(DocTree tree)

Returns the kind of index item for a doc comment tag.

Returns:IndexItem.Kind: the kind of index item for a doc comment tag

ofElement

back to summary

public static IndexItem.Kind ofElement(Element elem, Utils utils)

Returns the kind of index item for a program element.

Returns:IndexItem.Kind: the kind of index item for a program element

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

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

public Class IndexItem

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum IndexItem.Category

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class IndexItem.JSONBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum IndexItem.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail