Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotComment

All Superinterfaces:
JotCodeElement, JotElement
All Known Subinterfaces:
JotDocComment

public interface JotComment
extends JotCodeElement


Field Summary
static int BLOCK
          A constant designating a block comment.
static int DOC
          A constant designating a documentation comment.
static int LINE
          A constant designating a line comment.
static int NONE
          A constant designating an improperly formatted comment.
 
Method Summary
 JotDocComment getAsDocComment()
          Retrieves this comment as a doc comment.
 java.lang.String getCommentText()
          Retrieves the comment text of this JotComment instance.
 java.lang.String getText()
          Deprecated.  
 int getType()
          Retrieves the type of comment represented by this JotComment instance.
 void setCommentText(java.lang.String text)
          Sets the comment text of this comment.
 
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
 

Field Detail

NONE

public static final int NONE
A constant designating an improperly formatted comment.

See Also:
Constant Field Values

BLOCK

public static final int BLOCK
A constant designating a block comment.

See Also:
Constant Field Values

LINE

public static final int LINE
A constant designating a line comment.

See Also:
Constant Field Values

DOC

public static final int DOC
A constant designating a documentation comment.

See Also:
Constant Field Values
Method Detail

getType

public int getType()
Retrieves the type of comment represented by this JotComment instance.

Returns:
one of this class' constants.

getText

public java.lang.String getText()
                         throws JotInvalidElementException
Deprecated.  

Retrieves the text of this JotComment instance. The comment delimiters are returned as part of the string.

Returns:
the text of this JotComment, including the delimiters.
Throws:
JotInvalidElementException

getCommentText

public java.lang.String getCommentText()
                                throws JotInvalidElementException
Retrieves the comment text of this JotComment instance. The comment delimiters are not included.

Returns:
the comment text of this JotComment, not including the comment delimiters.
Throws:
JotInvalidElementException

setCommentText

public void setCommentText(java.lang.String text)
                    throws JotInvalidElementException
Sets the comment text of this comment. The comment characters should not be included.

Parameters:
text - the new text of the comment.
Throws:
JotInvalidElementException

getAsDocComment

public JotDocComment getAsDocComment()
Retrieves this comment as a doc comment. If this comment is not a doc comment, null is returned.

Returns:
this comment as a doc comment.

Extension SDK

 

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