Class BaseBlock

java.lang.Object

io.github.mmm.code.base.item.BaseItem

io.github.mmm.code.base.item.BaseMutableItem

io.github.mmm.code.base.node.BaseNodeItem

io.github.mmm.code.base.block.BaseBlock

All Implemented Interfaces:

io.github.mmm.code.api.block.CodeBlock, io.github.mmm.code.api.CodeWithContext, io.github.mmm.code.api.item.CodeItem, io.github.mmm.code.api.item.CodeItemWithVariables, io.github.mmm.code.api.item.CodeMutableItem, io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.node.CodeNodeItem, io.github.mmm.code.api.object.CodeMutable

Direct Known Subclasses:

BaseBlockBody, BaseBlockInitializer, BaseBlockStatement

public abstract class BaseBlock
extends BaseNodeItem
implements io.github.mmm.code.api.block.CodeBlock

Base implementation of CodeBlock.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface io.github.mmm.code.api.item.CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Constructor Summary

Constructors

Constructor	Description
BaseBlock(io.github.mmm.code.api.statement.CodeStatement... statements)	The constructor.
BaseBlock(BaseBlock template, io.github.mmm.code.api.copy.CodeCopyMapper mapper)	The copy-constructor.
BaseBlock(List<io.github.mmm.code.api.statement.CodeStatement> statements)	The constructor.

Method Summary

Modifier and Type	Method	Description
void	add(io.github.mmm.code.api.statement.CodeStatement... codeStatements)
void	addText(String... textStatements)
protected void	doSetImmutable()	Called on the first call of BaseMutableItem.setImmutable().
protected void	doWrite(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language)
List<io.github.mmm.code.api.statement.CodeStatement>	getStatements()
io.github.mmm.code.api.expression.CodeVariable	getVariable(String name)
io.github.mmm.code.api.expression.CodeVariable	getVariable(String name, int statementIndex)
protected abstract io.github.mmm.code.api.expression.CodeVariable	getVariableFromParent(String name)
protected void	writePrefix(Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes a prefix e.g. for loops.
protected void	writeSuffix(Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes a suffix e.g. for do-while loops.

Methods inherited from class BaseNodeItem

doInitialize, getContainerItem, getContainerItemDeclared, getContext, getLanguage, getSource, toPathString

Methods inherited from class BaseMutableItem

doCopyNode, doCopyNodeUnsafe, doMapList, doneInitialize, getDefaultCopyMapper, getDefaultEncoding, getReflectiveObject, getSourceCodeObject, initialize, initialize, isImmutable, isInitialized, isInitializing, isSystemImmutable, isSystemImmutable, makeImmutable, makeImmutable, setImmutable, setImmutableIfNotSystemImmutable, verifyMutalbe, writeItem

Methods inherited from class BaseItem

getOwningType, getSourceCode, getSpaces, toString, write

Methods inherited from class Object

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

Methods inherited from interface io.github.mmm.code.api.block.CodeBlock

copy, isEmpty

Methods inherited from interface io.github.mmm.code.api.item.CodeItem

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

Methods inherited from interface io.github.mmm.code.api.object.CodeMutable

isImmutable, isMutable

Methods inherited from interface io.github.mmm.code.api.item.CodeMutableItem

getReflectiveObject, setImmutable

Methods inherited from interface io.github.mmm.code.api.node.CodeNode

getParent

Methods inherited from interface io.github.mmm.code.api.node.CodeNodeItem

copy

Methods inherited from interface io.github.mmm.code.api.CodeWithContext

getContext, getSource

Constructor Details

BaseBlock

public BaseBlock(io.github.mmm.code.api.statement.CodeStatement... statements)

The constructor.

Parameters:

statements - the statements.

BaseBlock

public BaseBlock(List<io.github.mmm.code.api.statement.CodeStatement> statements)

The constructor.

Parameters:

statements - the statements.

BaseBlock

public BaseBlock(BaseBlock template,
 io.github.mmm.code.api.copy.CodeCopyMapper mapper)

The copy-constructor.

Parameters:

template - the BaseBlock to copy.

mapper - the CodeCopyMapper.

Method Details

getVariable

public io.github.mmm.code.api.expression.CodeVariable getVariable(String name)

Specified by:

getVariable in interface io.github.mmm.code.api.block.CodeBlock

Specified by:

getVariable in interface io.github.mmm.code.api.item.CodeItemWithVariables

getVariable

public io.github.mmm.code.api.expression.CodeVariable getVariable(String name,
 int statementIndex)

Specified by:

getVariable in interface io.github.mmm.code.api.block.CodeBlock

getVariableFromParent

protected abstract io.github.mmm.code.api.expression.CodeVariable getVariableFromParent(String name)

Parameters:

name - the name of the requested CodeVariable.

Returns:

the CodeVariable declared by the parent node with the given name or null if not found.

doSetImmutable

protected void doSetImmutable()

Description copied from class: BaseMutableItem

Called on the first call of BaseMutableItem.setImmutable(). Has to be overridden to update Collections, make child items immutable, etc.

Overrides:

doSetImmutable in class BaseMutableItem

getStatements

public List<io.github.mmm.code.api.statement.CodeStatement> getStatements()

Specified by:

getStatements in interface io.github.mmm.code.api.block.CodeBlock

add

public void add(io.github.mmm.code.api.statement.CodeStatement... codeStatements)

Specified by:

add in interface io.github.mmm.code.api.block.CodeBlock

addText

public void addText(String... textStatements)

Specified by:

addText in interface io.github.mmm.code.api.block.CodeBlock

doWrite

protected void doWrite(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent,
 io.github.mmm.code.api.language.CodeLanguage language)
                throws IOException

Specified by:

doWrite in class BaseItem

Parameters:

sink - the Appendable where to append the code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the defaultIndent will be appended.

language - the CodeLanguage to use.

Throws:

IOException - if thrown by Appendable.

See Also:

• CodeItem.write(Appendable, String, String)

writePrefix

protected void writePrefix(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                    throws IOException

Writes a prefix e.g. for loops.

Parameters:

sink - the Appendable where to append the code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the indent will be appended.

Throws:

IOException - if thrown by Appendable.

writeSuffix

protected void writeSuffix(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                    throws IOException

Writes a suffix e.g. for do-while loops.

Parameters:

sink - the Appendable where to append the code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the indent will be appended.

Throws:

IOException - if thrown by Appendable.