com.kuka.common.params
Interface IParameterSetBuilder<T extends IParameterSetBuilder<?>>

Type Parameters:

T - type of the parameter set builder

All Known Implementing Classes:

AbstractParameterSetBuilder, ParameterSetBuilder

public interface IParameterSetBuilder<T extends IParameterSetBuilder<?>>

Represents a parameter set builder (builder pattern). A parameter set is generated by build().

This element is not in its final state and might change in future versions.

Method Summary

T	addMissingFrom(IParameterSet set) Adds the parameters from the given set to this builder, if they are not already present.
IParameterSet	build() Creates the parameter set with the values set on this builder.
T	name(String name) Sets the name of this parameter set.
T	put(IParameterSet set) Adds the parameters from the given set to this builder and overwrites previously set parameters on this builder.
<P extends IParameter<?>> T	put(P param) Adds the specified parameter to this set.
T	remove(Class<? extends IParameter<?>> paramClass) Removes the specified parameter from this set.

Method Detail

name

T name(String name)

Sets the name of this parameter set.

Parameters:

name - The name of this set.

Returns:

this builder

put

<P extends IParameter<?>> T put(P param)

Adds the specified parameter to this set. Overrides an existing parameter with the same name.

Type Parameters:

P - parameter type

Parameters:

param - The value of the parameter.

Returns:

This set.

Throws:

NullPointerException - if value is null.

put

T put(IParameterSet set)

Adds the parameters from the given set to this builder and overwrites previously set parameters on this builder.

Parameters:

set - a parameter set to take the parameters from

Returns:

this builder

remove

T remove(Class<? extends IParameter<?>> paramClass)

Removes the specified parameter from this set.

Parameters:

paramClass - the parameter to remove

Returns:

this builder

addMissingFrom

T addMissingFrom(IParameterSet set)

Adds the parameters from the given set to this builder, if they are not already present.

Parameters:

set - a parameter set to take the parameters from

Returns:

this builder

build

IParameterSet build()

Creates the parameter set with the values set on this builder.

Returns:

a new parameter set