org.eclipse.jet.core.parser.ast
Class Comment

java.lang.Object
  org.eclipse.jet.core.parser.ast.JETASTElement
      org.eclipse.jet.core.parser.ast.BodyElement
          org.eclipse.jet.core.parser.ast.Comment

public final class Comment
extends BodyElement

An JET AST element representing a comment

Method Summary

protected void	accept0(JETASTVisitor visitor) Visit the AST and its contained elements.
int	getCommentEnd()
int	getCommentStart()
java.lang.String	getCommentText() Return the comment text
boolean	removeLineWhenOtherwiseEmpty() Indicate whether the the surrounding whitespace, including the trailing new line should be removed from the template output.

Methods inherited from class org.eclipse.jet.core.parser.ast.JETASTElement

accept, getAst, getColumn, getEnd, getLine, getNextElement, getParent, getPrevElement, getStart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

accept0

protected final void accept0(JETASTVisitor visitor)

Description copied from class: JETASTElement

Visit the AST and its contained elements.

Specified by:

accept0 in class JETASTElement

See Also:

JETASTElement.accept0(JETASTVisitor)

getCommentEnd

public int getCommentEnd()

Returns:

Returns the commentEnd.

getCommentStart

public int getCommentStart()

Returns:

Returns the commentStart.

getCommentText

public java.lang.String getCommentText()

Return the comment text

Returns:

the comment text

removeLineWhenOtherwiseEmpty

public boolean removeLineWhenOtherwiseEmpty()

Description copied from class: JETASTElement

Indicate whether the the surrounding whitespace, including the trailing new line should be removed from the template output. In general, elements that create output should return false, while element that do should should return true.

Specified by:

removeLineWhenOtherwiseEmpty in class JETASTElement

Returns:

true if the containing line should be removed if otherwise empty.