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, EnhancedForStatement, EnhancedForWithRecordPattern, ExpressionStatement, ForStatement, IfStatement, LabeledStatement, ReturnStatement, SuperConstructorInvocation, SwitchCase, SwitchStatement, SynchronizedStatement, ThrowStatement, TryStatement, TypeDeclarationStatement, VariableDeclarationStatement, WhileStatement, YieldStatement

public abstract class Statement extends ASTNode
Since:
2.0
  • Method Details

    • getLeadingComment

      public String getLeadingComment()
      Deprecated.
      This feature was removed in the 2.1 release because it was only a partial, and inadequate, solution to the issue of associating comments with statements. Furthermore, AST.parseCompilationUnit did not associate leading comments, making this moot. Clients that need to access comments preceding a statement should either consult the compilation unit's comment table or use a scanner to reanalyze the source text immediately preceding the statement's source range.
      Returns the leading comment string, including the starting and ending comment delimiters, and any embedded line breaks.

      A leading comment is a comment that appears before the statement. It may be either a traditional comment or an end-of-line comment. Traditional comments must begin with "/*, may contain line breaks, and must end with "*/. End-of-line comments must begin with "//", must end with a line delimiter (as per JLS 3.7), and must not contain line breaks.

      Returns:
      the comment string, or null if none
    • setLeadingComment

      public void setLeadingComment(String comment)
      Deprecated.
      This feature was removed in the 2.1 release because it was only a partial, and inadequate, solution to the issue of associating comments with statements.
      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 a comment that appears before the statement. It may be either a traditional comment or an end-of-line comment. Traditional comments must begin with "/*, may contain line breaks, and must end with "*/. End-of-line comments must begin with "//" (as per JLS 3.7), and must not contain line breaks.

      Examples:

       
       setLeadingComment("/* traditional comment */");  // correct
       setLeadingComment("missing comment delimiters");  // wrong
       setLeadingComment("/* unterminated traditional comment ");  // wrong
       setLeadingComment("/* broken\n traditional comment */");  // correct
       setLeadingComment("// end-of-line comment\n");  // correct
       setLeadingComment("// end-of-line comment without line terminator");  // correct
       setLeadingComment("// broken\n end-of-line comment\n");  // wrong
       
       
      Parameters:
      comment - the comment string, or null if none
      Throws:
      IllegalArgumentException - if the comment string is invalid