de.fraunhofer.iese.ind2uce.api.policy.parameter

Interface ParameterListProvider

All Known Implementing Classes:

Event, ExecuteAction, ModifierEngine, PipRequest

public interface ParameterListProvider

The Interface ParameterListProvider.

Author:

Fraunhofer IESE

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter<?> param) Adds a parameter.
<T> void	addParameter(String name, T value) Adds a parameter.
void	clearParameters() Removes all parameters.
Parameter<?>	getParameterForName(String name) Gets a parameter.
ParameterList	getParameters() Gets the list of all parameters.
<T> T	getParameterValue(String name, Class<T> clazz) Gets a parameter value.
void	removeParameter(String name) Adds a parameter.
void	setParameters(ParameterList params) Replaces all parameters with the parameters of the provided list.

Method Detail

addParameter

void addParameter(Parameter<?> param)

Adds a parameter.

Parameters:

param - the parameter to add

addParameter

<T> void addParameter(String name,
                      T value)

Adds a parameter.

Type Parameters:

T - the generic type

Parameters:

name - the name of the parameter

value - the value of the parameter

clearParameters

void clearParameters()

Removes all parameters.

getParameterForName

Parameter<?> getParameterForName(String name)

Gets a parameter.

Parameters:

name - the name of the parameter

Returns:

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

getParameters

ParameterList getParameters()

Gets the list of all parameters.

Returns:

the list of all parameters

getParameterValue

<T> T getParameterValue(String name,
                        Class<T> clazz)
                 throws ClassCastException

Gets a parameter value.

Type Parameters:

T - 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

Throws:

ClassCastException - the class cast exception

removeParameter

void removeParameter(String name)

Adds a parameter.

Parameters:

name - the name of the parameter to be deleted

setParameters

void setParameters(ParameterList params)

Replaces all parameters with the parameters of the provided list.

Parameters:

params - list of parameters