com.combex.e.edoc
Class ETag

java.lang.Object
  |
  +--com.combex.e.edoc.ETag

All Implemented Interfaces:

Marker, PassByConstruction, Serializable, com.sun.javadoc.Tag

Direct Known Subclasses:

EParamTag, ESeeTag, ESerialFieldTag, EThrowsTag

class ETag

extends Object

implements com.sun.javadoc.Tag, PassByConstruction

Represents a documentation tag, e.g. @since, @author, @version. Given a tag (e.g. "@since 1.2"), holds tag name (e.g. "@since") and tag text (e.g. "1.2"). TagImpls with structure or which require special processing are handled by subclasses (EParamTag, ESeeTag, and EThrowsTag

Author:

Robert Field, Atul M Dambalkar, mods by Mark Miller of combex.com subject to the terms of Sun's SCSL license.

See Also:

ESeeTag, EParamTag, EThrowsTag, com.sun.javadoc.Doc#tags()

Field Summary

(package private) EDoc	myHolder
(package private) String	myName
(package private) String	myText

Fields inherited from interface org.erights.e.elib.serial.PassByConstruction

HONORARY, HONORED_NAMES, serialVersionUID

Constructor Summary

(package private)

ETag(EDoc holder, String name, String text) Constructor

Method Summary

(package private) String[]	divideAtWhite() for use by subclasses which have two part tag text.
com.sun.javadoc.Tag[]	firstSentenceTags() Return array of tags for the first sentence in the doc comment text.
com.sun.javadoc.Tag[]	inlineTags() For documentation comment with embedded @link tags, return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s).
String	kind() Return the kind of this tag.
String	name() Return the name of this tag.
com.sun.javadoc.SourcePosition	position() Need for 1.4
String	qualifiedDocName() Return the qualified name of this tags' doc item.
String	text() Return the text of this tag, that is, portion beyond tag name.
String	toString() convert this object to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

myText

final String myText

myName

final String myName

myHolder

final EDoc myHolder

Constructor Detail

ETag

ETag(EDoc holder,
     String name,
     String text)

Constructor

Method Detail

name

public String name()

Return the name of this tag.

kind

public String kind()

Return the kind of this tag.

text

public String text()

Return the text of this tag, that is, portion beyond tag name.

divideAtWhite

String[] divideAtWhite()

for use by subclasses which have two part tag text.

toString

public String toString()

convert this object to a string.

Overrides:

toString in class Object

Returns:

a string representation of the object.

inlineTags

public com.sun.javadoc.Tag[] inlineTags()

For documentation comment with embedded @link tags, return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s). Within a comment string "This is an example of inline tags for a documentaion comment commentlabel", where inside the inner braces, the first "Doc" carries exctly the same syntax as a ESeeTag and the second "commentlabel" is label for the Html Link, will return an array of ETag(s) with first element as ETag with comment text "This is an example of inline tags for a documentation comment" and second element as ESeeTag with referenced class as "Doc" and the label for the Html Link as "commentlabel".

Returns:

ETag[] Array of tags with inline SeeTagImpls.

See Also:

EParamTag, EThrowsTag

firstSentenceTags

public com.sun.javadoc.Tag[] firstSentenceTags()

Return array of tags for the first sentence in the doc comment text.

qualifiedDocName

public String qualifiedDocName()

Return the qualified name of this tags' doc item.

position

public com.sun.javadoc.SourcePosition position()

Need for 1.4