Package net.ssehub.easy.instantiation.python.codeArtifacts

Class PythonCodeBlock

java.lang.Object

net.ssehub.easy.instantiation.python.codeArtifacts.PythonCodeElement

net.ssehub.easy.instantiation.python.codeArtifacts.PythonCodeStmt

net.ssehub.easy.instantiation.python.codeArtifacts.PythonCodeBlock

All Implemented Interfaces:

net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider, net.ssehub.easy.instantiation.core.model.vilTypes.IVilType, IPythonCodeElement, Storable

Direct Known Subclasses:

PythonCodeAlternative, PythonCodeForLoop, PythonCodeFunction, PythonCodeMatch.PythonCodeCase, PythonCodeTryBlock, PythonCodeTryBlock.PythonCodeExceptBlock, PythonCodeWhileLoop, PythonCodeWith

public class PythonCodeBlock
extends PythonCodeStmt

Represents a Python code block in VTL.

Author:

Kevin Schaperjahn

Nested Class Summary

Nested classes/interfaces inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider

net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider.StringComparator

Field Summary

Fields

Modifier and Type	Field	Description
private IPythonCodeArtifact	artifact
private List<IPythonCodeElement>	elements

Fields inherited from interface net.ssehub.easy.instantiation.python.codeArtifacts.IPythonCodeElement

KEY_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
PythonCodeBlock(IPythonCodeArtifact artifact)
PythonCodeBlock(IPythonCodeElement parent)

Method Summary

Modifier and Type	Method	Description
void	add(String text)
PythonCodeAssert	addAssert(String expr)
PythonCodeAssert	addAssert(String expr, String msg)
PythonCodeAssign	addAssign(String varName, String expr)
PythonCodeAssign	addAssign(String varName, String type, String expr)
void	addBreak()	Adds a "break" statement.
PythonCodeFnCall	addCall(String name)
PythonCodeFnCall	addCall(String name, PythonCodeImportScope scope)
PythonCodeClass	addClass(String name)	Adds a class without comment.
PythonCodeClass	addClass(String name, String comment)	Adds a class with comment.
PythonCodeBlock	addComment(String comment)
void	addContinue()	Adds a "continue" statement.
PythonCodeDelete	addDelete(String varName)
protected <T extends IPythonCodeElement> T	addElt(T elt)
protected <T extends IPythonCodeElement> T	addElt(T elt, boolean importToFront)
void	addEmptyLine()
PythonCodeEnum	addEnum(String name)	Adds an enum without comment.
PythonCodeEnum	addEnum(String name, String comment)	Adds an enum with comment.
PythonCodeForLoop	addFor(String element, String array)
PythonCodeForLoop	addFor(String element, String rangeStart, String rangeEnd)
PythonCodeForLoop	addFor(String element, String rangeStart, String rangeEnd, String rangeStep)
PythonCodeFunction	addFunc(String name)
PythonCodeFunction	addFunc(String name, String comment)
PythonCodeGlobal	addGlobal(String varName)
PythonCodeAlternative	addIf(String condition)
PythonCodeMatch	addMatch(String expr)
PythonCodeNonLocal	addNonLocal(String varName)
void	addPass()	Adds a "pass" statement.
PythonCodeFnCall	addPrint()	Adds a "print" function call.
PythonCodeRaise	addRaise(String expression)
void	addRaw(String text, boolean indent)
void	addReturn(String value)
PythonCodeFnCall	addSelfCall(String name)	Adds a call to "self.".
PythonCodeBlock	addSLComment(String comment)
PythonCodeBlock	addSLComment(String comment, boolean enclosed)
PythonCodeFnCall	addSuperCall(String name)	Adds a call to "super()".
PythonCodeFnCall	addSuperConstructorCall()	Adds a call to "super().__init__(...)".
PythonCodeTryBlock	addTry()
PythonCodeTypeAlias	addTypeAlias(String name, String expr)
PythonCodeWhileLoop	addWhile(String condition)
PythonCodeWith	addWith(String expr)
PythonCodeWith	addWith(String expr, String varName)
IPythonCodeArtifact	getArtifact()
int	getElementCount()
protected PythonCodeClass	getParentClass()
boolean	isBlock()	Returns whether this element is a block element.
void	moveToImports(IPythonCodeImport imp)	Moves the given import after the last import at the beginning of (this) artifact, or, if there are no imports, to the front.
PythonCodeBlock	setBlock(PythonCodeBlock block)
void	store(net.ssehub.easy.instantiation.core.model.templateModel.CodeWriter out)

Methods inherited from class net.ssehub.easy.instantiation.python.codeArtifacts.PythonCodeElement

getParent, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ssehub.easy.instantiation.python.codeArtifacts.IPythonCodeElement

addAll, getSortKey, getStringValue, getTopClass, getTracerStringValue, hasPythondocComment, isAttribute, isClass, isEmptyLine, moveToAttributes

