Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotDocTag

All Superinterfaces:
JotCodeElement, JotElement
All Known Subinterfaces:
JotDocLinkTag, JotDocParamTag, JotDocReturnTag, JotDocSeeTag, JotDocTextTag, JotDocThrowsTag

public interface JotDocTag
extends JotCodeElement

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.

Since:
5.0

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

getTagName

public java.lang.String getTagName()
                            throws JotInvalidElementException
Retrieves the name of this doc tag.

Returns:
the name of the tag; the '@' is not included.
Throws:
JotInvalidElementException

setTagName

public void setTagName(java.lang.String tagName)
                throws JotInvalidElementException
Sets the name of this doc tag.

Parameters:
tagName - the new name of the tag; the '@' should not be included.
Throws:
JotInvalidElementException

getTagText

public java.lang.String getTagText()
                            throws JotInvalidElementException
The text of this doc tag.

Returns:
the text of this tag.
Throws:
JotInvalidElementException

getTextTags

public JotDocTag[] getTextTags()
                        throws JotInvalidElementException
Retrieves the text of the comment text portion of the tag as an array of tags. For example, a paramater tag, @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.

Throws:
JotInvalidElementException
See Also:
JotDocTextTag, JotDocLinkTag

setTagText

public void setTagText(java.lang.String tagText)
                throws JotInvalidElementException
Sets the text of this doc tag.

Parameters:
tagText - the new text of this tag.
Throws:
JotInvalidElementException

isSeeTag

public boolean isSeeTag()
                 throws JotInvalidElementException
Returns:
true if this a JotDocSeeTag.
Throws:
JotInvalidElementException

isLinkTag

public boolean isLinkTag()
                  throws JotInvalidElementException
Returns:
true if this a JotDocLinkTag.
Throws:
JotInvalidElementException

isParamTag

public boolean isParamTag()
                   throws JotInvalidElementException
Returns:
true if this a JotDocParamTag.
Throws:
JotInvalidElementException

isThrowsTag

public boolean isThrowsTag()
                    throws JotInvalidElementException
Returns:
true if this a JotDocThrowsTag.
Throws:
JotInvalidElementException

isReturnTag

public boolean isReturnTag()
                    throws JotInvalidElementException
Returns:
true if this a JotDocReturnTag.
Throws:
JotInvalidElementException

isSerialFieldTag

public boolean isSerialFieldTag()
                         throws JotInvalidElementException
Returns:
true if this a JotDocSerialFieldTag.
Throws:
JotInvalidElementException

isTextTag

public boolean isTextTag()
                  throws JotInvalidElementException
Returns:
true if this a JotDocTextTag.
Throws:
JotInvalidElementException

Extension SDK

 

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