net.cscott.sinjdoc

Interface Tag

public interface Tag

The Tag class represents a documentation tag. The tag name and tag text are available for queries; tags with structure or which require special processing are handled by subclasses.

Every tag can have both inline and trailing tags, although in practice only top-level 'Text' tags contain trailing tags.

Version: $Id: Tag.java,v 1.7 2003/05/08 03:54:25 cananian Exp $

Author: C. Scott Ananian (cscott@cscott.net)

See Also: com.sun.javadoc.Tag

Method Summary
<T> T	accept(TagVisitor<T> visitor) Accept a visitor.
List<Tag>	contents() Return the contents of this tag; that is, the portion beyond the tag name and before the closing brace.
boolean	isInline() Returns true if this is an inline tag.
boolean	isText() Returns true if this is a "Text" tag.
boolean	isTrailing() Returns true if this is a trailing tag.
String	name() Return the name of this tag, or null if `isText()` is true.
SourcePosition	position() Return the source position of this tag.
String	text() Return the plain-text represented by this tag, or null if `isText()` is false.
String	toString() Return a human-readable representation of this tag object.

Method Detail

accept

public <T> T accept(TagVisitor<T> visitor)

Accept a visitor.

public List<Tag> contents()

Return the contents of this tag; that is, the portion beyond the tag name and before the closing brace. The returned list of tags will never contain Tags with isTrailing() true. Returns null if isText() is true.