de.fraunhofer.iese.ind2uce.api.policy

Class ModifierEngine

java.lang.Object

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

de.fraunhofer.iese.ind2uce.api.policy.ModifierEngine

All Implemented Interfaces:

ParameterListProvider, Serializable

public class ModifierEngine
extends Ind2uceEntity
implements ParameterListProvider

A modifier engine describes a method that can be performed on event parameters. Despite an engine name it contains a list of parameters required for the processing the engine.

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
ModifierEngine(String name) Instantiates a new modifier engine.
ModifierEngine(String name, ParameterList params) Instantiates a new modifier engine.

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.
boolean	equals(Object obj)
String	getMethod() Gets the engine name.
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.
int	hashCode()
void	removeParameter(String name) Adds a parameter.
void	setMethod(String method) Sets the engine name.
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, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifierEngine

public ModifierEngine(String name)

Instantiates a new modifier engine.

Parameters:

name - the name of the parameter

ModifierEngine

public ModifierEngine(String name,
                      ParameterList params)

Instantiates a new modifier engine.

Parameters:

name - the name of the parameter

params - the parameter values

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 <T> void addParameter(String name,
                             T value)

Description copied from interface: ParameterListProvider

Adds a parameter.

Specified by:

addParameter in interface ParameterListProvider

Type Parameters:

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

getMethod

public String getMethod()

Gets the engine name.

Returns:

the engine name

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 <T> T getParameterValue(String name,
                               Class<T> clazz)

Description copied from interface: ParameterListProvider

Gets a parameter value.

Specified by:

getParameterValue in interface ParameterListProvider

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

setMethod

public void setMethod(String method)

Sets the engine name.

Parameters:

method - the engine name to set

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