Methods inherited from interface net.ssehub.easy.instantiation.python.codeArtifacts.Storable

toCode

Field Details

elements

private List<IPythonCodeElement> elements

artifact

private IPythonCodeArtifact artifact

Constructor Details

PythonCodeBlock

public PythonCodeBlock(IPythonCodeElement parent)

PythonCodeBlock

public PythonCodeBlock(IPythonCodeArtifact artifact)

Method Details

addElt

protected <T extends IPythonCodeElement> T addElt(T elt)

addElt

protected <T extends IPythonCodeElement> T addElt(T elt,
 boolean importToFront)

add

public void add(String text)

addRaw

public void addRaw(String text,
 boolean indent)

addEmptyLine

public void addEmptyLine()

addClass

public PythonCodeClass addClass(String name)

Adds a class without comment.

Parameters:

name - the name of the class

Returns:

the class for chaining

addClass

public PythonCodeClass addClass(String name,
 String comment)

Adds a class with comment.

Parameters:

name - the name of the class

comment - the comment for the class

Returns:

the class for chaining

addEnum

public PythonCodeEnum addEnum(String name)

Adds an enum without comment.

Parameters:

name - the name of the enum

Returns:

the enum for chaining

addEnum

public PythonCodeEnum addEnum(String name,
 String comment)

Adds an enum with comment.

Parameters:

name - the name of the enum

comment - the comment for the enum

Returns:

the enum for chaining

addFunc

public PythonCodeFunction addFunc(String name)

addFunc

public PythonCodeFunction addFunc(String name,
 String comment)

addTypeAlias

public PythonCodeTypeAlias addTypeAlias(String name,
 String expr)

addAssign

public PythonCodeAssign addAssign(String varName,
 String expr)

addAssign

public PythonCodeAssign addAssign(String varName,
 String type,
 String expr)

addCall

public PythonCodeFnCall addCall(String name)

addSuperCall

public PythonCodeFnCall addSuperCall(String name)

Adds a call to "super()".

Parameters:

name - the name of the function

Returns:

the function call for chaining

addSuperConstructorCall

public PythonCodeFnCall addSuperConstructorCall()

Adds a call to "super().__init__(...)".

Returns:

the function call for chaining

addSelfCall

public PythonCodeFnCall addSelfCall(String name)

Adds a call to "self.".

Parameters:

name - the name of the function

Returns:

the function for chaining

addCall

public PythonCodeFnCall addCall(String name,
 PythonCodeImportScope scope)

addIf

public PythonCodeAlternative addIf(String condition)

addMatch

public PythonCodeMatch addMatch(String expr)

addWhile

public PythonCodeWhileLoop addWhile(String condition)

addFor

public PythonCodeForLoop addFor(String element,
 String array)

addFor

public PythonCodeForLoop addFor(String element,
 String rangeStart,
 String rangeEnd)

addFor

public PythonCodeForLoop addFor(String element,
 String rangeStart,
 String rangeEnd,
 String rangeStep)

addWith

public PythonCodeWith addWith(String expr)

addWith

public PythonCodeWith addWith(String expr,
 String varName)

addTry

public PythonCodeTryBlock addTry()

addRaise

public PythonCodeRaise addRaise(String expression)

addComment

public PythonCodeBlock addComment(String comment)

addSLComment

public PythonCodeBlock addSLComment(String comment)

addSLComment

public PythonCodeBlock addSLComment(String comment,
 boolean enclosed)

addDelete

public PythonCodeDelete addDelete(String varName)

addNonLocal

public PythonCodeNonLocal addNonLocal(String varName)

addGlobal

public PythonCodeGlobal addGlobal(String varName)

addAssert

public PythonCodeAssert addAssert(String expr)

addAssert

public PythonCodeAssert addAssert(String expr,
 String msg)

addReturn

public void addReturn(String value)

addContinue

public void addContinue()

Adds a "continue" statement.

addBreak

public void addBreak()

Adds a "break" statement.

addPass

public void addPass()

Adds a "pass" statement.

addPrint

public PythonCodeFnCall addPrint()

Adds a "print" function call.

Returns:

the function call

setBlock

public PythonCodeBlock setBlock(PythonCodeBlock block)

store

public void store(net.ssehub.easy.instantiation.core.model.templateModel.CodeWriter out)

getElementCount

public int getElementCount()

getParentClass

protected PythonCodeClass getParentClass()

getArtifact

public IPythonCodeArtifact getArtifact()

Specified by:

getArtifact in interface IPythonCodeElement

Overrides:

getArtifact in class PythonCodeElement

isBlock

public boolean isBlock()

Description copied from interface: IPythonCodeElement

Returns whether this element is a block element.

Returns:

true for block, false else

moveToImports

public void moveToImports(IPythonCodeImport imp)

Description copied from interface: IPythonCodeElement

Moves the given import after the last import at the beginning of (this) artifact, or, if there are no imports, to the front.

Parameters:

imp - the import to move