de.fraunhofer.iese.ind2uce.api.component.description

Class MethodInterfaceDescription

java.lang.Object

de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

de.fraunhofer.iese.ind2uce.api.component.description.MethodInterfaceDescription

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ModifierInterfaceDescription

@Entity
public class MethodInterfaceDescription
extends Ind2uceEntity

Describes an interface of a method. Contains of a name, a list of parameters and a return type.

Author:

Fraunhofer IESE

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description A description of the method.
protected Long	id The id.
protected String	methodName The name of the method.
protected String	returnType The return type of the method.

Fields inherited from class de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

GSON_DEFAULT, GSON_PLAIN, GSON_PRETTY, version

Constructor Summary

Constructors

Constructor and Description
MethodInterfaceDescription(String methodName, Class<?> returnType, String description) Instantiates a new interface description.
MethodInterfaceDescription(String methodName, Class<?> returnType, String description, InputParameterDescription... parameters) Instantiates a new interface description.
MethodInterfaceDescription(String methodName, Class<?> returnType, String description, List<InputParameterDescription> parameters) Instantiates a new interface description.

Method Summary

Modifier and Type	Method and Description
void	addParameter(InputParameterDescription param) Adds the parameter.
boolean	equals(Object obj)
String	getDescription() Gets the a description of the method.
Long	getId() Gets the id.
String	getMethodName() Gets the name of the method.
List<InputParameterDescription>	getParameters() Gets the a list of parameters.
Class<?>	getReturnType() Gets the return type of the method.
String	getReturnTypeName() Gets the return type name.
int	hashCode()
void	setDescription(String description) Sets the a description of the method.
void	setId(Long id) Sets the id.
void	setMethodName(String methodName) Sets the name of the method.
void	setParameters(List<InputParameterDescription> parameters) Sets the a list of parameters.
void	setReturnType(Class<?> returnType) Sets the return type of the method.

Methods inherited from class de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

fromJson, getGson, getVersion, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected Long id

The id.

description

protected String description

A description of the method.

methodName

protected String methodName

The name of the method.

returnType

protected String returnType

The return type of the method.

Constructor Detail

MethodInterfaceDescription

public MethodInterfaceDescription(String methodName,
                                  Class<?> returnType,
                                  String description)

Instantiates a new interface description.

Parameters:

methodName - name of the method

returnType - return type of the method

description - description of the method

MethodInterfaceDescription

public MethodInterfaceDescription(String methodName,
                                  Class<?> returnType,
                                  String description,
                                  InputParameterDescription... parameters)

Instantiates a new interface description.

Parameters:

methodName - name of the method

returnType - return type of the method

description - description of the method

parameters - a list of parameters for the method

MethodInterfaceDescription

public MethodInterfaceDescription(String methodName,
                                  Class<?> returnType,
                                  String description,
                                  List<InputParameterDescription> parameters)

Instantiates a new interface description.

Parameters:

methodName - name of the method

returnType - return type of the method

description - description of the method

parameters - a list of parameters for the method

Method Detail

addParameter

public void addParameter(InputParameterDescription param)

Adds the parameter.

Parameters:

param - the param

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDescription

public String getDescription()

Gets the a description of the method.

Returns:

the a description of the method

getId

public Long getId()

Gets the id.

Returns:

the id

getMethodName

public String getMethodName()

Gets the name of the method.

Returns:

the name of the method

getParameters

public List<InputParameterDescription> getParameters()

Gets the a list of parameters.

Returns:

the a list of parameters

getReturnType

public Class<?> getReturnType()

Gets the return type of the method.

Returns:

the return type of the method

getReturnTypeName

public String getReturnTypeName()

Gets the return type name.

Returns:

the return type name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setDescription

public void setDescription(String description)

Sets the a description of the method.

Parameters:

description - the new a description of the method

setId

public void setId(Long id)

Sets the id.

Parameters:

id - the new id

setMethodName

public void setMethodName(String methodName)

Sets the name of the method.

Parameters:

methodName - the new name of the method

setParameters

public void setParameters(List<InputParameterDescription> parameters)

Sets the a list of parameters.

Parameters:

parameters - the new a list of parameters

setReturnType

public void setReturnType(Class<?> returnType)

Sets the return type of the method.

Parameters:

returnType - the new return type of the method