TypeBoundMap

a map where the types for keys and values share a type parameter with the same bounds. the key and value of each key/value pair are constrained to match on that type parameter. for example, we might have some pet stores that only cater to a single kind of pet:

trait Pet
case class Cat(name: String) extends Pet
case class Dog(name: String) extends Pet
class PetStore[P <: Pet]

val catStore1 = new PetStore[Cat]
val catStore2 = new PetStore[Cat]
val dogStore1 = new PetStore[Dog]

we can use a TypeBoundMap to store a list of pets of the appropriate type for every pet store:

var inventories = TypeBoundMap[Pet, PetStore, List]
inventories += (catStore1 -> List(Cat("cat11"), Cat("cat12"), Cat("cat13")))
inventories += (catStore2 -> List(Cat("cat21")))
inventories += (dogStore1 -> List(Dog("dog11"), Dog("dog12")))

now we can look up pet lists by pet store, with everything coming back as the expected type:

val cats1: List[Cat] = inventories(catStore1)
cats1.size should be (3)
val cats2: List[Cat] = inventories(catStore2)
cats2.size should be (1)
val dogs1: List[Dog] = inventories(dogStore1)
dogs1.size should be (2)

val cat: Cat = inventories(catStore1).head
cat should equal (Cat("cat11"))
val dog: Dog = inventories(dogStore1).head
dog should equal (Dog("dog11"))

note that the API does not provide ++ or similar methods to add multiple key/value pairs at a time, as each pair needs to be type-checked separately.

(the code presented here is in TypeBoundMapSpec.scala, up at the top)

TypeBound: the upper bound on the type parameters passed to the Key and Val types
Key: the parameterized type of the keys in the map
Val: the parameterized type of the values in the map

Source: TypeBoundMap.scala
See also: TypeBoundMapSpec.scala and BaseTypeBoundMapSpec.scala for many more examples

Linear Supertypes

BaseTypeBoundMap[TypeBound, Key, Val], AnyRef, Any

Type Hierarchy Learn more about scaladoc diagrams

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +[TypeParam <: TypeBound, ValTypeParam <: TypeBound](pair: (Key[TypeParam], Val[ValTypeParam]))(implicit valConforms: <:<[Val[ValTypeParam], Val[TypeParam]]): TypeBoundMap[TypeBound, Key, Val]

adds a key/value pair to this map, returning a new map.
adds a key/value pair to this map, returning a new map. both the key and the value are bound by the same type param.
TypeParam
the type param bounding both the key and the value
ValTypeParam
the type param for the value type. this can be any type, provided that Val[ValTypeParam] <: Val[KeyTypeParam])
pair
the key/value pair
valConforms
a constraint ensuring that Val[ValTypeParam] <: Val[TypeParam])
def ++(that: TypeBoundMap[TypeBound, Key, Val]): TypeBoundMap[TypeBound, Key, Val]

takes the union of two type bound maps with the same type params
takes the union of two type bound maps with the same type params
that
the type bound map to union with this type bound map
returns
a new type bound map with the bindings of this map and that map
def ->[B](y: B): (TypeBoundMap[TypeBound, Key, Val], B)

