|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.javasource.JComment
public final class JComment
A class that represents a Java comment.
Field Summary | |
---|---|
static short |
AUTO_STYLE
The auto style, allows this JComment to automatically choose a style for this comment. |
static short |
BLOCK_STYLE
The block comment style. |
static short |
HEADER_STYLE
The header style, similiar to block, but with an '*' at the start of each line. |
static short |
JAVADOC_STYLE
Similiar to HEADER_STYLE. |
static short |
LINE_STYLE
The line comment style. |
protected static int |
MAX_INDENT
The maximum number of characters to indent comments. |
protected static int |
MAX_LENGTH
The maximum number of characters per line. |
Constructor Summary | |
---|---|
JComment()
Creates a new Java Comment. |
|
JComment(short style)
Creates a new Java comment with the given style. |
Method Summary | |
---|---|
void |
appendComment(java.lang.String comment)
Appends the comment String to this JDocComment. |
void |
print(JSourceWriter jsw)
Prints this JComment using the given JSourceWriter. |
void |
setComment(java.lang.String comment)
Sets the comment String of this JDocComment. |
void |
setStyle(short style)
Sets the style for this JComment. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short AUTO_STYLE
public static final short BLOCK_STYLE
public static final short LINE_STYLE
public static final short HEADER_STYLE
public static final short JAVADOC_STYLE
protected static final int MAX_LENGTH
protected static final int MAX_INDENT
Constructor Detail |
---|
public JComment()
public JComment(short style)
style
- The desired style.Method Detail |
---|
public void appendComment(java.lang.String comment)
comment
- The comment to append.public void setComment(java.lang.String comment)
comment
- The comment String of this JDocComment.public void setStyle(short style)
style
- The style to use for this JComment.public void print(JSourceWriter jsw)
jsw
- The JSourceWriter to print to.public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |