Class

org.scaladebugger.api.utils

MultiMap

Related Doc: package utils

Permalink

class MultiMap[Key, Value] extends AnyRef

Represents a data structure of mappings for multiple values.

Key

The key used to go from Key -> Seq[Id]

Value

The value yielded from Key or any Id

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MultiMap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MultiMap()

    Permalink

Type Members

  1. type Id = String

    Permalink

    Represents an id to map key to value

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def get(key: Key): Option[Seq[Value]]

    Permalink

    Retrieves all values for the specified key.

    Retrieves all values for the specified key.

    key

    The key whose values to retrieve

    returns

    Some collection of values if the key exists, otherwise None

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getIdsWithKey(key: Key): Option[Seq[Id]]

    Permalink

    Retrieves the collection of ids for an key.

    Retrieves the collection of ids for an key.

    key

    The key whose ids to retrieve

    returns

    Some collection of ids if the key exists, otherwise None

  12. def getIdsWithKeyPredicate(predicate: (Key) ⇒ Boolean): Seq[Id]

    Permalink

    Retrieves the collection of ids for all keys that satisfy the predicate.

    Retrieves the collection of ids for all keys that satisfy the predicate.

    predicate

    The predicate to use when evaluating keys

    returns

    The collection of ids whose keys satisfy the predicate

  13. def getIdsWithValuePredicate(predicate: (Value) ⇒ Boolean): Seq[Id]

    Permalink

    Retrieves the collection of ids for all values that satisfy the predicate.

    Retrieves the collection of ids for all values that satisfy the predicate.

    predicate

    The predicate to use when evaluating values

    returns

    The collection of ids whose values satisfy the predicate

  14. def getKeyWithId(id: Id): Option[Key]

    Permalink

    Retrieves the key that uses the specified id to map to a value.

    Retrieves the key that uses the specified id to map to a value.

    id

    The id used to associate a value with the desired key

    returns

    Some key if the id exists, otherwise None

  15. def getWithId(id: Id): Option[Value]

    Permalink

    Retrieves the value for the specified id.

    Retrieves the value for the specified id.

    id

    The id of the value to retrieve

    returns

    Some value if the id exists, otherwise None

  16. def getWithKeyPredicate(predicate: (Key) ⇒ Boolean): Seq[Value]

    Permalink

    Retrieves all values whose key satisfies the specified predicate.

    Retrieves all values whose key satisfies the specified predicate.

    predicate

    The predicate to use when evaluating keys

    returns

    The collection of values whose keys satisfied the predicate

  17. def getWithValuePredicate(predicate: (Value) ⇒ Boolean): Seq[Value]

    Permalink

    Retrieves all values that satisfy the specified predicate.

    Retrieves all values that satisfy the specified predicate.

    predicate

    The predicate to use when evaluating values

    returns

    The collection of values that satisfied the predicate

  18. def has(key: Key): Boolean

    Permalink

    Determines if the specified key exists in the map.

    Determines if the specified key exists in the map.

    key

    The key to check

    returns

    True if the key exists, otherwise false

  19. def hasWithId(id: Id): Boolean

    Permalink

    Determines if the specified id exists in the map.

    Determines if the specified id exists in the map.

    id

    The id to check

    returns

    True if the id exists, otherwise false

  20. def hasWithKeyPredicate(predicate: (Key) ⇒ Boolean): Boolean

    Permalink

    Determines if any key satisfies the specified predicate.

    Determines if any key satisfies the specified predicate.

    predicate

    The predicate to use when evaluating keys

    returns

    True if a key satisfies the predicate, otherwise false

  21. def hasWithValuePredicate(predicate: (Value) ⇒ Boolean): Boolean

    Permalink

    Determines if any value satisfies the specified predicate.

    Determines if any value satisfies the specified predicate.

    predicate

    The predicate to use when evaluating values

    returns

    True if a value satisfies the predicate, otherwise false

  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  23. def ids: Seq[Id]

    Permalink

    Retrieves all underlying ids stored in this map used to link keys to values.

    Retrieves all underlying ids stored in this map used to link keys to values.

    returns

    The collection of ids

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def keys: Seq[Key]

    Permalink

    Retrieves all keys stored in this map.

    Retrieves all keys stored in this map.

    returns

    The collection of keys

  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. def newId(): Id

    Permalink

    Generates a new id.

    Generates a new id.

    returns

    The new id from a UUID

    Attributes
    protected
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. def put(key: Key, value: Value): Id

    Permalink

    Adds the value with the specified key to the map.

    Adds the value with the specified key to the map.

    key

    The key to use when looking up and removing the value

    value

    The value to store in the map

    returns

    The underlying id used to link the key with the value

  31. def putWithId(id: Id, key: Key, value: Value): Id

    Permalink

    Adds the value with the specified key to the map.

    Adds the value with the specified key to the map. Uses the specified id to link the key with the value.

    id

    The id to use to link the key with the value

    key

    The key to use when looking up and removing the value

    value

    The value to store in the map

    returns

    The underlying id used to link the key with the value

  32. def remove(key: Key): Option[Seq[Value]]

    Permalink

    Removes the values with the specified key.

    Removes the values with the specified key. Also, removes the underlying ids linking the key to the collection of values.

    key

    The key of the values to remove

    returns

    Some collection of values if the key exists, otherwise None

  33. def removeWithId(id: Id): Option[Value]

    Permalink

    Removes the value with the specified id.

    Removes the value with the specified id. Also, removes the association between a key and the value via the id.

    id

    The id of the value to remove

    returns

    Some value if the id exists, otherwise None

  34. def removeWithKeyPredicate(predicate: (Key) ⇒ Boolean): Seq[Value]

    Permalink

    Removes all values whose key satisfies the specified predicate.

    Removes all values whose key satisfies the specified predicate.

    predicate

    The predicate to use when evaluating keys

    returns

    The collection of removed values

  35. def removeWithValuePredicate(predicate: (Value) ⇒ Boolean): Seq[Value]

    Permalink

    Removes all values that satisfy the specified predicate.

    Removes all values that satisfy the specified predicate.

    predicate

    The predicate to use when evaluating values

    returns

    The collection of removed values

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

    Permalink
    Definition Classes
    AnyRef
  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  38. def values: Seq[Value]

    Permalink

    Retrieves all values stored in this map.

    Retrieves all values stored in this map.

    returns

    The collection of values

  39. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped