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

Class PythonCodeFunction

java.lang.Object

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

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

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

net.ssehub.easy.instantiation.python.codeArtifacts.PythonCodeFunction

All Implemented Interfaces:

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

public class PythonCodeFunction
extends PythonCodeBlock

Represents a Python function 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 PythonCodeDocComment	comment
private List<PythonCodeDecorator>	decorators
private String	name
private List<PythonCodeParamSpec>	params
private PythonCodeTypeSpec	retType

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

KEY_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
PythonCodeFunction(IPythonCodeElement parent, String name)
PythonCodeFunction(IPythonCodeElement parent, String name, String comment)

Method Summary

Modifier and Type	Method	Description
PythonCodeDecorator	addDecorator(String name)
PythonCodeDecorator	addDecorator(String name, PythonCodeImportScope scope)
PythonCodeFunction	addParameter(String name)
PythonCodeFunction	addParameter(String name, String type)
PythonCodeFunction	addParameter(String name, String type, String comment)
PythonCodeFunction	addParameter(String name, PythonCodeTypeSpec type)
PythonCodeFunction	addParameter(String name, PythonCodeTypeSpec type, String comment)
PythonCodeRaise	addRaiseNotImplementedError()	Adds raising a NotImplementedError.
PythonCodeFunction	addRetType(String type)
PythonCodeFunction	addRetType(String type, String comment)
PythonCodeFunction	addReturn(String expr, String comment)
PythonCodeDocComment	getComment()	Returns the comment object.
PythonCodeFunction	setClass()
PythonCodeFunction	setStatic()
void	store(net.ssehub.easy.instantiation.core.model.templateModel.CodeWriter out)

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

add, addAssert, addAssert, addAssign, addAssign, addBreak, addCall, addCall, addClass, addClass, addComment, addContinue, addDelete, addElt, addElt, addEmptyLine, addEnum, addEnum, addFor, addFor, addFor, addFunc, addFunc, addGlobal, addIf, addMatch, addNonLocal, addPass, addPrint, addRaise, addRaw, addReturn, addSelfCall, addSLComment, addSLComment, addSuperCall, addSuperConstructorCall, addTry, addTypeAlias, addWhile, addWith, addWith, getArtifact, getElementCount, getParentClass, isBlock, moveToImports, setBlock

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

name

private String name

retType

private PythonCodeTypeSpec retType

comment

private PythonCodeDocComment comment

decorators

private List<PythonCodeDecorator> decorators

params

private List<PythonCodeParamSpec> params

Constructor Details

PythonCodeFunction

public PythonCodeFunction(IPythonCodeElement parent,
 String name)

PythonCodeFunction

public PythonCodeFunction(IPythonCodeElement parent,
 String name,
 String comment)

Method Details

addParameter

public PythonCodeFunction addParameter(String name)

addParameter

public PythonCodeFunction addParameter(String name,
 String type)

addParameter

public PythonCodeFunction addParameter(String name,
 PythonCodeTypeSpec type)

addParameter

public PythonCodeFunction addParameter(String name,
 String type,
 String comment)

addParameter

public PythonCodeFunction addParameter(String name,
 PythonCodeTypeSpec type,
 String comment)

addReturn

public PythonCodeFunction addReturn(String expr,
 String comment)

addRetType

public PythonCodeFunction addRetType(String type)

addRetType

public PythonCodeFunction addRetType(String type,
 String comment)

addDecorator

public PythonCodeDecorator addDecorator(String name)

addDecorator

public PythonCodeDecorator addDecorator(String name,
 PythonCodeImportScope scope)

addRaiseNotImplementedError

public PythonCodeRaise addRaiseNotImplementedError()

Adds raising a NotImplementedError.

Returns:

the raise statement (for chaining)

setClass

public PythonCodeFunction setClass()

setStatic

public PythonCodeFunction setStatic()

getComment

public PythonCodeDocComment getComment()

Returns the comment object.

Returns:

the comment object, may be null

store

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

Specified by:

store in interface Storable

Overrides:

store in class PythonCodeBlock