Class/Object

swaydb

MultiMap

Related Docs: object MultiMap | package swaydb

Permalink

case class MultiMap[M, K, V, F, BAG[_]] extends MapT[K, V, F, BAG] with Product with Serializable

MultiMap extends swaydb.Map's API to allow storing multiple Maps withing a single Map.

MultiMap is just a simple extension that uses custom data types (MultiMapKey) and KeyOrder (MultiMapKey.ordering) for it's API.

Self Type
MultiMap[M, K, V, F, BAG]
Linear Supertypes
Serializable, Serializable, Product, Equals, MapT[K, V, F, BAG], SetMapT[K, V, F, BAG], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MultiMap
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. MapT
  7. SetMapT
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def after(key: K): MultiMap[M, K, V, F, BAG]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  5. def applyFunction[PF <: F](from: K, to: K, function: PF)(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): BAG[OK]

    Permalink

    Definition Classes
    MultiMapMapT
    Note

    In other operations like expire, remove, put the input expiration value is compared with defaultExpiration to get the nearest expiration. But functions does not check if the custom logic within the function expires key-values earlier than defaultExpiration.

  6. def applyFunction[PF <: F](key: K, function: PF)(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): BAG[OK]

    Permalink

    Definition Classes
    MultiMapMapT
    Note

    In other operations like expire, remove, put the input expiration value is compared with defaultExpiration to get the nearest expiration. But functions does not check if the custom logic within the function expires key-values earlier than defaultExpiration.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def asScala: scala.collection.mutable.Map[K, V]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  9. implicit val bag: Bag[BAG]

    Permalink
  10. def before(key: K): MultiMap[M, K, V, F, BAG]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  11. def clearKeyValues(): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def close(): BAG[Unit]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  14. def commit[PF <: F](prepare: Iterable[Prepare[K, V, PF]])(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  15. def commit[PF <: F](prepare: Stream[Prepare[K, V, PF]])(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  16. def commit[PF <: F](prepare: Prepare[K, V, PF]*)(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  17. def commit[M2, K2, V2, PF <: F](transaction: Iterable[Transaction[M, K, V, PF]])(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]], evT: <:<[M2, M], evK: <:<[K2, K], evV: <:<[V2, V]): BAG[OK]

    Permalink

    Commits transaction to global map.

  18. def contains(key: K): BAG[Boolean]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  19. val defaultExpiration: Option[Deadline]

    Permalink
  20. def delete(): BAG[Unit]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def expiration(key: K): BAG[Option[Deadline]]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  23. def expire(keys: Iterator[(K, Deadline)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  24. def expire(keys: Iterable[(K, Deadline)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  25. def expire(keys: Stream[(K, Deadline)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  26. def expire(keys: (K, Deadline)*): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  27. def expire(from: K, to: K, at: Deadline): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  28. def expire(from: K, to: K, after: FiniteDuration): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  29. def expire(key: K, at: Deadline): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  30. def expire(key: K, after: FiniteDuration): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  31. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. def from(key: K): MultiMap[M, K, V, F, BAG]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  33. def fromOrAfter(key: K): MultiMap[M, K, V, F, BAG]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  34. def fromOrBefore(key: K): MultiMap[M, K, V, F, BAG]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  35. def get(key: K): BAG[Option[V]]

    Permalink

    Returns target value for the input key.

    Returns target value for the input key.

    Definition Classes
    MultiMapMapTSetMapT
  36. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  37. def getKey(key: K): BAG[Option[K]]

    Permalink

    Returns target full key for the input partial key.

    Returns target full key for the input partial key.

    This function is mostly used for Set databases where partial ordering on the Key is provided.

    Definition Classes
    MultiMapMapTSetMapT
  38. def getKeyDeadline[BAG[_]](key: K, bag: Bag[BAG]): BAG[Option[(K, Option[Deadline])]]

    Permalink
    Definition Classes
    MultiMapMapT
  39. def getKeyDeadline(key: K): BAG[Option[(K, Option[Deadline])]]

    Permalink
    Definition Classes
    MultiMapMapT
  40. def getKeyValue(key: K): BAG[Option[(K, V)]]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  41. def headOption: BAG[Option[(K, V)]]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  42. def headOrNull: BAG[(K, V)]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  43. def isEmpty: BAG[Boolean]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. def iterator[BAG[_]](implicit bag: Sync[BAG]): Iterator[BAG[(K, V)]]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  46. def keySize(key: K): Int

    Permalink
    Definition Classes
    MultiMapMapT
  47. def lastOption: BAG[Option[(K, V)]]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  48. def levelMeter(levelNumber: Int): Option[LevelMeter]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  49. def levelZeroMeter: LevelZeroMeter

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  50. def mightContain(key: K): BAG[Boolean]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  51. def mightContainFunction[PF <: F](function: PF)(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): BAG[Boolean]

    Permalink
    Definition Classes
    MultiMapMapT
  52. def narrow[M2, K2, V2, F2](mapKey: Class[M2], keyType: Class[K2], valueType: Class[V2], functionType: Class[F2])(implicit evT: <:<[M2, M], evK: <:<[K2, K], evV: <:<[V2, V], evF: <:<[F2, F]): MultiMap[M2, K2, V2, F2, BAG]

    Permalink

    Narrows this MultiMap's map key type M, key-value key type K, value type V and function type F.

  53. def narrow[M2, K2, V2](mapKey: Class[M2], keyType: Class[K2], valueType: Class[V2])(implicit evT: <:<[M2, M], evK: <:<[K2, K], evV: <:<[V2, V]): MultiMap[M2, K2, V2, F, BAG]

    Permalink

    Narrows this MultiMap's map key type M, key-value key type K and value type V

  54. def narrow[M2, K2](mapKey: Class[M2], keyType: Class[K2])(implicit evT: <:<[M2, M], evK: <:<[K2, K]): MultiMap[M2, K2, V, F, BAG]

    Permalink

    Narrows this MultiMap's map key type M and key-value key type K

  55. def narrow[M2](mapKey: Class[M2])(implicit evT: <:<[M2, M]): MultiMap[M2, K, V, F, BAG]

    Permalink

    Narrows this MultiMap's map key type M

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

    Permalink
    Definition Classes
    AnyRef
  57. def nonEmpty: BAG[Boolean]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  58. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  60. def path: Path

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  61. def put(keyValues: Iterator[(K, V)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  62. def put(keyValues: Iterable[(K, V)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  63. def put(keyValues: Stream[(K, V)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  64. def put(keyValues: (K, V)*): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  65. def put(key: K, value: V, expireAt: Deadline): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  66. def put(key: K, value: V, expireAfter: FiniteDuration): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  67. def put(key: K, value: V): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  68. def put(key: K, value: V, expireAt: Option[Deadline]): BAG[OK]

    Permalink
    Definition Classes
    SetMapT
  69. def remove(keys: Iterator[K]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  70. def remove(keys: Iterable[K]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  71. def remove(keys: Stream[K]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  72. def remove(keys: K*): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  73. def remove(from: K, to: K): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  74. def remove(key: K): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  75. def reverse: MultiMap[M, K, V, F, BAG]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  76. val schema: Schema[M, K, V, F, BAG]

    Permalink

    APIs for managing child map of this MultiMap.

  77. def sizeOfBloomFilterEntries: BAG[Int]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  78. def sizeOfSegments: Long

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  79. def stream: Stream[(K, V)]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  80. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  81. val thisMapKey: Iterable[M]

    Permalink
  82. def timeLeft(key: K): BAG[Option[FiniteDuration]]

    Permalink
    Definition Classes
    MultiMapMapTSetMapT
  83. def toBag[X[_]](implicit bag: Bag[X]): MultiMap[M, K, V, F, X]

    Permalink

    Returns an Async API of type O where the Bag is known.

    Returns an Async API of type O where the Bag is known.

    Definition Classes
    MultiMapMapTSetMapT
  84. def toString(): String

    Permalink
    Definition Classes
    MultiMapSetMapT → AnyRef → Any
  85. def toTransaction[PF <: F](prepare: Iterable[Prepare[K, V, PF]])(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): Iterable[Transaction[M, K, V, PF]]

    Permalink

    Converts Prepare statement for this map into Prepare statement for this Map's parent Map so that multiple MultiMap Prepare statements can be executed as a single transaction.

    Converts Prepare statement for this map into Prepare statement for this Map's parent Map so that multiple MultiMap Prepare statements can be executed as a single transaction.

    See also

    MultiMap.commit to commit Transactions.

  86. def toTransaction[PF <: F](prepare: Stream[Prepare[K, V, PF]])(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): BAG[Iterable[Transaction[M, K, V, PF]]]

    Permalink

    Converts Prepare statement for this map into Prepare statement for this Map's parent Map so that multiple MultiMap Prepare statements can be executed as a single transaction.

    Converts Prepare statement for this map into Prepare statement for this Map's parent Map so that multiple MultiMap Prepare statements can be executed as a single transaction.

    See also

    MultiMap.commit to commit Transactions.

  87. def toTransaction[PF <: F](prepare: Prepare[K, V, PF]*)(implicit ev: <:<[PF, PureFunction[K, V, Apply.Map[V]]]): Seq[Transaction[M, K, V, PF]]

    Permalink

    Converts Prepare statement for this map into Prepare statement for this Map's parent Map so that multiple MultiMap Prepare statements can be executed as a single transaction.

    Converts Prepare statement for this map into Prepare statement for this Map's parent Map so that multiple MultiMap Prepare statements can be executed as a single transaction.

    See also

    MultiMap.commit to commit Transactions.

  88. def update(keyValues: Iterator[(K, V)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  89. def update(keyValues: Iterable[(K, V)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  90. def update(keyValues: Stream[(K, V)]): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  91. def update(keyValues: (K, V)*): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  92. def update(from: K, to: K, value: V): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  93. def update(key: K, value: V): BAG[OK]

    Permalink
    Definition Classes
    MultiMapMapT
  94. def valueSize(value: V): Int

    Permalink
    Definition Classes
    MultiMapMapT
  95. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from MapT[K, V, F, BAG]

Inherited from SetMapT[K, V, F, BAG]

Inherited from AnyRef

Inherited from Any

Ungrouped