de.fraunhofer.iese.ind2uce.api.policy

Class PipRequest<T>

java.lang.Object

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

de.fraunhofer.iese.ind2uce.api.policy.PipRequest<T>

Type Parameters:

T - the expected return type of the evaluation

All Implemented Interfaces:

ParameterListProvider, Serializable

public class PipRequest<T>
extends Ind2uceEntity
implements ParameterListProvider

A request that instructs the PIP.

Author:

Fraunhofer IESE

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
PipRequest(String name, T defaultValue, Parameter<?>... params) Instantiates a new pip request.
PipRequest(String name, T defaultValue, ParameterList params) Instantiates a new pip request.

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter<?> param) Adds a parameter.
<R> void	addParameter(String name, R value) Adds a parameter.
void	clearParameters() Removes all parameters.
boolean	equals(Object obj)
DataObject<?>	getDefaultValue() Gets the default value that is returned in case of errors.
String	getName() Gets the name of the method to be evaluated.
Parameter<?>	getParameterForName(String name) Gets a parameter.
ParameterList	getParameters() Gets the list of all parameters.
<R> R	getParameterValue(String name, Class<R> clazz) Gets a parameter value.
void	removeParameter(String name) Adds a parameter.
void	setDefaultValue(DataObject<T> defaultValue) Sets the default value that is returned in case of errors.
void	setName(String name) Sets the name of the method to be evaluated.
void	setParameters(ParameterList params) Replaces all parameters with the parameters of the provided list.

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, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PipRequest

public PipRequest(String name,
                  T defaultValue,
                  Parameter<?>... params)

Instantiates a new pip request.

Parameters:

name - the name of the method to be executed

defaultValue - the default value for error cases

params - parameters used for evaluation

PipRequest

public PipRequest(String name,
                  T defaultValue,
                  ParameterList params)

Instantiates a new pip request.

Parameters:

name - the name of the method to be executed

defaultValue - the default value for error cases

params - parameters used for evaluation

Method Detail

addParameter

public void addParameter(Parameter<?> param)

Description copied from interface: ParameterListProvider

Adds a parameter.

Specified by:

addParameter in interface ParameterListProvider

Parameters:

param - the parameter to add

addParameter

public <R> void addParameter(String name,
                             R value)

Description copied from interface: ParameterListProvider

Adds a parameter.

Specified by:

addParameter in interface ParameterListProvider

Type Parameters:

R - the generic type

Parameters:

name - the name of the parameter

value - the value of the parameter

clearParameters

public void clearParameters()

Description copied from interface: ParameterListProvider

Removes all parameters.

Specified by:

clearParameters in interface ParameterListProvider

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDefaultValue

public DataObject<?> getDefaultValue()

Gets the default value that is returned in case of errors.

Returns:

the default value that is returned in case of errors

getName

public String getName()

Gets the name of the method to be evaluated.

Returns:

the name of the method to be evaluated

getParameterForName

public Parameter<?> getParameterForName(String name)

Description copied from interface: ParameterListProvider

Gets a parameter.

Specified by:

getParameterForName in interface ParameterListProvider

Parameters:

name - the name of the parameter

Returns:

the parameter with the given name, or null if it does not exist

getParameters

public ParameterList getParameters()

Description copied from interface: ParameterListProvider

Gets the list of all parameters.

Specified by:

getParameters in interface ParameterListProvider

Returns:

the list of all parameters

getParameterValue

public <R> R getParameterValue(String name,
                               Class<R> clazz)

Description copied from interface: ParameterListProvider

Gets a parameter value.

Specified by:

getParameterValue in interface ParameterListProvider

Type Parameters:

R - the generic type

Parameters:

name - the name of the parameter

clazz - the value of the parameter

Returns:

the value of the parameter, or null if it does not exist

removeParameter

public void removeParameter(String name)

Description copied from interface: ParameterListProvider

Adds a parameter.

Specified by:

removeParameter in interface ParameterListProvider

Parameters:

name - the name of the parameter to be deleted

setDefaultValue

public void setDefaultValue(DataObject<T> defaultValue)

Sets the default value that is returned in case of errors.

Parameters:

defaultValue - the new default value that is returned in case of errors

setName

public void setName(String name)

Sets the name of the method to be evaluated.

Parameters:

name - the new name of the method to be evaluated

setParameters

public void setParameters(ParameterList params)

Description copied from interface: ParameterListProvider

Replaces all parameters with the parameters of the provided list.

Specified by:

setParameters in interface ParameterListProvider

Parameters:

params - list of parameters