Package csw.params.core.generics

Class GChoiceKey

java.lang.Object

csw.params.core.generics.Key<Choice>

csw.params.core.generics.GChoiceKey

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public class GChoiceKey
extends Key<Choice>

A key for a choice item similar to an enumeration

param: name the name of the key param: keyType reference to an object of type KeyType[Choice] param: choices the available choices, the values set must be in the choices

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GChoiceKey(String name, KeyType<Choice> keyType, Units units, Choices choices)

Method Summary

Modifier and Type	Method	Description
Choices	choices()
Parameter<Choice>	set(Choice value, scala.collection.immutable.Seq<Choice> values)	Sets the values for the key using a variable number of arguments

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

equals, hashCode, keyName, keyType, set, setAll, toString, units

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

GChoiceKey

public GChoiceKey(String name,
 KeyType<Choice> keyType,
 Units units,
 Choices choices)

Method Details

choices

public Choices choices()

set

public Parameter<Choice> set(Choice value,
 scala.collection.immutable.Seq<Choice> values)

Sets the values for the key using a variable number of arguments

Overrides:

set in class Key<Choice>

Parameters:

values - one or more values

Returns:

a parameter containing the key name, values