org.eclipse.jdt.core.dom
Class Statement

java.lang.Object
  |
  +--org.eclipse.jdt.core.dom.ASTNode
        |
        +--org.eclipse.jdt.core.dom.Statement

Direct Known Subclasses:

AssertStatement, Block, BreakStatement, ConstructorInvocation, ContinueStatement, DoStatement, EmptyStatement, ExpressionStatement, ForStatement, IfStatement, LabeledStatement, ReturnStatement, SuperConstructorInvocation, SwitchCase, SwitchStatement, SynchronizedStatement, ThrowStatement, TryStatement, TypeDeclarationStatement, VariableDeclarationStatement, WhileStatement

public abstract class Statement

extends ASTNode

Abstract base class of AST nodes that represent statements. There are many kinds of statements.

The grammar combines both Statement and BlockStatement.

 Statement:
    Block
    IfStatement
    ForStatement
    WhileStatement
    DoStatement
    TryStatement
    SwitchStatement
    SynchronizedStatement
    ReturnStatement
    ThrowStatement
    BreakStatement
    ContinueStatement
    EmptyStatement
    ExpressionStatement
    LabeledStatement
    AssertStatement
    VariableDeclarationStatement
    TypeDeclarationStatement
    ConstructorInvocation
    SuperConstructorInvocation
 

Since:

2.0

Field Summary

Fields inherited from class org.eclipse.jdt.core.dom.ASTNode

ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, MALFORMED, METHOD_DECLARATION, METHOD_INVOCATION, NULL_LITERAL, NUMBER_LITERAL, PACKAGE_DECLARATION, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, QUALIFIED_NAME, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT

Method Summary

String	getLeadingComment() Returns the leading comment string, including the starting and ending comment delimiters, and any embedded line breaks.
void	setLeadingComment(String comment) Sets or clears the leading comment string.

Methods inherited from class org.eclipse.jdt.core.dom.ASTNode

accept, copySubtree, copySubtrees, equals, getAST, getFlags, getLength, getNodeType, getParent, getProperty, getRoot, getStartPosition, properties, setFlags, setProperty, setSourceRange, subtreeBytes, subtreeMatch, toString

Methods inherited from class java.lang.Object

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

Method Detail

getLeadingComment

public String getLeadingComment()

Returns the leading comment string, including the starting and ending comment delimiters, and any embedded line breaks.

A leading comment is one that appears before the statement. It may be either an end-of-line or a multi-line comment. Multi-line comments may contain line breaks; end-of-line comments must not.

Returns:

the comment string, or null if none

setLeadingComment

public void setLeadingComment(String comment)

Sets or clears the leading comment string. The comment string must include the starting and ending comment delimiters, and any embedded linebreaks.

A leading comment is one that appears before the statement. It may be either an end-of-line or a multi-line comment. Multi-line comments may contain line breaks; end-of-line comments must not.

Examples:

 setLeadingComment("/* single-line comment */") - correct
 setLeadingComment("missing comment delimiters") - wrong!
 setLeadingComment("/* unterminated comment ") - wrong!
 setLeadingComment("// end-of-line comment") - correct
 setLeadingComment("/* multi-line\n comment */")  - correct
 setLeadingComment("// broken end-of-line\n comment ") - wrong!
 

Parameters:

comment - the comment string, or null if none

Throws:

IllegalArgumentException - if the comment string is invalid