oracle.jdeveloper.jot
Interface JotComment

All Known Subinterfaces:

JotDocComment

public interface JotComment

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.

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()

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.

getCommentText

public java.lang.String getCommentText()

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.

setCommentText

public void setCommentText(java.lang.String text)

Sets the comment text of this comment. The comment characters should not be included.

Parameters:

text - the new text of the comment.

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.