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

Class PythonCodeDocComment

java.lang.Object

net.ssehub.easy.instantiation.python.codeArtifacts.PythonCodeDocComment

All Implemented Interfaces:

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

public class PythonCodeDocComment
extends Object
implements IPythonCodeElement

Represents a Python doc comment in VTL.

Author:

Kevin Schaperjahn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	PythonCodeDocComment.ParamComment
private class	PythonCodeDocComment.ReturnComment

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 IPythonCodeElement	attachedTo
private String	comment
private List<PythonCodeDocComment.ParamComment>	params
private PythonCodeDocComment.ReturnComment	returnComment

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

KEY_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
PythonCodeDocComment(String comment, IPythonCodeElement attachedTo)
PythonCodeDocComment(IPythonCodeElement attachedTo)

Method Summary

Modifier and Type	Method	Description
PythonCodeDocComment	addParameterComment(String name, String comment)
PythonCodeDocComment	addParameterComment(String name, String type, String comment)
PythonCodeDocComment	addReturnComment(String comment)
PythonCodeDocComment	addReturnType(String type)
IPythonCodeArtifact	getArtifact()
String	getComment()
int	getElementCount()
IPythonCodeElement	getParent()
void	setComment(String comment)
void	setParent(IPythonCodeElement parent)
void	store(net.ssehub.easy.instantiation.core.model.templateModel.CodeWriter out)

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, isClass, isEmptyLine, moveToAttributes, moveToImports

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

toCode

Field Details

comment

private String comment

attachedTo

private IPythonCodeElement attachedTo

params

private List<PythonCodeDocComment.ParamComment> params

returnComment

private PythonCodeDocComment.ReturnComment returnComment

Constructor Details

PythonCodeDocComment

public PythonCodeDocComment(IPythonCodeElement attachedTo)

PythonCodeDocComment

public PythonCodeDocComment(String comment,
 IPythonCodeElement attachedTo)

Method Details

getComment

public String getComment()

setComment

public void setComment(String comment)

store

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

Specified by:

store in interface Storable

getElementCount

public int getElementCount()

Specified by:

getElementCount in interface Storable

addParameterComment

public PythonCodeDocComment addParameterComment(String name,
 String comment)

addParameterComment

public PythonCodeDocComment addParameterComment(String name,
 String type,
 String comment)

addReturnComment

public PythonCodeDocComment addReturnComment(String comment)

addReturnType

public PythonCodeDocComment addReturnType(String type)

getArtifact

public IPythonCodeArtifact getArtifact()

Specified by:

getArtifact in interface IPythonCodeElement

getParent

public IPythonCodeElement getParent()

Specified by:

getParent in interface IPythonCodeElement

setParent

public void setParent(IPythonCodeElement parent)

Specified by:

setParent in interface IPythonCodeElement