Interface IndexTree

All Superinterfaces:: DocTree, InlineTagTree

public interface IndexTree extends InlineTagTree

A tree node for an @index inline tag.

   {@index keyword optional description}

Since:: 9

Nested Class Summary

Nested classes/interfaces declared in interface DocTree

DocTree.Kind

Modifier and Type	Interface	Description
`static enum`	`DocTree.Kind`	Enumerates all kinds of trees.

Method Summary

Modifier and Type	Method	Description
`List<? extends DocTree>`	`getDescription()`	Returns the description, if any.
`DocTree`	`getSearchTerm()`	Returns the specified search term.

Methods declared in interface DocTree

accept, getKind

Modifier and Type	Method	Description
`<R,D> R`	`accept(DocTreeVisitor<R,D> visitor, D data)`	Accept method used to implement the visitor pattern.
`DocTree.Kind`	`getKind()`	Returns the kind of this tree.

Methods declared in interface InlineTagTree

getTagName

Modifier and Type	Method	Description
`String`	`getTagName()`	Returns the name of the tag.

Method Details

getSearchTerm

DocTree getSearchTerm()

Returns the specified search term.

Returns:: the search term

getDescription

List<? extends DocTree> getDescription()

Returns the description, if any.

Returns:: the description

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.