com.helger.jcodemodel

Class JBlock

java.lang.Object

com.helger.jcodemodel.JBlock

All Implemented Interfaces:

IJGenerable, IJStatement

Direct Known Subclasses:

JLambdaBlock

public class JBlock
extends Object
implements IJGenerable, IJStatement

A block of Java code, which may contain statements and local declarations.

JBlock contains a large number of factory methods that creates new statements/declarations. Those newly created statements/declarations are inserted into the "current position". The position advances one every time you add a new instruction.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_BRACES_REQUIRED
static boolean	DEFAULT_INDENT_REQUIRED
static boolean	DEFAULT_VIRTUAL_BLOCK
protected List<Object>	m_aContentList Declarations and statements contained in this block.

Constructor Summary

Constructors

Modifier	Constructor and Description
	JBlock()
protected	JBlock(boolean bBracesRequired, boolean bIndentRequired) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
JBreak	_break() Create a break statement without a label and add it to this block
JBreak	_break(JLabel aLabel) Create a break statement with an optional label and add it to this block
JContinue	_continue() Create a continue statement without a label and add it to this block
JContinue	_continue(JLabel aLabel) Create a continue statement with an optional label and add it to this block
JDoLoop	_do(IJExpression test) Create a Do statement and add it to this block
JForLoop	_for() Create a For statement and add it to this block
JConditional	_if(IJExpression aTestExpr) Create an If statement and add it to this block
JConditional	_if(IJExpression aTestExpr, IJStatement aThen) Create an If statement with the respective then statement and add it to this block
JConditional	_if(IJExpression aTestExpr, IJStatement aThen, IJStatement aElse) Create an If statement with the respective then and else statements and add it to this block
protected <T> T	_insert(T aStatementOrDeclaration)
JInvocation	_new(AbstractJClass c)
JInvocation	_new(AbstractJType t)
JReturn	_return() Create a return statement and add it to this block
JReturn	_return(IJExpression aExpr) Create a return statement and add it to this block
JSwitch	_switch(IJExpression test) Create a switch/case statement and add it to this block
JThrow	_throw(IJExpression aExpr) Create a throw statement and add it to this block
JTryBlock	_try() Create a Try statement and add it to this block
JWhileLoop	_while(IJExpression test) Create a While statement and add it to this block
JBlock	add(IJStatement s) Adds a statement to this block
JBlock	assign(IJAssignmentTarget lhs, IJExpression exp) Creates an assignment statement and adds it to this block.
JBlock	assignDivide(IJAssignmentTarget lhs, IJExpression exp)
JBlock	assignMinus(IJAssignmentTarget lhs, IJExpression exp)
JBlock	assignPlus(IJAssignmentTarget lhs, IJExpression exp)
JBlock	assignTimes(IJAssignmentTarget lhs, IJExpression exp)
JBlock	block() Create a sub-block and add it to this block.
JBlock	block(boolean bBracesRequired, boolean bIndentRequired) Create a sub-block and add it to this block
JBlock	blockSimple() Create a sub-block and add it to this block.
JBlock	blockVirtual() Create a sub-block and add it to this block.
boolean	bracesRequired()
JBlock	bracesRequired(boolean bBracesRequired)
JVar	decl(AbstractJType type, String name) Adds a local variable declaration to this block
JVar	decl(AbstractJType type, String name, IJExpression init) Adds a local variable declaration to this block
JVar	decl(int mods, AbstractJType type, String name) Adds a local variable declaration to this block
JVar	decl(int mods, AbstractJType type, String name, IJExpression init) Adds a local variable declaration to this block
IJStatement	directStatement(String sSource) Creates a "literal" statement directly.
JForEach	forEach(AbstractJType aVarType, String sName, IJExpression aCollection) Creates an enhanced For statement based on j2se 1.5 JLS and add it to this block
void	generate(JFormatter f)
List<Object>	getContents()
boolean	indentRequired()
JBlock	indentRequired(boolean bIndentRequired)
JBlock	insertBefore(JVar var, Object before)
JInvocation	invoke(IJExpression expr, JMethod method) Creates an invocation statement and adds it to this block.
JInvocation	invoke(IJExpression expr, String method) Creates an invocation statement and adds it to this block.
JInvocation	invoke(JMethod aMethod) Creates an invocation statement and adds it to this block.
JInvocation	invoke(String sMethod) Creates an invocation statement and adds it to this block.
JInvocation	invokeThis(JMethod method) Creates an invocation statement and adds it to this block.
JInvocation	invokeThis(String method) Creates an invocation statement and adds it to this block.
boolean	isEmpty()
JLabel	label(String name) Create a label, which can be referenced from continue and break statements.
int	pos()
int	pos(int nNewPos) Sets the current position.
void	remove(int index)
void	remove(Object o)
void	removeAll() Remove all elements.
int	size()
void	state(JFormatter f)
JInvocation	staticInvoke(AbstractJClass aType, String sMethod) Creates a static invocation statement.
JSynchronizedBlock	synchronizedBlock(IJExpression aExpr) Create a synchronized block statement and add it to this block
boolean	virtual()
JBlock	virtual(boolean bVirtualBlock) Mark this block virtual or not.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VIRTUAL_BLOCK

