com.kuka.roboticsAPI.controllerModel.sunrise.api
Class ParameterList

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.ParameterList

All Implemented Interfaces:

com.kuka.common.IDataEquatable, Iterable<Parameter<?>>

public final class ParameterList
extends Object
implements Iterable<Parameter<?>>, com.kuka.common.IDataEquatable

Helper class for handling parameters.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Constructor Summary

ParameterList()

Method Summary

<T> Parameter<T>	addParameter(Parameter<T> parameter) Adds a new parameter to this compound.
<T> Parameter<T>	addParameter(String name, T value) Adds a new parameter to this compound.
Parameter<?>	getParameter(String name) Gets the parameter with the specified name.
boolean	hasParameter(String aParameter) Checks whether the compound contains a value for a given parameter.
boolean	hasSameDataAs(Object obj)
Iterator<Parameter<?>>	iterator()
void	removeParameter(String name) Removes a parameter from the parameter list.
int	size() Returns the size of this parameter list.
String	toString()
Parameter<?>	tryGetParameter(String name) Tries to get the parameter with the specified name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterList

public ParameterList()

Method Detail

addParameter

public <T> Parameter<T> addParameter(Parameter<T> parameter)

Adds a new parameter to this compound. This method does not care if the same parameter is added twice. If a parameter with the same name was already added, the given parameter will not be added, but the value of the 'old' parameter will be changed with the 'new' parameter value.

Type Parameters:

T - The type of the parameter.

Parameters:

parameter - The parameter to add.

Returns:

The parameter which contains the given value. May be not the same parameter that was given as argument, because if a parameter with the same name already existed, it's value will be changed and the 'old' parameter will be returned.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

addParameter

public <T> Parameter<T> addParameter(String name,
                                     T value)

Adds a new parameter to this compound. This method does not care if the same parameter is added twice. If a parameter with the same name was already added, this parameter will be replaced by the new one.

Type Parameters:

T - The type of the parameter.

Parameters:

name - The name of the parameter.

value - The value of the parameter.

Returns:

The created parameter.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getParameter

public Parameter<?> getParameter(String name)

Gets the parameter with the specified name.

Parameters:

name - The name of the parameter. null is not allowed.

Returns:

The parameter with the specified name.

Throws:

IllegalArgumentException - if parameter not found

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

tryGetParameter

public Parameter<?> tryGetParameter(String name)

Tries to get the parameter with the specified name.

Parameters:

name - The name of the parameter. null is not allowed.

Returns:

The parameter with the specified name, or null if the parameter was not found.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

removeParameter

public void removeParameter(String name)

Removes a parameter from the parameter list.

Parameters:

name - The name of the parameter. null is not allowed.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

toString

public String toString()

Overrides:

toString in class Object

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

size

public int size()

Returns the size of this parameter list.

Returns:

The size of this parameter list.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

iterator

public Iterator<Parameter<?>> iterator()

Specified by:

iterator in interface Iterable<Parameter<?>>

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

hasParameter

public boolean hasParameter(String aParameter)

Checks whether the compound contains a value for a given parameter.

Parameters:

aParameter - the name of the parameter

Returns:

true, if the parameter is contained in the compound's parameter list
false, in any other case

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

hasSameDataAs

public boolean hasSameDataAs(Object obj)

Specified by:

hasSameDataAs in interface com.kuka.common.IDataEquatable

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.