csw
API
Generated with
csw/csw/csw.params/csw.params.core/csw.params.core.generics/Key

Key

csw.params.core.generics.Key
case class Key[S]

A generic Key class. Never meant to be instantiated directly. csw.params.core.generics.KeyType exposes allowed types of Keys and make method to create instances of Key.

Value parameters

keyName

the name of the key

keyType

reference to an object of type KeyType[S]

units

applicable units

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class GChoiceKey

Members list

Keywords
  • no keywords
  • override
Inherited
  • Not inherited
  • Product

Value members

Concrete methods

def ->(value: S): Parameter[S]

Sets the values for the key This definition enables writing code like this:

Sets the values for the key This definition enables writing code like this:

 val setup = sc(
  prefix,
   key1 -> value1 withUnits UnitsOfMeasure.Deg,
   key2 -> value2  // with default units
 )

Attributes

Returns

a parameter containing the key name and one value (call withUnits() on the result to set the units)

override def equals(that: Any): Boolean

Equals this Key instance with other by the keyName

Equals this Key instance with other by the keyName

Value parameters

that

the other Key instance that is to be equated against this Key instance

Attributes

Returns

a Boolean indicating whether two Key instances are equal or not

Definition Classes
Equals -> Any
override def hashCode: Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
def set(value: S, values: S*): Parameter[S]

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

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

Value parameters

values

one or more values

Attributes

Returns

an instance of Parameter[S] containing the key name, values (call withUnits() on the result to set the units)

def setAll(values: Array[S]): Parameter[S]

Set values against this key

Set values against this key

Value parameters

values

an Array of values

Attributes

Returns

an instance of Parameter[S] containing the key name, values (call withUnits() on the result to set the units)

override def toString: String

Returns a string representation of Key as keyName

Returns a string representation of Key as keyName

Attributes

Definition Classes
Any

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with