public static final boolean DEFAULT_VIRTUAL_BLOCK

See Also:

Constant Field Values

DEFAULT_BRACES_REQUIRED

public static final boolean DEFAULT_BRACES_REQUIRED

See Also:

Constant Field Values

DEFAULT_INDENT_REQUIRED

public static final boolean DEFAULT_INDENT_REQUIRED

See Also:

Constant Field Values

m_aContentList

protected final List<Object> m_aContentList

Declarations and statements contained in this block. Either IJStatement or IJDeclaration.

Constructor Detail

JBlock

public JBlock()

JBlock

@Deprecated
protected JBlock(boolean bBracesRequired,
                 boolean bIndentRequired)

Deprecated.

Method Detail

virtual

public boolean virtual()

Returns:

true if this is a virtual block never emitting braces or indent. The default is DEFAULT_VIRTUAL_BLOCK

virtual

@Nonnull
public JBlock virtual(boolean bVirtualBlock)

Mark this block virtual or not. Default is false.

Parameters:

bVirtualBlock - true to make this block a virtual block.

Returns:

this for chaining

bracesRequired

public boolean bracesRequired()

bracesRequired

@Nonnull
public JBlock bracesRequired(boolean bBracesRequired)

indentRequired

public boolean indentRequired()

indentRequired

@Nonnull
public JBlock indentRequired(boolean bIndentRequired)

getContents

@Nonnull
public List<Object> getContents()

Returns:

a read-only view of IJStatements and IJDeclaration in this block.

_insert

@Nonnull
protected final <T> T _insert(@Nonnull
                    T aStatementOrDeclaration)

remove

public void remove(Object o)

remove

public void remove(@Nonnegative
          int index)

removeAll

public void removeAll()

Remove all elements.

pos

@Nonnegative
public int pos()

Returns:

the current position to which new statements will be inserted. For example if the value is 0, newly created instructions will be inserted at the very beginning of the block.

See Also:

pos(int)

pos

@Nonnegative
public int pos(@Nonnegative
                  int nNewPos)

Sets the current position.

Parameters:

nNewPos - The new position to set

Returns:

the old value of the current position.

Throws:

IllegalArgumentException - if the new position value is illegal.

See Also:

pos()

isEmpty

public boolean isEmpty()

Returns:

true if this block is empty and does not contain any statement.

size

@Nonnegative
public int size()

Returns:

The number of elements contained in the block. Always ≥ 0.

decl

@Nonnull
public JVar decl(@Nonnull
                AbstractJType type,
                @Nonnull
                String name)

Adds a local variable declaration to this block

Parameters:

type - JType of the variable

name - Name of the variable

Returns:

Newly generated JVar

decl

@Nonnull
public JVar decl(int mods,
                @Nonnull
                AbstractJType type,
                @Nonnull
                String name)

Adds a local variable declaration to this block

Parameters:

mods - Modifiers for the variable

type - JType of the variable

name - Name of the variable

Returns:

Newly generated JVar

decl

@Nonnull
public JVar decl(@Nonnull
                AbstractJType type,
                @Nonnull
                String name,
                @Nullable
                IJExpression init)

Adds a local variable declaration to this block

Parameters:

type - JType of the variable

name - Name of the variable

init - Initialization expression for this variable. May be null.

Returns:

Newly generated JVar

decl

@Nonnull
public JVar decl(int mods,
                @Nonnull
                AbstractJType type,
                @Nonnull
                String name,
                @Nullable
                IJExpression init)

Adds a local variable declaration to this block

Parameters:

mods - Modifiers for the variable

type - JType of the variable

name - Name of the variable

init - Initialization expression for this variable. May be null.

Returns:

Newly generated JVar

insertBefore

@Nonnull
public JBlock insertBefore(@Nonnull
                          JVar var,
                          @Nonnull
                          Object before)

