|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.llnl.babel.symbols.ASTNode
gov.llnl.babel.symbols.Comment
public class Comment
The Comment
class represents a documentation comment.
The comment is stored as an array of strings, with each array element
representing one line of the comment.
Field Summary |
---|
Fields inherited from class gov.llnl.babel.symbols.ASTNode |
---|
d_frozen |
Constructor Summary | |
---|---|
Comment(java.lang.String[] comment)
This constructor for the Comment class takes an array of
strings, one string for each line of the comment. |
Method Summary | |
---|---|
static Comment |
combineComments(Comment original,
Comment additional)
|
boolean |
equals(java.lang.Object o)
Return true if two comments are exactly equal. |
java.lang.String[] |
getComment()
Return the comment as an array of strings, with one string for each line of the comment. |
int |
hashCode()
|
boolean |
isEmpty()
Return true if the comment is empty (i.e., no lines); otherwise, return false. |
Methods inherited from class gov.llnl.babel.symbols.ASTNode |
---|
checkFrozen, clone, freeze, protectCollection, protectList, protectMap, protectSet |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Comment(java.lang.String[] comment)
Comment
class takes an array of
strings, one string for each line of the comment. The input argument
may be null, which indicates "no comment."
Method Detail |
---|
public java.lang.String[] getComment()
public boolean isEmpty()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- the object to testpublic static Comment combineComments(Comment original, Comment additional)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |