Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotDocParamTag

All Superinterfaces:
JotCodeElement, JotDocTag, JotElement

public interface JotDocParamTag
extends JotDocTag

The JotDocParamTag interface represents instances of param tags inside of a JavaDoc comment block.


Method Summary
 java.lang.String getParameterComment()
           
 java.lang.String getParameterName()
           
 void setParameterComment(java.lang.String paramComment)
           
 void setParameterName(java.lang.String paramName)
           
 
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

getParameterName

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

setParameterName

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

getParameterComment

public java.lang.String getParameterComment()
                                     throws JotInvalidElementException
Returns:
the parameter comment, or all text, but the first word..
Throws:
JotInvalidElementException

setParameterComment

public void setParameterComment(java.lang.String paramComment)
                         throws JotInvalidElementException
Parameters:
paramComment - the new comment of the parameter.
Throws:
JotInvalidElementException

Extension SDK

 

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