assign

@Nonnull
public JBlock assign(@Nonnull
                    IJAssignmentTarget lhs,
                    @Nonnull
                    IJExpression exp)

Creates an assignment statement and adds it to this block.

Parameters:

lhs - Assignable variable or field for left hand side of expression

exp - Right hand side expression

Returns:

this for chaining

assignPlus

@Nonnull
public JBlock assignPlus(@Nonnull
                        IJAssignmentTarget lhs,
                        @Nonnull
                        IJExpression exp)

assignMinus

@Nonnull
public JBlock assignMinus(@Nonnull
                         IJAssignmentTarget lhs,
                         @Nonnull
                         IJExpression exp)

assignTimes

@Nonnull
public JBlock assignTimes(@Nonnull
                         IJAssignmentTarget lhs,
                         @Nonnull
                         IJExpression exp)

assignDivide

@Nonnull
public JBlock assignDivide(@Nonnull
                          IJAssignmentTarget lhs,
                          @Nonnull
                          IJExpression exp)

invoke

@Nonnull
public JInvocation invoke(@Nonnull
                         IJExpression expr,
                         @Nonnull
                         String method)

Creates an invocation statement and adds it to this block.

Parameters:

expr - IJExpression evaluating to the class or object upon which the named method will be invoked

method - Name of method to invoke

Returns:

Newly generated JInvocation

invokeThis

@Nonnull
public JInvocation invokeThis(@Nonnull
                             String method)

Creates an invocation statement and adds it to this block.

Parameters:

method - Name of method to invoke on this

Returns:

Newly generated JInvocation

invoke

@Nonnull
public JInvocation invoke(@Nonnull
                         IJExpression expr,
                         @Nonnull
                         JMethod method)

Creates an invocation statement and adds it to this block.

Parameters:

expr - IJExpression evaluating to the class or object upon which the method will be invoked

method - JMethod to invoke

Returns:

Newly generated JInvocation

invokeThis

@Nonnull
public JInvocation invokeThis(@Nonnull
                             JMethod method)

Creates an invocation statement and adds it to this block.

Parameters:

method - JMethod to invoke on this

Returns:

Newly generated JInvocation

staticInvoke

@Nonnull
public JInvocation staticInvoke(@Nonnull
                               AbstractJClass aType,
                               @Nonnull
                               String sMethod)

Creates a static invocation statement.

Parameters:

aType - Type upon which the method should be invoked

sMethod - Name of method to invoke

Returns:

Newly generated JInvocation

invoke

@Nonnull
public JInvocation invoke(@Nonnull
                         String sMethod)

Creates an invocation statement and adds it to this block.

Parameters:

sMethod - Name of method to invoke

Returns:

Newly generated JInvocation

invoke

@Nonnull
public JInvocation invoke(@Nonnull
                         JMethod aMethod)

Creates an invocation statement and adds it to this block.

Parameters:

aMethod - JMethod to invoke

Returns:

Newly generated JInvocation

_new

@Nonnull
public JInvocation _new(@Nonnull
                       AbstractJClass c)

_new

@Nonnull
public JInvocation _new(@Nonnull
                       AbstractJType t)

add

@Nonnull
public JBlock add(@Nonnull
                 IJStatement s)

Adds a statement to this block

Parameters:

s - JStatement to be added

Returns:

This block

_if

@Nonnull
public JConditional _if(@Nonnull
                       IJExpression aTestExpr)

Create an If statement and add it to this block

Parameters:

aTestExpr - JExpression to be tested to determine branching

Returns:

Newly generated conditional statement

_if

@Nonnull
public JConditional _if(@Nonnull
                       IJExpression aTestExpr,
                       @Nonnull
                       IJStatement aThen)

Create an If statement with the respective then statement and add it to this block

Parameters:

aTestExpr - JExpression to be tested to determine branching

aThen - The then-block. May not be null.

Returns:

Newly generated conditional statement

_if

@Nonnull
public JConditional _if(@Nonnull
                       IJExpression aTestExpr,
                       @Nonnull
                       IJStatement aThen,
                       @Nonnull
                       IJStatement aElse)

Create an If statement with the respective then and else statements and add it to this block

Parameters:

aTestExpr - JExpression to be tested to determine branching

aThen - The then-block. May not be null.

aElse - The else-block. May not be null.

Returns:

Newly generated conditional statement

_for

@Nonnull
public JForLoop _for()

Create a For statement and add it to this block

Returns:

