Package de.fraunhofer.iese.mydata.component.information.method

Class MethodInterfaceDescription

java.lang.Object

de.fraunhofer.iese.mydata.common.MyDataEntity

de.fraunhofer.iese.mydata.component.information.method.MethodInterfaceDescription

@Entity
public class MethodInterfaceDescription
extends MyDataEntity

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

Author:

Fraunhofer IESE

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	A description of the method.
protected Long	id	The component_id.
protected @NotBlank String	methodName	The name of the method.
protected PepComponentInformation	pepComponentInformation
protected PipComponentInformation	pipComponentInformation
protected PxpComponentInformation	pxpComponentInformation
protected @NotBlank String	returnType	The return type of the method.

Constructor Summary

Constructors

Constructor	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	Description
void	addParameter(InputParameterDescription param)	Adds the parameter.
boolean	equals(Object obj)
List<InputParameterDescription>	getParameters()
Class<?>	getReturnTypeClass()	Gets the return type of the method.
int	hashCode()
void	setParameters(List<InputParameterDescription> parameters)
void	setReturnType(Class<?> clazz)

Methods inherited from class de.fraunhofer.iese.mydata.common.MyDataEntity

fromJson, getGson, getGson, toJson, toString, validate, validateAndNullCheck

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

The component_id.

methodName

@NotBlank
protected @NotBlank String methodName

The name of the method.

description

protected String description

A description of the method.

returnType

@NotBlank
protected @NotBlank String returnType

The return type of the method.

pipComponentInformation

protected PipComponentInformation pipComponentInformation

pepComponentInformation

protected PepComponentInformation pepComponentInformation

pxpComponentInformation

protected PxpComponentInformation pxpComponentInformation

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,
                                  @Nonnull
                                  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(@Nonnull
                         InputParameterDescription param)

Adds the parameter.

Parameters:

param - the param

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getReturnTypeClass

public Class<?> getReturnTypeClass()
                            throws ClassNotFoundException

Gets the return type of the method.

Returns:

the return type of the method

Throws:

ClassNotFoundException

setReturnType

public void setReturnType(Class<?> clazz)

Parameters:

clazz -

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getParameters

public List<InputParameterDescription> getParameters()

Returns:

the list of inputparametersdescription elements

setParameters

public void setParameters(@Nonnull
                          List<InputParameterDescription> parameters)

Parameters:

parameters -