FileDocCategorySizeDatePackage
Tag.javaAPI DocJava SE 5 API5061Fri Aug 26 14:54:54 BST 2005com.sun.javadoc

Tag

public interface Tag
Represents a simple documentation tag, such as @since, @author, @version. Given a tag (e.g. "@since 1.2"), holds tag name (e.g. "@since") and tag text (e.g. "1.2"). Tags with structure or which require special processing are handled by subclasses such as ParamTag (for @param), SeeTag (for @see and {@link}), and ThrowsTag (for @throws).
author
Robert Field
author
Atul M Dambalkar
see
SeeTag
see
ParamTag
see
ThrowsTag
see
SerialFieldTag
see
Doc#tags()

Fields Summary
Constructors Summary
Methods Summary
public com.sun.javadoc.Tag[]firstSentenceTags()
Return the first sentence of the comment as an array of tags. Includes inline tags (i.e. {@link reference} tags) but not block tags. Each section of plain text is represented as a {@link Tag} of kind "Text". Inline tags are represented as a {@link 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 {@link java.text.BreakIterator#getSentenceInstance(Locale) java.text.BreakIterator.getSentenceInstance(Locale)}.

return
an array of {@link Tag} objects representing the first sentence of the comment

public com.sun.javadoc.Docholder()
Return the containing {@link Doc} of this Tag element.

public com.sun.javadoc.Tag[]inlineTags()
For a documentation comment with embedded {@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 {@link #text()} returns the string. Each {@link} tag is represented by a {@link 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:

  • tags[0] is a {@link Tag} with name "Text" and text consisting of "This is a "
  • tags[1] is a {@link SeeTag} with name "@link", referenced class Doc and label "commentlabel"
  • tags[2] is a {@link Tag} with name "Text" and text consisting of " example."

return
Tag[] array of tags
see
ParamTag
see
ThrowsTag

public java.lang.Stringkind()
Return the kind of this tag. similar or synonymous tags. For most tags, 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

public java.lang.Stringname()
Return the name of this tag. The name is the string starting with "@" that is used in a doc comment, such as @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.

public com.sun.javadoc.SourcePositionposition()
Return the source position of this tag.

return
the source position of this tag.

public java.lang.Stringtext()
Return the text of this tag, that is, portion beyond tag name.

public java.lang.StringtoString()
Convert this object to a string.