oracle.jdeveloper.jot
Interface JotDocComment
- All Superinterfaces:
- JotCodeElement, JotComment, JotElement
- public interface JotDocComment
- extends JotComment
The JotDocComment
represents instances of javadoc comment blocks. A javadoc comment consists of a description, which can be empty, and an optional list of doc tags.
- Since:
- 5.0
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 |
getDescriptionText
public java.lang.String getDescriptionText()
throws JotInvalidElementException
- Retrieves the description text of this javadoc comment. The description text consists of all the text before the first tag. Any '*' characters at the starts of lines are omitted, as is the leading whitespace.
-
- Throws:
JotInvalidElementException
setDescriptionText
public void setDescriptionText(java.lang.String text)
throws JotInvalidElementException
- Sets the description text of this javadoc comment. Any existing text is removed. The comment text will be automatically wrapped and any needed whitespace and '*' characters will be added.
-
- Parameters:
text
- the new text.
- Throws:
JotInvalidElementException
getDescriptionTextTags
public JotDocTag[] getDescriptionTextTags()
throws JotInvalidElementException
- Finds and tags nested within the description text portion of this comment.
-
- Returns:
- an array of
JotDocTag
s found.
- Throws:
JotInvalidElementException
- See Also:
JotDocLinkTag
getTags
public JotDocTag[] getTags()
throws JotInvalidElementException
- Retrieves the javadoc doc tags associated with this comment.
-
- Throws:
JotInvalidElementException
addTag
public JotDocTag addTag(JotDocTag marker,
boolean before,
java.lang.String tagName,
java.lang.String tagText)
throws JotInvalidElementException
- Adds a new doc tag.
-
- Parameters:
marker
- the doc tag to position relative to.
before
- whether to position the new doc tag before or after the marker doc tag; or, if the marker is null
, whether to position the new doc tag at the beginning or the end of the doc tag list.
tagName
- the name of the new tag; the '@' character should be omitted.
tagText
- the text of the new tag.
- Returns:
- the new doc tag as a JotDocTag.
- Throws:
JotInvalidElementException
removeTag
public void removeTag(JotDocTag tag)
throws JotInvalidElementException
-
- Throws:
JotInvalidElementException
removeAllTags
public void removeAllTags()
throws JotInvalidElementException
-
- Throws:
JotInvalidElementException
getRawCommentText
public java.lang.String getRawCommentText()
throws JotInvalidElementException
-
- Returns:
- the entire comment as raw text.
- Throws:
JotInvalidElementException
setRawCommentText
public void setRawCommentText(java.lang.String commentText)
throws JotInvalidElementException
- sets the entire comment's text.
-
- Throws:
JotInvalidElementException
getTags
public JotDocTag[] getTags(java.lang.String tagName)
throws JotInvalidElementException
-
- Parameters:
tagName
- the name of tags, as a String, to return.
- Returns:
- an array of all
JotDocTag
items of the given type.
- Throws:
JotInvalidElementException
getSeeTags
public JotDocSeeTag[] getSeeTags()
throws JotInvalidElementException
-
- Returns:
- an array of all
JotDocSeeTag
tags present in the comment..
- Throws:
JotInvalidElementException
getElement
public JotElement getElement()
throws JotInvalidElementException
-
- Returns:
- the actual
JotElement
that this comment documents.
- Throws:
JotInvalidElementException
Copyright © 1997, 2004, Oracle. All rights reserved.