public interface Tag
SeeTag, 
ParamTag, 
ThrowsTag, 
SerialFieldTag, 
Doc.tags()| Modifier and Type | Method and Description | 
|---|---|
| Tag[] | firstSentenceTags()Return the first sentence of the comment as an array of tags. | 
| Doc | holder()Return the containing  Docof this Tag element. | 
| Tag[] | inlineTags()For a documentation comment with embedded  {@link}tags, return an array ofTagobjects. | 
| String | kind()Return the kind of this tag. | 
| String | name()Return the name of this tag. | 
| SourcePosition | position()Return the source position of this tag. | 
| String | text()Return the text of this tag, that is, the portion beyond tag name. | 
| String | toString()Convert this object to a string. | 
String name()
@return.  For inline tags, such as
 {@link}, the curly brackets
 are not part of the name, so in this example the name
 would be simply @link.Doc holder()
Doc of this Tag element.Doc of this Tag elementString kind()
kind() == name();
 the following table lists those cases where there is more
 than one tag of a given kind:
 | kind()   | name()       | 
|---|---|
| @throws  | @throws      | 
| @throws  | @exception   | 
| @see     | @see         | 
| @see     | @link        | 
| @see     | @linkplain   | 
| @serial  | @serial      | 
| @serial  | @serialData  | 
String text()
String toString()
Tag[] inlineTags()
{@link}
 tags, return an array of Tag objects.  The entire
 doc comment is broken down into strings separated by
 {@link} tags, where each successive element
 of the array represents either a string or
 {@link} tag, in order, from start to end.
 Each string is represented by a Tag object of
 name "Text", where text() returns the string.  Each
 {@link} tag is represented by a
 SeeTag of name "@link" and kind "@see".
 For example, given the following comment
 tag:
 
  This is a {@link Doc commentlabel} example.
 
return an array of Tag objects:
Tag[] firstSentenceTags()
Tag
 of kind "Text".
 Inline tags are represented as a SeeTag of kind "@link".
 If the locale is English language, the first sentence is
 determined by the rules described in the Java Language
 Specification (first version): "This sentence ends
 at the first period that is followed by a blank, tab, or
 line terminator or at the first tagline.", in
 addition a line will be terminated by paragraph and
 section terminating HTML tags: <p>  </p>  <h1>
 <h2>  <h3> <h4>  <h5>  <h6>
 <hr>  <pre>  or </pre>.
 If the locale is not English, the sentence end will be
 determined by
 BreakIterator.getSentenceInstance(Locale).Tag objects representing the
         first sentence of the commentSourcePosition position()
 Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
 Copyright © 1993, 2025, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.