com.kuka.common.params
Class ParameterSet

java.lang.Object
  com.kuka.common.params.AbstractParameterSet
      com.kuka.common.params.ParameterSet

All Implemented Interfaces:

IParameterSet, Iterable<IParameter<?>>

public final class ParameterSet
extends AbstractParameterSet

Represents an immutable set of type safe parameters.

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

Method Summary

static ParameterSetBuilder	builder() Returns a builder for a parameter set of this type.
static ParameterSetBuilder	builder(IParameterSet orig) Returns a builder for a parameter set of this type.
static ParameterSet	combine(IParameterSet primary, IParameterSet... others) Combines parameter sets.
protected IParameterSetBuilder<?>	createBuilder() Return a parameter set builder.

Methods inherited from class com.kuka.common.params.AbstractParameterSet

combine, contains, equals, hashCode, isEmpty, iterator, name, optionalParameter, optionalValue, paramCount, requiredParameter, requiredValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static ParameterSetBuilder builder()

Returns a builder for a parameter set of this type.

Returns:

a ParameterSetBuilder

builder

public static ParameterSetBuilder builder(IParameterSet orig)

Returns a builder for a parameter set of this type. The builder is initialized with the values from the given parameter set.

Parameters:

orig - parameter set with initial values for the builder

Returns:

a ParameterSetBuilder

createBuilder

protected IParameterSetBuilder<?> createBuilder()

Description copied from class: AbstractParameterSet

Return a parameter set builder. This is used by subclasses to provide a parameter set builder of a specific type.

Specified by:

createBuilder in class AbstractParameterSet

Returns:

a parameter set builder

combine

public static ParameterSet combine(IParameterSet primary,
                                   IParameterSet... others)

Combines parameter sets. The order of the sets is important: Parameters in sets more on the left take precedence over parameters sets to the right. That is, the most significant parameter set is the primary set.

Parameters:

primary - The primary set

others - other parameter sets. Can be mixed with null values.

Returns:

A new, combined set.