Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotDocThrowsTag

All Superinterfaces:
JotCodeElement, JotDocTag, JotElement

public interface JotDocThrowsTag
extends JotDocTag

The JotDocThrowsTag interface represents instances of throws tags inside of a JavaDoc comment block.


Method Summary
 java.lang.String getExceptionComment()
           
 java.lang.String getExceptionName()
           
 JotType[] getExceptionTypes()
           
 JotType getReferencedExceptionType()
           
 void setExceptionComment(java.lang.String exceptionComment)
           
 void setExceptionName(java.lang.String exceptionName)
           
 
Methods inherited from interface oracle.jdeveloper.jot.JotDocTag
getTagName, getTagText, getTextTags, isLinkTag, isParamTag, isReturnTag, isSeeTag, isSerialFieldTag, isTextTag, isThrowsTag, setTagName, setTagText
 
Methods inherited from interface oracle.jdeveloper.jot.JotCodeElement
addPrecedingComment, childrenContainErrors, delete, getContainingJotFile, getLeftWhitespace, getLength, getRightWhitespace, isInError, isSource, setLeftWhitespace, setRightWhitespace
 
Methods inherited from interface oracle.jdeveloper.jot.JotElement
getChildren, getContainedElements, getElementName, getElementType, getEndOffset, getID, getJotWorkArea, getParent, getStartOffset, isExistent, isReadOnly, isStructureKnown, setParent
 

Method Detail

getExceptionTypes

public JotType[] getExceptionTypes()
                            throws JotInvalidElementException
Returns:
the JotType of the exception. This value is retrieved from the actual JotElement.
Throws:
JotInvalidElementException

getReferencedExceptionType

public JotType getReferencedExceptionType()
                                   throws JotInvalidElementException
Returns:
the JotType of the referenced exception.
Throws:
JotInvalidElementException

getExceptionName

public java.lang.String getExceptionName()
                                  throws JotInvalidElementException
Returns:
the exception name, or the first word of the comment.
Throws:
JotInvalidElementException

setExceptionName

public void setExceptionName(java.lang.String exceptionName)
                      throws JotInvalidElementException
Parameters:
exceptionName - the new name of the parameter.
Throws:
JotInvalidElementException

getExceptionComment

public java.lang.String getExceptionComment()
                                     throws JotInvalidElementException
Returns:
the exception comment.
Throws:
JotInvalidElementException

setExceptionComment

public void setExceptionComment(java.lang.String exceptionComment)
                         throws JotInvalidElementException
Parameters:
exceptionComment - the new comment of the exception tag.
Throws:
JotInvalidElementException

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.