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

Class InputParameterDescription

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

@Entity
public class InputParameterDescription
extends Ind2uceEntity

The Class InputParameterDescription is used by different component as PXP, PIP, PEP and others to specify MethodInterfaceDescription at the time of registration at PMP.

See Also:

Serialized Form

Field Summary

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

GSON_DEFAULT, GSON_PLAIN, GSON_PRETTY, version

Constructor Summary

Constructors

Constructor and Description
InputParameterDescription(String name, String description, Class<?> type) Instantiates a new input parameter description.
InputParameterDescription(String name, String description, String pattern, boolean mandatory, Class<?> type) Instantiates a new input parameter description.
InputParameterDescription(String name, String description, String pattern, boolean mandatory, Type type) Instantiates a new input parameter description.
InputParameterDescription(String name, String description, String pattern, boolean mandatory, Type type, JsonType jsonType, List<TypeDescription> parameterTypeDescription) Instantiates a new input parameter description.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() Gets the a description about what the parameter is used for.
Long	getId() Gets the id.
JsonType	getJsonType()
String	getName() Gets the name.
List<TypeDescription>	getParameterTypeDescription() Gets the parameter type description.
String	getPattern() Gets the a regular expression, the parameter has to adhere to.
Class<?>	getType() Gets the parameter type.
String	getTypeDescription() Gets the type description.
String	getTypeName() Gets the type name.
int	hashCode()
boolean	isMandatory() Checks if is a flag, indicating whether the parameter is mandatory or not.
void	setDescription(String description) Sets the a description about what the parameter is used for.
void	setId(Long id) Sets the id.
void	setJsonType(JsonType jsonType)
void	setMandatory(boolean mandatory) Sets the a flag, indicating whether the parameter is mandatory or not.
void	setName(String name) Sets the name.
void	setParameterTypeDescription(List<TypeDescription> parameterTypeDescription) Sets the parameter type description.
void	setPattern(String pattern) Sets the a regular expression, the parameter has to adhere to.
void	setType(Class<?> type) Sets the parameter type.
void	setTypeDescription(String typeDescription) Sets the type description.

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

Constructor Detail

InputParameterDescription

public InputParameterDescription(String name,
                                 String description,
                                 Class<?> type)

Instantiates a new input parameter description.

Parameters:

name - the name of the parameter

description - the description of the parameter

type - the type of the parameter

InputParameterDescription

public InputParameterDescription(String name,
                                 String description,
                                 String pattern,
                                 boolean mandatory,
                                 Class<?> type)

Instantiates a new input parameter description.

Parameters:

name - the name of the parameter

description - the description of the parameter

pattern - the pattern the parameter value has to adhere to

mandatory - indication a parameter that is mandatory

type - the type of the parameter

InputParameterDescription

public InputParameterDescription(String name,
                                 String description,
                                 String pattern,
                                 boolean mandatory,
                                 Type type)

Instantiates a new input parameter description.

Parameters:

name - the name

description - the description

pattern - the pattern

mandatory - the mandatory

type - the type

InputParameterDescription

public InputParameterDescription(String name,
                                 String description,
                                 String pattern,
                                 boolean mandatory,
                                 Type type,
                                 JsonType jsonType,
                                 List<TypeDescription> parameterTypeDescription)

Instantiates a new input parameter description.

Parameters:

name - the name

description - the description

pattern - the pattern

mandatory - the mandatory

type - the type

jsonType - the json type

parameterTypeDescription - the parameter type description

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDescription

public String getDescription()

Gets the a description about what the parameter is used for.

Returns:

the a description about what the parameter is used for

getId

public Long getId()

Gets the id.

Returns:

the id

getJsonType

public JsonType getJsonType()

Returns:

the jsonType

getName

public String getName()

Gets the name.

Returns:

the name

getParameterTypeDescription

public List<TypeDescription> getParameterTypeDescription()

Gets the parameter type description.

Returns:

the parameter type description

getPattern

public String getPattern()

Gets the a regular expression, the parameter has to adhere to.

Returns:

the a regular expression, the parameter has to adhere to

getType

public Class<?> getType()

Gets the parameter type.

Returns:

the parameter type

getTypeDescription

public String getTypeDescription()

Gets the type description.

Returns:

the type description

getTypeName

public String getTypeName()

Gets the type name.

Returns:

the type name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isMandatory

public boolean isMandatory()

Checks if is a flag, indicating whether the parameter is mandatory or not.

Returns:

the a flag, indicating whether the parameter is mandatory or not

setDescription

public void setDescription(String description)

Sets the a description about what the parameter is used for.

Parameters:

description - the new a description about what the parameter is used for

setId

public void setId(Long id)

Sets the id.

Parameters:

id - the new id

setJsonType

public void setJsonType(JsonType jsonType)

Parameters:

jsonType - the jsonType to set

setMandatory

public void setMandatory(boolean mandatory)

Sets the a flag, indicating whether the parameter is mandatory or not.

Parameters:

mandatory - the new a flag, indicating whether the parameter is mandatory or not

setName

public void setName(String name)

Sets the name.

Parameters:

name - the new name

setParameterTypeDescription

public void setParameterTypeDescription(List<TypeDescription> parameterTypeDescription)

Sets the parameter type description.

Parameters:

parameterTypeDescription - the new parameter type description

setPattern

public void setPattern(String pattern)

Sets the a regular expression, the parameter has to adhere to.

Parameters:

pattern - the new a regular expression, the parameter has to adhere to

setType

public void setType(Class<?> type)

Sets the parameter type.

Parameters:

type - the new parameter type

setTypeDescription

public void setTypeDescription(String typeDescription)

Sets the type description.

Parameters:

typeDescription - the new type description