Statements (Asteroid API Documentation)

java.lang.Object
- asteroid.Statements

```
public final class Statements
extends java.lang.Object
```
This class hides the different implementations to create expressions through the Groovy api to provide a unified an easier way to create statements when coding an AST transformation.

Since:

0.1.0

Constructor Summary

Constructors
Constructor and Description

Statements()

Constructors
Constructor and Description
`Statements()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static AssertStatement`	`assertS(BooleanExpression booleanExpr)` Returns an instance of `AssertStatement` AST
`static AssertStatement`	`assertS(BooleanExpression booleanExpr, java.lang.String errorMessage)` Returns an instance of `AssertStatement` AST
`static BlockStatement`	`blockS(java.util.List<Statement> statements)` Returns an instance of `BlockStatement`.
`static BlockStatement`	`blockS(Statement... statements)` Returns an instance of `BlockStatement`.
`static BlockStatement`	`blockS(VariableScope variableScope, java.util.List<Statement> statements)` Returns an instance of `BlockStatement`.
`static BlockStatement`	`blockS(VariableScope variableScope, Statement... statements)` Returns an instance of `BlockStatement`.
`static BlockStatement`	`blockSFromString(java.lang.String code)` Returns an instance of `BlockStatement`.
`static Statement`	`ctorSuperS(Expression... args)` Returns an instance of `Statement`.
`static DoWhileStatement`	`doWhileS(BooleanExpression booleanExpr, Statement loopBlock)` Represents a do-while statement.
`static DoWhileStatement`	`doWhileStatement(BooleanExpression booleanExpr, Statement loopBlock)` Deprecated. As of release 2.4.7, replaced by `doWhileS(BooleanExpression, Statement)`
`static Statement`	`emptyS()` Represents an empty statement.
`static Statement`	`emptyStatement()` Deprecated. As of release 2.4.7, replaced by `emptyS()`
`static IfStatement`	`ifElseS(BooleanExpression booleanExpr, Statement ifStmt, Statement elseStmt)` Builds a if-else statement.
`static IfStatement`	`ifS(BooleanExpression booleanExpr, Statement ifStmt)` Builds a if statement, without the else part.
`static ReturnStatement`	`returnS(Expression expression)` Returns an instance of `ReturnStatement` AST
`static Statement`	`stmt(Expression expression)` Returns an instance of `Statement`.
`static ThrowStatement`	`throwS(Expression expression)` Represents how to throw an exception AST
`static TryCatchStatementBuilder`	`tryCatchSBuilder()` Returns an instance of `TryCatchStatementBuilder` to build complex try/catch statements the easy way.
`static WhileStatement`	`whileS(BooleanExpression booleanExpr, Statement loopBlock)` Represents a while statement.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Statements
```
public Statements()
```
- Method Detail
  - returnS
```
public static ReturnStatement returnS(Expression expression)
```
    Returns an instance of ReturnStatement
    
    AST
```
returnS(constX("1"))
```
    Result
```
return "1"
```
    Parameters:
    
    expression -
    
    Returns:
    
    an instance of ReturnStatement
    
    Since:
    
    0.1.0
  - stmt
```
public static Statement stmt(Expression expression)
```
    Returns an instance of Statement. When declaring a MethodNode the body is always whether a ReturnStatement if it returns something or just a Statement if it's void.
    
    AST
```
 // body of a void method
 stmt(callThisX("println", constX("1")));
 
```
    Result
```
println "1"
```
    Parameters:
    
    expression -
    
    Returns:
    
    an instance of Statement
    
    Since:
    
    0.1.0
  - ctorSuperS
```
public static Statement ctorSuperS(Expression... args)
```
    Returns an instance of Statement. This normally will be used to call to a super constructor from the current class:
    
    AST
```
 Statement callSuper = A.STMT
     .ctorSuperS(
         A.EXPR.constX(1),
         A.EXPR.constX(2));
 
```
    Result
```
super(1,2)
```
    Parameters:
    
    args -
    
    Returns:
    
    an instance of type Statement
    
    Since:
    
    0.1.0
  - blockS
```
public static BlockStatement blockS(java.util.List<Statement> statements)
```
    Returns an instance of BlockStatement.
    
    Parameters:
    
    statements - a list of type Statement
    
    Returns:
    
    an instance of BlockStatement
    
    Since:
    
    0.1.0
  - blockS
```
public static BlockStatement blockS(Statement... statements)
```
    Returns an instance of BlockStatement.
    
    Parameters:
    
    statements - a varargs of type Statement
    
    Returns:
    
    an instance of BlockStatement
    
    Since:
    
    0.1.0
  - blockS
```
public static BlockStatement blockS(VariableScope variableScope,
                                    Statement... statements)
```
    Returns an instance of BlockStatement.
    
    Parameters:
    
    variableScope - scope containing ref/local variables
    
    statements - a varargs of type Statement
    
    Returns:
    
    an instance of BlockStatement
    
    Since:
    
    0.1.5
  - blockS
```
public static BlockStatement blockS(VariableScope variableScope,
                                    java.util.List<Statement> statements)
```
    Returns an instance of BlockStatement.
    
    Parameters:
    
    variableScope - scope containing ref/local variables
    
    statements - a list of type Statement
    
    Returns:
    
    an instance of BlockStatement
    
    Since:
    
    0.1.5
  - blockSFromString
```
public static BlockStatement blockSFromString(java.lang.String code)
```
    Returns an instance of BlockStatement. The code contained in the string passed as argument will be parsed and converted to a BlockStatement
    
    Parameters:
    
    code - the string representation of the code
    
    Returns:
    
    an instance of BlockStatement
    
    Since:
    
    0.1.0
  - assertS
