Interface DocTree
- All Known Subinterfaces:
AttributeTree,AuthorTree,BlockTagTree,CommentTree,DeprecatedTree,DocCommentTree,DocRootTree,DocTypeTree,EndElementTree,EntityTree,ErroneousTree,EscapeTree,HiddenTree,IdentifierTree,IndexTree,InheritDocTree,InlineTagTree,LinkTree,LiteralTree,ParamTree,ProvidesTree,ReferenceTree,ReturnTree,SeeTree,SerialDataTree,SerialFieldTree,SerialTree,SinceTree,SnippetTree,SpecTree,StartElementTree,SummaryTree,SystemPropertyTree,TextTree,ThrowsTree,UnknownBlockTagTree,UnknownInlineTagTree,UsesTree,ValueTree,VersionTree
public interface DocTree
Common interface for all nodes in a documentation syntax tree.
- Since:
- 1.8
Nested Class Summary
| Modifier and Type | Interface | Description |
|---|---|---|
static enum |
DocTree.Kind |
Enumerates all kinds of trees.
|
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
<R, |
accept |
Accept method used to implement the visitor pattern.
|
DocTree.Kind |
getKind() |
Returns the kind of this tree.
|
Method Details
getKind
DocTree.Kind getKind()
Returns the kind of this tree.
- Returns:
- the kind of this tree
accept
<R, D> R accept(DocTreeVisitor<R,D> visitor, D data)
Accept method used to implement the visitor pattern. The visitor pattern is used to implement operations on trees.
- Type Parameters:
R- the result type of this operationD- the type of additional data- Parameters:
visitor- the visitor to be calleddata- a parameter value to be passed to the visitor method- Returns:
- the value returned from the visitor method
© 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/DocTree.html