com.borland.jbuilder.jot
Interface JotComment

All Superinterfaces:
JotMarker, JotSourceElement

public interface JotComment
extends JotMarker, JotSourceElement

This interface represents a Java comment. Java comments come in three styles: traditional (block), single-line, and documentation. See chapters 3.7 and 18 of the Java Language Specification for more information.


Field Summary
static int BLOCK
          Traditional (block) comment type.
static int DOC
          Documentation comment type.
static int LINE
          Single-line comment type.
static int NONE
          Comment has no type.
 
Method Summary
 java.lang.String getCommentText()
          Returns the entire text of the comment including enclosing comment symbols.
 java.lang.String getNormalText()
          Only valid if the type of this comment is DOC.
 java.lang.String getSummaryText()
          Returns the first sentence of a documentation comment.
 int getType()
          Returns the type of this comment.
 
Methods inherited from interface com.borland.jbuilder.jot.JotMarker
addUserData, getEndPosition, getStartPosition, getUserData
 
Methods inherited from interface com.borland.jbuilder.jot.JotSourceElement
getIndentLevel, getParent, getText, isModified, setModified, setText
 

Field Detail

NONE

public static final int NONE
Comment has no type.

BLOCK

public static final int BLOCK
Traditional (block) comment type.

LINE

public static final int LINE
Single-line comment type.

DOC

public static final int DOC
Documentation comment type.
Method Detail

getType

public int getType()
Returns the type of this comment. The valid values are NONE, BLOCK, LINE, and DOC.

getCommentText

public java.lang.String getCommentText()
Returns the entire text of the comment including enclosing comment symbols.

getSummaryText

public java.lang.String getSummaryText()
Returns the first sentence of a documentation comment.

getNormalText

public java.lang.String getNormalText()
Only valid if the type of this comment is DOC.