```
public static AssertStatement assertS(BooleanExpression booleanExpr)
```
    Returns an instance of AssertStatement
    
    AST
```
assertS(booleanExpr)
```
    Result
```
assert 1 == 1
```
    Parameters:
    
    booleanExpr - the expression we want to check
    
    Returns:
    
    an instance of AssertStatement
    
    Since:
    
    0.1.5
  - assertS
```
public static AssertStatement assertS(BooleanExpression booleanExpr,
                                      java.lang.String errorMessage)
```
    Returns an instance of AssertStatement
    
    AST
```
assertS(booleanExpr, "checking something important")
```
    Result
```
assert 1 == 1 : "checking something important"
```
    Parameters:
    
    booleanExpr - the expression we want to check
    
    errorMessage - the error message in case assertion fails
    
    Returns:
    
    an instance of AssertStatement
    
    Since:
    
    0.1.5
  - tryCatchSBuilder
```
public static TryCatchStatementBuilder tryCatchSBuilder()
```
    Returns an instance of TryCatchStatementBuilder to build complex try/catch statements the easy way. Check TryCatchStatementBuilder javadoc to know how to use it.
    
    Returns:
    
    an instance of TryCatchStatementBuilder
    
    Since:
    
    0.2.3
    
    See Also:
    
    TryCatchStatementBuilder
  - ifS
```
public static IfStatement ifS(BooleanExpression booleanExpr,
                              Statement ifStmt)
```
    Builds a if statement, without the else part. It receives a boolean expression and the code executed in case the boolean expression evaluates to true
    
    AST
```
ifS(boolX('a', Types.COMPARE_GREATER_THAN, 'b'), codeStmt)
```
    Result
```
if (a > b) {
  // content of the codeStmt statement
 }
```
    Parameters:
    
    booleanExpr - the boolean expression used to decide whether the next statement will be executed or not
    
    ifStmt - code that will be executed if the boolean expression evaluates to true
    
    Since:
    
    0.2.4
  - doWhileStatement
```
@Deprecated
public static DoWhileStatement doWhileStatement(BooleanExpression booleanExpr,
                                                            Statement loopBlock)
```
    Deprecated. As of release 2.4.7, replaced by doWhileS(BooleanExpression, Statement)
    
    Represents a do-while statement. A do while loop is a control flow statement that executes a block of code at least once, and then repeatedly executes the block, or not, depending on a given boolean condition at the end of the block
    
    Parameters:
    
    booleanExpr - boolean condition
    
    loopBlock - the block that could be repeated
    
    Returns:
    
    an instance of type DoWhileStatement
    
    Since:
    
    0.2.6
  - doWhileS
```
public static DoWhileStatement doWhileS(BooleanExpression booleanExpr,
                                        Statement loopBlock)
```
    Represents a do-while statement. A do while loop is a control flow statement that executes a block of code at least once, and then repeatedly executes the block, or not, depending on a given boolean condition at the end of the block
    
    Parameters:
    
    booleanExpr - boolean condition
    
    loopBlock - the block that could be repeated
    
    Returns:
    
    an instance of type DoWhileStatement
    
    Since:
    
    0.2.7
  - whileS
```
public static WhileStatement whileS(BooleanExpression booleanExpr,
                                    Statement loopBlock)
```
    Represents a while statement. A while loop is a control flow statement that executes maybe repeatedly a code block, depending on a given boolean condition.
    
    Parameters:
    
    booleanExpr - boolean condition
    
    loopBlock - the block that could be repeated
    
    Returns:
    
    an instance of type DoWhileStatement
    
    Since:
    
    0.2.7
  - emptyStatement
```
public static Statement emptyStatement()
```
    Deprecated. As of release 2.4.7, replaced by emptyS()
    
    Represents an empty statement. It could be used when building an IfStatement with an empty else part.
    
    Returns:
    
    an empty Statement
    
    Since:
    
    0.2.4
  - emptyS
```
public static Statement emptyS()
```
    Represents an empty statement. It could be used when building an IfStatement with an empty else part.
    
    Returns:
    
    an empty Statement
    
    Since:
    
    0.2.7
  - ifElseS
```
public static IfStatement ifElseS(BooleanExpression booleanExpr,
                                  Statement ifStmt,
                                  Statement elseStmt)
```
    Builds a if-else statement. It receives a boolean expression and two statements corresponding to the both if and else parts
    
    AST
```
ifElseS(boolX('a', Types.COMPARE_GREATER_THAN, 'b'), ifStmt, elseStmt)
```
    Result
```
if (a > b) {
  // ifStmt code
 } else {
  // elseStmt
 }
```
    Parameters:
    
    booleanExpr - the boolean expression used to decide whether the next statement will be executed or not
    
    ifStmt - code that will be executed if the boolean expression evaluates to true
    
    Since:
    
    0.2.4
  - throwS
```
public static ThrowStatement throwS(Expression expression)
```
    Represents how to throw an exception AST
```
throwS(newX(IllegalStateException, constX('wrong value')))
```
    Result
```
throw new IllegalStateException('wrong value')
```
    Parameters:
    
    expression - it will be normally a representation of a new instance of a given Throwable type
    
    Returns:
    
    an instance of ThrowStatement
    
    Since:
    
    0.2.4

Class Statements

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Statements

Method Detail

returnS

stmt

ctorSuperS

blockS

blockS

blockS

blockS

blockSFromString

assertS

assertS

tryCatchSBuilder

ifS

doWhileStatement

doWhileS

whileS

emptyStatement

emptyS

ifElseS

throwS