com.combex.e.edoc
Class EThrowsTag

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

All Implemented Interfaces:

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

class EThrowsTag

extends ETag

implements com.sun.javadoc.ThrowsTag

Represents a @throws or @throws documentation tag. Parses and holds the exception name and exception comment. Note: @throws is a backwards compatible synonymy for @throws.

Author:

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

See Also:

EExecutableMemberDoc.throwsTags()

Field Summary

private com.sun.javadoc.ClassDoc	myExceptionClass
private String	myExceptionComment
private String	myExceptionName
(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)

EThrowsTag(EDoc holder, String name, String text)

Method Summary

(package private) String[]	divideAtWhite() for use by subclasses which have two part tag text.
com.sun.javadoc.ClassDoc	exception() Return the exception as a EClassDoc.
String	exceptionComment() Return the exception comment.
String	exceptionName() Return the exception name.
com.sun.javadoc.Tag[]	firstSentenceTags() Return array of tags for the first sentence in the doc comment text.
com.sun.javadoc.Tag[]	inlineTags() For the exception comment with embedded @link tags return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s).
private static boolean	isOK(com.sun.javadoc.ClassDoc exceptionClass, com.sun.javadoc.ClassDoc[] thrown)
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

myExceptionName

private final String myExceptionName

myExceptionComment

private final String myExceptionComment

myExceptionClass

private final com.sun.javadoc.ClassDoc myExceptionClass

myText

final String myText

myName

final String myName

myHolder

final EDoc myHolder

Constructor Detail

EThrowsTag

EThrowsTag(EDoc holder,
           String name,
           String text)

Method Detail

isOK

private static boolean isOK(com.sun.javadoc.ClassDoc exceptionClass,
                            com.sun.javadoc.ClassDoc[] thrown)

exceptionName

public String exceptionName()

Return the exception name.

exceptionComment

public String exceptionComment()

Return the exception comment.

exception

public com.sun.javadoc.ClassDoc exception()

Return the exception as a EClassDoc.

kind

public String kind()

Return the kind of this tag. Always "@throws" for instances of EThrowsTag.

Overrides:

kind in class ETag

inlineTags

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

For the exception comment with embedded @link tags return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s).

Overrides:

inlineTags in class ETag

Returns:

ETag[] Array of tags with inline SeeTagImpls.

See Also:

ETag#inlineTagImpls(), EParamTag#inlineTagImpls()

name

public String name()

Return the name 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.

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