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

Class PythonCodeClass

java.lang.Object

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

net.ssehub.easy.instantiation.python.codeArtifacts.PythonCodeClass

All Implemented Interfaces:

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

Direct Known Subclasses:

PythonCodeEnum

public class PythonCodeClass
extends PythonCodeElement

Represents a Python "class" 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 List<PythonCodeTypeSpec>	bases
private PythonCodeDocComment	comment
private List<IPythonCodeElement>	elements
private String	name

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

KEY_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
PythonCodeClass(IPythonCodeElement parent, String name)	Creates a class.
PythonCodeClass(IPythonCodeElement parent, String name, String comment)	Creates a class with comment.

Method Summary

Modifier and Type	Method	Description
PythonCodeClass	add(String text)
protected <T extends IPythonCodeElement> T	add(T element)
PythonCodeAssign	addAttribute(String name, String initExpr)
PythonCodeAssign	addAttribute(String name, String type, String initExpr)
PythonCodeClass	addBase(String type)
PythonCodeClass	addBase(String type, PythonCodeImportScope scope)
PythonCodeClass	addClass(String name)
PythonCodeClass	addComment(String comment)
PythonCodeFunction	addConstructor()
PythonCodeFunction	addConstructor(String comment)
PythonCodeClass	addEmptyLine()
PythonCodeFunction	addGetter(String varName)
PythonCodeFunction	addGetter(String varName, String type)
PythonCodeFunction	addMethod(String name)
PythonCodeFunction	addMethod(String name, String comment)
PythonCodeFunction	addSetter(String varName)
PythonCodeFunction	addSetter(String varName, String type)
PythonCodeClass	addSLComment(String comment)
PythonCodeClass	addSLComment(String comment, boolean enclosed)
String	getName()	Returns the class name.
(package private) static PythonCodeClass	getParentCodeClass(IPythonCodeElement element)
boolean	isClass()	Returns whether this element is a class(-like) element.
void	moveToAttributes(IPythonCodeElement element)	Moves the given code element after the last attribute at the beginning of (this) class, or, if there are no attributes, to the front.
(package private) static void	setParent(IPythonCodeElement parent, Consumer<PythonCodeClass> consumer)
void	store(net.ssehub.easy.instantiation.core.model.templateModel.CodeWriter out)
void	storeElements(net.ssehub.easy.instantiation.core.model.templateModel.CodeWriter out)

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

getArtifact, 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, isBlock, isEmptyLine, moveToImports

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

getElementCount, toCode

Field Details

name

private String name

elements

private List<IPythonCodeElement> elements

bases

private List<PythonCodeTypeSpec> bases

comment

private PythonCodeDocComment comment

Constructor Details

PythonCodeClass

PythonCodeClass(IPythonCodeElement parent,
 String name)

Creates a class.

Parameters:

parent - the parent code element

name - the class name

PythonCodeClass

PythonCodeClass(IPythonCodeElement parent,
 String name,
 String comment)

Creates a class with comment.

Parameters:

parent - the parent code element

name - the class name

comment - the comment

Method Details

getName

public String getName()

Returns the class name.

Returns:

the class name

add

public PythonCodeClass add(String text)

addEmptyLine

public PythonCodeClass addEmptyLine()

addClass

public PythonCodeClass addClass(String name)

addAttribute

public PythonCodeAssign addAttribute(String name,
 String initExpr)

addAttribute

public PythonCodeAssign addAttribute(String name,
 String type,
 String initExpr)

add

protected <T extends IPythonCodeElement> T add(T element)

addBase

public PythonCodeClass addBase(String type)

addBase

public PythonCodeClass addBase(String type,
 PythonCodeImportScope scope)

addMethod

public PythonCodeFunction addMethod(String name)

addMethod

public PythonCodeFunction addMethod(String name,
 String comment)

addGetter

public PythonCodeFunction addGetter(String varName)

addGetter

public PythonCodeFunction addGetter(String varName,
 String type)

addSetter

public PythonCodeFunction addSetter(String varName)

addSetter

public PythonCodeFunction addSetter(String varName,
 String type)

addConstructor

public PythonCodeFunction addConstructor()

addConstructor

public PythonCodeFunction addConstructor(String comment)

addComment

public PythonCodeClass addComment(String comment)

addSLComment

public PythonCodeClass addSLComment(String comment)

addSLComment

public PythonCodeClass addSLComment(String comment,
 boolean enclosed)

setParent

static void setParent(IPythonCodeElement parent,
 Consumer<PythonCodeClass> consumer)

getParentCodeClass

static PythonCodeClass getParentCodeClass(IPythonCodeElement element)

store

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

storeElements

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

isClass

public boolean isClass()

Description copied from interface: IPythonCodeElement

Returns whether this element is a class(-like) element.

Returns:

true for class, false else

moveToAttributes

public void moveToAttributes(IPythonCodeElement element)

Description copied from interface: IPythonCodeElement

Moves the given code element after the last attribute at the beginning of (this) class, or, if there are no attributes, to the front.

Parameters:

element - the element to move