Package csw.params.commands

Class Result

java.lang.Object

csw.params.core.generics.ParameterSetType<Result>

csw.params.commands.Result

All Implemented Interfaces:

ParameterSetKeyData, java.io.Serializable, scala.Equals, scala.Product

public class Result
extends ParameterSetType<Result>
implements ParameterSetKeyData, scala.Product, java.io.Serializable

A result containing parameters for command response

param: prefix identifies the subsystem that received the command and created command response out of it param: paramSet an optional initial set of parameters (keys with values)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Result(Prefix prefix, scala.collection.immutable.Set<Parameter<?>> paramSet)
Result(java.lang.String prefix)	A java helper to construct Result

Method Summary

Modifier and Type	Method	Description
static Result	apply(Prefix prefix, scala.collection.immutable.Set<Parameter<?>> paramSet)	A helper method to create Result instance
protected Result	create(scala.collection.immutable.Set<Parameter<?>> data)	Create a new Result instance when a parameter is added or removed
scala.collection.immutable.Set<Parameter<?>>	paramSet()	Holds the parameters for this parameter set
Prefix	prefix()	Returns an object providing the subsystem and prefix for the parameter set

Methods inherited from class csw.params.core.generics.ParameterSetType

add, apply, contains, dataToString, exists, find, get, get, getStringMap, jFind, jGet, jGet, jGetStringMap, jMissingKeys, jMissingKeys, jParamSet, madd, madd, madd, missingKeys, parameter, remove, remove, size, toString, typeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface csw.params.core.generics.ParameterSetKeyData

prefixStr, subsystem, toString

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Detail

Result

public Result(Prefix prefix,
              scala.collection.immutable.Set<Parameter<?>> paramSet)

Result

public Result(java.lang.String prefix)

A java helper to construct Result

Parameters:

prefix - (undocumented)

Method Detail

apply

public static Result apply(Prefix prefix,
                           scala.collection.immutable.Set<Parameter<?>> paramSet)

A helper method to create Result instance

Parameters:

prefix - identifies the subsystem that received the command and created command response out of it

paramSet - an optional initial set of parameters (keys with values)

Returns:

a Result instance with provided prefix and paramSet

prefix

public Prefix prefix()

Description copied from interface: ParameterSetKeyData

Returns an object providing the subsystem and prefix for the parameter set

Specified by:

prefix in interface ParameterSetKeyData

Returns:

(undocumented)

paramSet

public scala.collection.immutable.Set<Parameter<?>> paramSet()

Description copied from class: ParameterSetType

Holds the parameters for this parameter set

Specified by:

paramSet in class ParameterSetType<Result>

Returns:

(undocumented)

create

protected Result create(scala.collection.immutable.Set<Parameter<?>> data)

Create a new Result instance when a parameter is added or removed

Specified by:

create in class ParameterSetType<Result>

Parameters:

data - set of parameters

Returns:

a new instance of Result with provided data