Interface CodeBlock

All Superinterfaces:

CodeItem, CodeItemWithVariables, CodeMutable, CodeMutableItem, CodeNode, CodeNodeItem, CodeWithContext

All Known Subinterfaces:

CodeBlockBody, CodeBlockDoWhile, CodeBlockFor, CodeBlockIf, CodeBlockInitializer, CodeBlockStatement, CodeBlockWhileDo, CodeBlockWithCondition

public interface CodeBlock
extends CodeNodeItem, CodeItemWithVariables

CodeStatement for a block that groups multiple statements.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
void	add(CodeStatement... statements)
void	addText(String... statements)
CodeBlock	copy()
List<CodeStatement>	getStatements()
default CodeVariable	getVariable(String name)
CodeVariable	getVariable(String name, int statementMaxIndex)
default boolean	isEmpty()

Methods inherited from interface CodeItem

getLanguage, getSourceCode, write, write, write, write, write, write

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

getReflectiveObject, setImmutable

Methods inherited from interface CodeNode

getParent

Methods inherited from interface CodeNodeItem

copy

Methods inherited from interface CodeWithContext

getContext, getSource

Method Details

getVariable

default CodeVariable getVariable(String name)

Specified by:

getVariable in interface CodeItemWithVariables

Parameters:

name - the name of the requested CodeVariable.

Returns:

the CodeVariable with the given name or null if not found.

getVariable

CodeVariable getVariable(String name,
 int statementMaxIndex)

Parameters:

name - the name of the requested CodeVariable.

statementMaxIndex - the maximum index in the statements where to resolve the CodeVariable. Therefore a CodeLocalVariable defined by a statement after the given index will not be considered.

Returns:

the CodeVariable with the given name or null if not found.

getStatements

List<CodeStatement> getStatements()

Returns:

the List of CodeStatement contained inside the block (typically within curly braces). May be empty but never null.

isEmpty

default boolean isEmpty()

Returns:

true if empty, false otherwise.

add

void add(CodeStatement... statements)

Parameters:

statements - the CodeStatements to add.

Throws:

io.github.mmm.base.exception.ReadOnlyException - if immutable.

addText

void addText(String... statements)

Parameters:

statements - the plain textual statements to add as CodeStatements.

Throws:

io.github.mmm.base.exception.ReadOnlyException - if immutable.

copy

CodeBlock copy()

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Returns:

a new mutable copy of this CodeMutableItem. Will be a deep-copy with copies of all child CodeMutableItems.