|
Extension SDK 10.1.2 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The JotDocTag
interface represents instances of tags inside of a JavaDoc comment block. A doc tag consists of two parts: a tag name and tag text. In the raw comment text, tags are preceeded with the character '@' (for example @author); this character is not included in the tag name.
Method Summary | |
java.lang.String |
getTagName() Retrieves the name of this doc tag. |
java.lang.String |
getTagText() The text of this doc tag. |
JotDocTag[] |
getTextTags() Retrieves the text of the comment text portion of the tag as an array of tags. |
boolean |
isLinkTag() |
boolean |
isParamTag() |
boolean |
isReturnTag() |
boolean |
isSeeTag() |
boolean |
isSerialFieldTag() |
boolean |
isTextTag() |
boolean |
isThrowsTag() |
void |
setTagName(java.lang.String tagName) Sets the name of this doc tag. |
void |
setTagText(java.lang.String tagText) Sets the text of this doc tag. |
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 |
public java.lang.String getTagName() throws JotInvalidElementException
JotInvalidElementException
public void setTagName(java.lang.String tagName) throws JotInvalidElementException
tagName
- the new name of the tag; the '@' should not be included.JotInvalidElementException
public java.lang.String getTagText() throws JotInvalidElementException
JotInvalidElementException
public JotDocTag[] getTextTags() throws JotInvalidElementException
@param paramName the paramName of the param
, would return the portion "the paramName of the param" as tags (in this case a single JotDocTextTag
). A see or link tag, @see String#substring alternate text
would return the "alternate text" portion as tags, or no tags if no alternate text existed.JotInvalidElementException
JotDocTextTag
, JotDocLinkTag
public void setTagText(java.lang.String tagText) throws JotInvalidElementException
tagText
- the new text of this tag.JotInvalidElementException
public boolean isSeeTag() throws JotInvalidElementException
JotDocSeeTag
.JotInvalidElementException
public boolean isLinkTag() throws JotInvalidElementException
JotDocLinkTag
.JotInvalidElementException
public boolean isParamTag() throws JotInvalidElementException
JotDocParamTag
.JotInvalidElementException
public boolean isThrowsTag() throws JotInvalidElementException
JotDocThrowsTag
.JotInvalidElementException
public boolean isReturnTag() throws JotInvalidElementException
JotDocReturnTag
.JotInvalidElementException
public boolean isSerialFieldTag() throws JotInvalidElementException
JotDocSerialFieldTag
.JotInvalidElementException
public boolean isTextTag() throws JotInvalidElementException
JotDocTextTag
.JotInvalidElementException
|
Extension SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.