W3cubDocs

/OpenJDK 21

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 com.sun.source.doctree.DocTree

DocTree.Kind

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 com.sun.source.doctree.DocTree

accept, getKind

Methods declared in interface com.sun.source.doctree.InlineTagTree

getTagName

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, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.compiler/com/sun/source/doctree/IndexTree.html