CharKey

csw.params.javadsl.JSimpleKeyType.CharKey
case object CharKey extends SimpleKeyType[Character]

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class SimpleKeyType[Character]
trait KeyType[Character]
trait Serializable
trait EnumEntry
class Object
trait Matchable
class Any
Show all
Self type
CharKey.type

Members list

Type members

Inherited types

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton

Attributes

Inherited from:
Singleton
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton

Inherited and Abstract types

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Inherited methods

String representation of this Enum Entry.

String representation of this Enum Entry.

Override in your implementation if needed

Attributes

Inherited from:
EnumEntry
override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
KeyType -> Any
Inherited from:
KeyType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
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
KeyType -> Any
Inherited from:
KeyType
def make(name: String, units: Units): Key[Character]

Make a Key from provided name and units

Make a Key from provided name and units

Value parameters

name

represents keyName in Key

units

represents the units of the values

Attributes

Returns

a Key[S] with units where S is the type of values that will sit against the key in Parameter

Inherited from:
SimpleKeyType
def make(name: String): Key[Character]

Make a Key from provided name

Make a Key from provided name

Value parameters

name

represents keyName in Key

Attributes

Returns

a Key[S] with NoUnits where S is the type of values that will sit against the key in Parameter

Inherited from:
SimpleKeyType

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product