com.kuka.common.params
Class AbstractParameterSetBuilder<T extends AbstractParameterSetBuilder<?>>

java.lang.Object
  com.kuka.common.params.AbstractParameterSetBuilder<T>

Type Parameters:

T - type of the parameter set builder, used to cast the return values of the setter methods.

All Implemented Interfaces:

IParameterSetBuilder<T>

Direct Known Subclasses:

ParameterSetBuilder

public abstract class AbstractParameterSetBuilder<T extends AbstractParameterSetBuilder<?>>
extends Object
implements IParameterSetBuilder<T>

Abstract implementation of a parameter set builder (builder pattern).

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

protected	AbstractParameterSetBuilder() Creates a new instance of the builder.
protected	AbstractParameterSetBuilder(IParameterSet orig) Creates a new instance of the builder with initial parameter values set.

Method Summary

T	addMissingFrom(IParameterSet set) Adds the parameters from the given set to this builder, if they are not already present.
boolean	isEmpty() Returns true if no parameters have been set on this builder.
protected String	name() Returns the name that was configured for the parameter set.
T	name(String name) Sets the name of this parameter set.
protected Map<Class<? extends IParameter<?>>,IParameter<?>>	parameters() Returns the map of parameters.
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.
protected T	self() Returns a reference to this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kuka.common.params.IParameterSetBuilder

build

Constructor Detail

AbstractParameterSetBuilder

protected AbstractParameterSetBuilder()

Creates a new instance of the builder.

AbstractParameterSetBuilder

protected AbstractParameterSetBuilder(IParameterSet orig)

Creates a new instance of the builder with initial parameter values set.

Parameters:

orig - initial parameter values

Method Detail

self

protected final T self()

Returns a reference to this object.

Returns:

a reference to this object

name

protected String name()

Returns the name that was configured for the parameter set.

Returns:

the configured set name

parameters

protected Map<Class<? extends IParameter<?>>,IParameter<?>> parameters()

Returns the map of parameters.

Returns:

the map of parameters

name

public final T name(String name)

Description copied from interface: IParameterSetBuilder

Sets the name of this parameter set.

Specified by:

name in interface IParameterSetBuilder<T extends AbstractParameterSetBuilder<?>>

Parameters:

name - The name of this set.

Returns:

this builder

isEmpty

public boolean isEmpty()

Returns true if no parameters have been set on this builder.

Returns:

true if no parameters have been set on this builder

put

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

Description copied from interface: IParameterSetBuilder

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

Specified by:

put in interface IParameterSetBuilder<T extends AbstractParameterSetBuilder<?>>

Type Parameters:

P - parameter type

Parameters:

param - The value of the parameter.

Returns:

This set.

put

public T put(IParameterSet set)

Description copied from interface: IParameterSetBuilder

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

Specified by:

put in interface IParameterSetBuilder<T extends AbstractParameterSetBuilder<?>>

Parameters:

set - a parameter set to take the parameters from

Returns:

this builder

addMissingFrom

public T addMissingFrom(IParameterSet set)

Description copied from interface: IParameterSetBuilder

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

Specified by:

addMissingFrom in interface IParameterSetBuilder<T extends AbstractParameterSetBuilder<?>>

Parameters:

set - a parameter set to take the parameters from

Returns:

this builder

remove

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

Description copied from interface: IParameterSetBuilder

Removes the specified parameter from this set.

Specified by:

remove in interface IParameterSetBuilder<T extends AbstractParameterSetBuilder<?>>

Parameters:

paramClass - the parameter to remove

Returns:

this builder