gov.llnl.babel.symbols

Class Comment

java.lang.Object

gov.llnl.babel.symbols.ASTNode

gov.llnl.babel.symbols.Comment

All Implemented Interfaces:

java.lang.Cloneable

public class Comment
extends ASTNode

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

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
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

Comment

public Comment(java.lang.String[] comment)

This constructor for the 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

getComment

public java.lang.String[] getComment()

Return the comment as an array of strings, with one string for each line of the comment. The return argument may be null, in which case there is no comment text.

isEmpty

public boolean isEmpty()

Return true if the comment is empty (i.e., no lines); otherwise, return false.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Return true if two comments are exactly equal. Two comments are equal if they have the same number of lines, and each corresponding line is equal. This is false if the parameter is not a comment.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to test

combineComments

public static Comment combineComments(Comment original,
                      Comment additional)