Class

swaydb.extensions

Map

Related Doc: package extensions

Permalink

class Map[K, V] extends MapStream[K, V]

Key-value or Map database API.

For documentation check - http://swaydb.io/api/

Linear Supertypes
MapStream[K, V], Serializable, Serializable, Product, Equals, Streamable[(K, V), ApiIO], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Map
  2. MapStream
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. Streamable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Map(mapKey: Seq[K], map: swaydb.Map[Key[K], Option[V], Nothing, ApiIO])(implicit keySerializer: Serializer[K], mapKeySerializer: Serializer[Key[K]], keyOrder: KeyOrder[Slice[Byte]], valueSerializerOption: Serializer[Option[V]], valueSerializer: Serializer[V])

    Permalink

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): MapStream[K, V]

    Permalink
    Definition Classes
    MapStream
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def before(key: K): MapStream[K, V]

    Permalink
    Definition Classes
    MapStream
  7. def clear(): ApiIO[Done]

    Permalink

    Removes all key-values from the current Map.

    Removes all key-values from the current Map. SubMaps and subMap's key-values or not altered.

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  9. def closeDatabase(): ApiIO[Unit]

    Permalink
  10. def commit(prepare: Iterable[Prepare[K, V]]): ApiIO[Done]

    Permalink
  11. def commit(entries: Prepare[MapEntry[K], Option[V]]*): ApiIO[Done]

    Permalink
  12. def commitPrepared(prepare: Prepare[K, V]*): ApiIO[Done]

    Permalink
  13. def contains(key: K): ApiIO[Boolean]

    Permalink
  14. def drop(count: Int): Stream[(K, V), ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  15. def dropWhile(f: ((K, V)) ⇒ Boolean): Stream[(K, V), ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def exists(): ApiIO[Boolean]

    Permalink
  18. def expiration(key: K): ApiIO[Option[Deadline]]

    Permalink
  19. def expire(keys: Iterable[(K, Deadline)]): ApiIO[Done]

    Permalink
  20. def expire(keys: (K, Deadline)*): ApiIO[Done]

    Permalink
  21. def expire(from: K, to: K, at: Deadline): ApiIO[Done]

    Permalink
  22. def expire(from: K, to: K, after: FiniteDuration): ApiIO[Done]

    Permalink
  23. def expire(key: K, at: Deadline): ApiIO[Done]

    Permalink
  24. def expire(key: K, after: FiniteDuration): ApiIO[Done]

    Permalink
  25. def filter(f: ((K, V)) ⇒ Boolean): Stream[(K, V), ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  26. def filterNot(f: ((K, V)) ⇒ Boolean): Stream[(K, V), ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  27. def flatMap[B](f: ((K, V)) ⇒ Stream[B, ApiIO]): Stream[B, ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  28. def foldLeft[B](initial: B)(f: (B, (K, V)) ⇒ B): ApiIO[B]

    Permalink
    Definition Classes
    MapStream → Streamable
  29. def foreach[U](f: ((K, V)) ⇒ U): Stream[Unit, ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  30. def from(key: K): MapStream[K, V]

    Permalink
    Definition Classes
    MapStream
  31. def fromOrAfter(key: K): MapStream[K, V]

    Permalink
    Definition Classes
    MapStream
  32. def fromOrBefore(key: K): MapStream[K, V]

    Permalink
    Definition Classes
    MapStream
  33. def get(key: K): ApiIO[Option[V]]

    Permalink

    Returns target value for the input key.

    Returns target value for the input key.

    returns

    Returns None is the key does not exist.

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  35. def getKey(key: K): ApiIO[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.

  36. def getKeyValue(key: K): ApiIO[Option[(K, V)]]

    Permalink
  37. def getValue(): ApiIO[Option[V]]

    Permalink

    Returns None if the map does not exist or returns the value.

  38. def headOption: ApiIO[Option[(K, V)]]

    Permalink
    Definition Classes
    MapStream → Streamable
  39. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  40. def isReverse: Boolean

    Permalink
    Definition Classes
    MapStream
  41. def keySize(key: K): Int

    Permalink
  42. def keys: MapKeysStream[K]

    Permalink
  43. def lastOption: ApiIO[Option[(K, V)]]

    Permalink

    lastOption should always force formKey to be the endSubMapsKey because from is always set in swaydb.extensions.Maps and regardless from where the iteration starts the most efficient way to fetch the last is from the key endSubMapsKey.

    lastOption should always force formKey to be the endSubMapsKey because from is always set in swaydb.extensions.Maps and regardless from where the iteration starts the most efficient way to fetch the last is from the key endSubMapsKey.

    Definition Classes
    MapStream → Streamable
  44. def level0Meter: LevelZeroMeter

    Permalink
  45. def levelMeter(levelNumber: Int): Option[LevelMeter]

    Permalink
  46. def map[B](f: ((K, V)) ⇒ B): Stream[B, ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  47. val map: swaydb.Map[Key[K], Option[V], Nothing, ApiIO]

    Permalink
    Definition Classes
    MapStream
  48. val mapKey: Seq[K]

    Permalink
    Definition Classes
    MapStream
  49. def maps: Maps[K, V]

    Permalink
  50. val mapsOnly: Boolean

    Permalink
    Definition Classes
    MapStream
  51. def mightContain(key: K): ApiIO[Boolean]

    Permalink
  52. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  53. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  54. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  55. def preparePut(key: K, value: V, deadline: Deadline): Prepare[MapEntry[K], Option[V]]

    Permalink
  56. def preparePut(key: K, value: V, expireAfter: FiniteDuration): Prepare[MapEntry[K], Option[V]]

    Permalink
  57. def preparePut(key: K, value: V): Prepare[MapEntry[K], Option[V]]

    Permalink
  58. def prepareRemove(from: K, to: K): Prepare[MapEntry[K], Option[V]]

    Permalink
  59. def prepareRemove(key: K): Prepare[MapEntry[K], Option[V]]

    Permalink
  60. def put(keyValues: Iterable[(K, V)]): ApiIO[Done]

    Permalink
  61. def put(keyValues: (K, V)*): ApiIO[Done]

    Permalink
  62. def put(key: K, value: V, expireAt: Deadline): ApiIO[Done]

    Permalink
  63. def put(key: K, value: V, expireAfter: FiniteDuration): ApiIO[Done]

    Permalink
  64. def put(key: K, value: V): ApiIO[Done]

    Permalink
  65. def remove(keys: Iterable[K]): ApiIO[Done]

    Permalink
  66. def remove(keys: K*): ApiIO[Done]

    Permalink
  67. def remove(from: K, to: K): ApiIO[Done]

    Permalink
  68. def remove(key: K): ApiIO[Done]

    Permalink
  69. def reverse: MapStream[K, V]

    Permalink

    Returns the start key when doing reverse iteration.

    Returns the start key when doing reverse iteration.

    If subMaps are included then it will return the starting point to be Key.SubMapsEnd which will iterate backward until Key.MapEntriesStart else returns the starting point to be Key.MapEntriesEnd to fetch entries only.

    Definition Classes
    MapStream
  70. def size: ApiIO[Int]

    Permalink
    Definition Classes
    MapMapStream → Streamable
  71. def sizeOfSegments: Long

    Permalink
  72. def stream: Stream[(K, V), ApiIO]

    Permalink
    Definition Classes
    MapStream
  73. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  74. def take(count: Int): Stream[(K, V), ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  75. def takeWhile(f: ((K, V)) ⇒ Boolean): Stream[(K, V), ApiIO]

    Permalink
    Definition Classes
    MapStream → Streamable
  76. def timeLeft(key: K): ApiIO[Option[FiniteDuration]]

    Permalink
  77. def toString(): String

    Permalink
    Definition Classes
    MapStream → AnyRef → Any
  78. def update(keyValues: Iterable[(K, V)]): ApiIO[Done]

    Permalink
  79. def update(keyValues: (K, V)*): ApiIO[Done]

    Permalink
  80. def update(from: K, to: K, value: V): ApiIO[Done]

    Permalink
  81. def update(key: K, value: V): ApiIO[Done]

    Permalink
  82. def updateValue(value: V): ApiIO[Map[K, V]]

    Permalink
  83. val userDefinedFrom: Boolean

    Permalink
    Definition Classes
    MapStream
  84. def valueSize(value: V): Int

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from MapStream[K, V]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Streamable[(K, V), ApiIO]

Inherited from AnyRef

Inherited from Any

Ungrouped