Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotDocReturnTag

All Superinterfaces:
JotCodeElement, JotDocTag, JotElement

public interface JotDocReturnTag
extends JotDocTag

The JotDocReturnTag interface represents instances of return tags inside of a JavaDoc comment block.


Method Summary
 java.lang.String getReturnComment()
           
 JotType getReturnType()
           
 void setReturnComment(java.lang.String returnComment)
           
 
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

getReturnType

public JotType getReturnType()
                      throws JotInvalidElementException
Returns:
the JotType returned. This value is retrieved from the actual JotElement.
Throws:
JotInvalidElementException

getReturnComment

public java.lang.String getReturnComment()
                                  throws JotInvalidElementException
Returns:
the return comment.
Throws:
JotInvalidElementException

setReturnComment

public void setReturnComment(java.lang.String returnComment)
                      throws JotInvalidElementException
Parameters:
returnComment - the new comment of the return tag.
Throws:
JotInvalidElementException

Extension SDK

 

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