Newly generated For statement. Never null.

_while

@Nonnull
public JWhileLoop _while(@Nonnull
                        IJExpression test)

Create a While statement and add it to this block

Parameters:

test - Test expression for the while statement

Returns:

Newly generated JWhileLoop statement

_switch

@Nonnull
public JSwitch _switch(@Nonnull
                      IJExpression test)

Create a switch/case statement and add it to this block

Parameters:

test - Test expression for the switch statement

Returns:

Newly created JSwitch

_do

@Nonnull
public JDoLoop _do(@Nonnull
                  IJExpression test)

Create a Do statement and add it to this block

Parameters:

test - Test expression for the while statement

Returns:

Newly generated JDoLoop statement

_try

@Nonnull
public JTryBlock _try()

Create a Try statement and add it to this block

Returns:

Newly generated JTryBlock statement

_return

@Nonnull
public JReturn _return()

Create a return statement and add it to this block

Returns:

Newly created JReturn statement

_return

@Nonnull
public JReturn _return(@Nullable
                      IJExpression aExpr)

Create a return statement and add it to this block

Parameters:

aExpr - Expression to be returned. May be null.

Returns:

Newly created JReturn statement

_throw

@Nonnull
public JThrow _throw(@Nonnull
                    IJExpression aExpr)

Create a throw statement and add it to this block

Parameters:

aExpr - Expression to be thrown

Returns:

Newly created JThrow

_break

@Nonnull
public JBreak _break()

Create a break statement without a label and add it to this block

Returns:

Newly created JBreak

_break

@Nonnull
public JBreak _break(@Nullable
                    JLabel aLabel)

Create a break statement with an optional label and add it to this block

Parameters:

aLabel - Optional label for the break statement

Returns:

Newly created JBreak

label

@Nonnull
public JLabel label(@Nonnull
                   String name)

Create a label, which can be referenced from continue and break statements.

Parameters:

name - Label name

Returns:

Newly created JLabel

_continue

@Nonnull
public JContinue _continue()

Create a continue statement without a label and add it to this block

Returns:

New JContinue

_continue

@Nonnull
public JContinue _continue(@Nullable
                          JLabel aLabel)

Create a continue statement with an optional label and add it to this block

Parameters:

aLabel - Optional label statement.

Returns:

New JContinue

block

@Nonnull
public JBlock block()

Create a sub-block and add it to this block. By default braces and indent are required.

Returns:

New JBlock

See Also:

block(boolean, boolean), blockSimple()

blockSimple

@Nonnull
public JBlock blockSimple()

Create a sub-block and add it to this block. By default braces and indent are not required.

Returns:

New JBlock

See Also:

block(), block(boolean, boolean)

blockVirtual

@Nonnull
public JBlock blockVirtual()

Create a sub-block and add it to this block. This kind of block will never create braces or indent!

Returns:

New JBlock

See Also:

block(), block(boolean, boolean)

block

@Nonnull
public JBlock block(boolean bBracesRequired,
                   boolean bIndentRequired)

Create a sub-block and add it to this block

Parameters:

bBracesRequired - true if braces should be required

bIndentRequired - true if indentation is required

Returns:

New JBlock

See Also:

block(), blockSimple()

forEach

@Nonnull
public JForEach forEach(@Nonnull
                       AbstractJType aVarType,
                       @Nonnull
                       String sName,
                       @Nonnull
                       IJExpression aCollection)

Creates an enhanced For statement based on j2se 1.5 JLS and add it to this block

Parameters:

aVarType - Variable type

sName - Variable name

aCollection - Collection to be iterated

Returns:

Newly generated enhanced For statement per j2se 1.5 specification

synchronizedBlock

@Nonnull
public JSynchronizedBlock synchronizedBlock(@Nonnull
                                           IJExpression aExpr)

Create a synchronized block statement and add it to this block

Parameters:

aExpr - The expression to synchronize on. May not be null.

Returns:

Newly generated synchronized block. Never null.

Since:

2.7.10

directStatement

@Nonnull
public IJStatement directStatement(@Nonnull
                                  String sSource)

Creates a "literal" statement directly.

Specified string is printed as-is. This is useful as a short-cut.

For example, you can invoke this method as: directStatement("a=b+c;").

Parameters:

sSource - The source code to state. May not be null.

Returns:

The created direct statement.

generate

public void generate(@Nonnull
            JFormatter f)

Specified by:

generate in interface IJGenerable

state

public void state(@Nonnull
         JFormatter f)

Specified by:

state in interface IJStatement