Interface EscapeTree

All Superinterfaces:: DocTree, TextTree

public interface EscapeTree extends TextTree

A tree node for a character represented by an escape sequence.

API Note:

This class does not itself constrain the set of valid escape sequences, although the set may be effectively constrained to those defined in the Documentation Comment Specification for the Standard Doclet, including the following context-sensitive escape sequences:

@@, representing @, where it would otherwise be treated as introducing a block or inline tag,
@/, representing /, as part of *@/ to represent &ast;/, and
@*, representing *, where it would otherwise be discarded, after whitespace at the beginning of a line.

Since:

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
`String`	`getBody()`	Returns the text.

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.

Method Details

getBody

String getBody()

Returns the text.

Note: this method returns the escaped character, not the original escape sequence.

Specified by:: getBody in interface TextTree
Returns:: the text

© 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.