Implicit information
This member is added by an implicit conversion from TypeBoundMap[TypeBound, Key, Val] to ArrowAssoc[TypeBoundMap[TypeBound, Key, Val]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def apply[TypeParam <: TypeBound](key: Key[TypeParam]): Val[TypeParam]

retrieves the value which is associated with the given key, both bound by the same type param.
retrieves the value which is associated with the given key, both bound by the same type param.
throws java.util.NoSuchElementException when no value is mapped to the supplied key
TypeParam
the type param binding both the key and the value
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contains(key: Key[_ <: TypeBound]): Boolean

tests whether this map contains a binding for a key.
tests whether this map contains a binding for a key.
key
the key
returns
true if there is a binding for key in this map, false otherwise.

Definition Classes
BaseTypeBoundMap
def ensuring(cond: (TypeBoundMap[TypeBound, Key, Val]) ⇒ Boolean, msg: ⇒ Any): TypeBoundMap[TypeBound, Key, Val]

Implicit information
This member is added by an implicit conversion from TypeBoundMap[TypeBound, Key, Val] to Ensuring[TypeBoundMap[TypeBound, Key, Val]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (TypeBoundMap[TypeBound, Key, Val]) ⇒ Boolean): TypeBoundMap[TypeBound, Key, Val]

Implicit information
This member is added by an implicit conversion from TypeBoundMap[TypeBound, Key, Val] to Ensuring[TypeBoundMap[TypeBound, Key, Val]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): TypeBoundMap[TypeBound, Key, Val]

Implicit information
This member is added by an implicit conversion from TypeBoundMap[TypeBound, Key, Val] to Ensuring[TypeBoundMap[TypeBound, Key, Val]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): TypeBoundMap[TypeBound, Key, Val]

Implicit information
This member is added by an implicit conversion from TypeBoundMap[TypeBound, Key, Val] to Ensuring[TypeBoundMap[TypeBound, Key, Val]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: Any): Boolean

compares two maps structurally; i.e., checks if all mappings contained in this map are also contained in the other map, and vice versa.
compares two maps structurally; i.e., checks if all mappings contained in this map are also contained in the other map, and vice versa.
that
the other type key map
returns
true if both maps contain exactly the same mappings, false otherwise.

Definition Classes
TypeBoundMap → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def foreach(f: (TypeBoundPair[TypeBound, Key, Val, _ <: TypeBound]) ⇒ Unit): Unit

[use case] applies a function f to all elements of this type bound map.
[use case]
applies a function f to all elements of this type bound map.
f
the function that is applied for its side-effect to every element. the result of function f is discarded

Definition Classes
BaseTypeBoundMap
Full Signature
def foreach[U](f: (TypeBoundPair[TypeBound, Key, Val, _ <: TypeBound]) ⇒ U): Unit
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from TypeBoundMap[TypeBound, Key, Val] to StringFormat[TypeBoundMap[TypeBound, Key, Val]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
def get[TypeParam <: TypeBound](key: Key[TypeParam]): Option[Val[TypeParam]]

optionally returns the value associated with the given key
optionally returns the value associated with the given key
TypeParam
the type param bounding both the key and the value
returns
an option value containing the value associated with type key in this map, or None if none exists.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getOrElse[TypeParam <: TypeBound](key: Key[TypeParam], default: ⇒ Val[TypeParam]): Val[TypeParam]

returns the value associated with a key, or a default value if the key is not contained in the map.
returns the value associated with a key, or a default value if the key is not contained in the map.
TypeParam
the type param bounding both the key and the value
default
a computation that yields a default value in case no binding for the key is found in the map
returns
the value associated with key if it exists, otherwise the result of the default computation.
def hashCode(): Int

Definition Classes
TypeBoundMap → BaseTypeBoundMap → AnyRef → Any
def isEmpty: Boolean

tests whether the map is empty.
tests whether the map is empty.
returns
true if the map does not contain any key/value binding, false otherwise.

Definition Classes
BaseTypeBoundMap
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def iterator: Iterator[TypeBoundPair[TypeBound, Key, Val, _ <: TypeBound]]

creates a new iterator over all key/value pairs of this map
creates a new iterator over all key/value pairs of this map
returns
the new iterator

Definition Classes
BaseTypeBoundMap
def keys: Iterable[Key[_ <: TypeBound]]

collects all keys of this map in an iterable collection.
collects all keys of this map in an iterable collection.
returns
the keys of this map as an iterable.

Definition Classes
BaseTypeBoundMap
def mapValues[Val2[_ <: TypeBound]](f: TypeBoundFunction[TypeBound, Val, Val2]): TypeBoundMap[TypeBound, Key, Val2]

transforms this map by applying a function to every retrieved value.
transforms this map by applying a function to every retrieved value.
f
the function used to transform values of this map.
returns
a map which maps every key of this map to f(this(key)).
def mapValuesUnderlying[TypeBound2 >: TypeBound, Val2[_ <: TypeBound2]](f: WideningTypeBoundFunction[TypeBound, TypeBound2, Val, Val2]): Map[Any, Any]

Attributes
protected
Definition Classes
BaseTypeBoundMap
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def size: Int

the number of key/value bindings in this map
the number of key/value bindings in this map

Definition Classes
BaseTypeBoundMap
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

a string representation of a TypeBoundMap
a string representation of a TypeBoundMap

Definition Classes
TypeBoundMap → AnyRef → Any
val underlying: Map[Any, Any]

Attributes
protected
Definition Classes
BaseTypeBoundMap
def values: Iterable[Val[_ <: TypeBound]]

collects all values of this map in an iterable collection.
collects all values of this map in an iterable collection.
returns
the values of this map as an iterable.

Definition Classes
BaseTypeBoundMap
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (TypeBoundMap[TypeBound, Key, Val], B)

Implicit information
This member is added by an implicit conversion from TypeBoundMap[TypeBound, Key, Val] to ArrowAssoc[TypeBoundMap[TypeBound, Key, Val]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implicit Value Members

def +(other: String): String
Implicit information
This member is added by an implicit conversion from TypeBoundMap[TypeBound, Key, Val] to any2stringadd[TypeBoundMap[TypeBound, Key, Val]] performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(typeBoundMap: any2stringadd[TypeBoundMap[TypeBound, Key, Val]]).+(other)
Definition Classes
any2stringadd

Related Docs: object TypeBoundMap | package emblem

class TypeBoundMap[TypeBound, Key[_ <: TypeBound], Val[_ <: TypeBound]] extends BaseTypeBoundMap[TypeBound, Key, Val]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +[TypeParam <: TypeBound, ValTypeParam <: TypeBound](pair: (Key[TypeParam], Val[ValTypeParam]))(implicit valConforms: <:<[Val[ValTypeParam], Val[TypeParam]]): TypeBoundMap[TypeBound, Key, Val]

def ++(that: TypeBoundMap[TypeBound, Key, Val]): TypeBoundMap[TypeBound, Key, Val]

def ->[B](y: B): (TypeBoundMap[TypeBound, Key, Val], B)

final def ==(arg0: Any): Boolean

def apply[TypeParam <: TypeBound](key: Key[TypeParam]): Val[TypeParam]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def contains(key: Key[_ <: TypeBound]): Boolean

def ensuring(cond: (TypeBoundMap[TypeBound, Key, Val]) ⇒ Boolean, msg: ⇒ Any): TypeBoundMap[TypeBound, Key, Val]

def ensuring(cond: (TypeBoundMap[TypeBound, Key, Val]) ⇒ Boolean): TypeBoundMap[TypeBound, Key, Val]

def ensuring(cond: Boolean, msg: ⇒ Any): TypeBoundMap[TypeBound, Key, Val]

def ensuring(cond: Boolean): TypeBoundMap[TypeBound, Key, Val]

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

def foreach(f: (TypeBoundPair[TypeBound, Key, Val, _ <: TypeBound]) ⇒ Unit): Unit

def foreach[U](f: (TypeBoundPair[TypeBound, Key, Val, _ <: TypeBound]) ⇒ U): Unit

def formatted(fmtstr: String): String

def get[TypeParam <: TypeBound](key: Key[TypeParam]): Option[Val[TypeParam]]

final def getClass(): Class[_]

def getOrElse[TypeParam <: TypeBound](key: Key[TypeParam], default: ⇒ Val[TypeParam]): Val[TypeParam]

def hashCode(): Int

def isEmpty: Boolean

final def isInstanceOf[T0]: Boolean

def iterator: Iterator[TypeBoundPair[TypeBound, Key, Val, _ <: TypeBound]]

def keys: Iterable[Key[_ <: TypeBound]]

def mapValues[Val2[_ <: TypeBound]](f: TypeBoundFunction[TypeBound, Val, Val2]): TypeBoundMap[TypeBound, Key, Val2]

def mapValuesUnderlying[TypeBound2 >: TypeBound, Val2[_ <: TypeBound2]](f: WideningTypeBoundFunction[TypeBound, TypeBound2, Val, Val2]): Map[Any, Any]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def size: Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

val underlying: Map[Any, Any]

def values: Iterable[Val[_ <: TypeBound]]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (TypeBoundMap[TypeBound, Key, Val], B)

Shadowed Implicit Value Members

def +(other: String): String

Inherited from BaseTypeBoundMap[TypeBound, Key, Val]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TypeBoundMap[TypeBound, Key, Val] to any2stringadd[TypeBoundMap[TypeBound, Key, Val]]

Inherited by implicit conversion StringFormat from TypeBoundMap[TypeBound, Key, Val] to StringFormat[TypeBoundMap[TypeBound, Key, Val]]

Inherited by implicit conversion Ensuring from TypeBoundMap[TypeBound, Key, Val] to Ensuring[TypeBoundMap[TypeBound, Key, Val]]

Inherited by implicit conversion ArrowAssoc from TypeBoundMap[TypeBound, Key, Val] to ArrowAssoc[TypeBoundMap[TypeBound, Key, Val]]

Ungrouped