Packages

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], ApiIO])(implicit keySerializer: Serializer[K], mapKeySerializer: Serializer[Key[K]], keyOrder: KeyOrder[Slice[Byte]], valueSerializerOption: Serializer[Option[V]], valueSerializer: Serializer[V])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def after(key: K): MapStream[K, V]
    Definition Classes
    MapStream
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def before(key: K): MapStream[K, V]
    Definition Classes
    MapStream
  7. def clear(): ApiIO[Done]

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. def closeDatabase(): ApiIO[Unit]
  10. def commit(prepare: Iterable[Prepare[K, V]]): ApiIO[Done]
  11. def commit(entries: Prepare[MapEntry[K], Option[V]]*): ApiIO[Done]
  12. def commitPrepared(prepare: Prepare[K, V]*): ApiIO[Done]
  13. def contains(key: K): ApiIO[Boolean]
  14. def drop(count: Int): Stream[(K, V), ApiIO]
    Definition Classes
    MapStream → Streamable
  15. def dropWhile(f: ((K, V)) ⇒ Boolean): Stream[(K, V), ApiIO]
    Definition Classes
    MapStream → Streamable
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def exists(): ApiIO[Boolean]
  18. def expiration(key: K): ApiIO[Option[Deadline]]
  19. def expire(keys: Iterable[(K, Deadline)]): ApiIO[Done]
  20. def expire(keys: (K, Deadline)*): ApiIO[Done]
  21. def expire(from: K, to: K, at: Deadline): ApiIO[Done]
  22. def expire(from: K, to: K, after: FiniteDuration): ApiIO[Done]
  23. def expire(key: K, at: Deadline): ApiIO[Done]
  24. def expire(key: K, after: FiniteDuration): ApiIO[Done]
  25. def filter(f: ((K, V)) ⇒ Boolean): Stream[(K, V), ApiIO]
    Definition Classes
    MapStream → Streamable
  26. def filterNot(f: ((K, V)) ⇒ Boolean): Stream[(K, V), ApiIO]
    Definition Classes
    MapStream → Streamable
  27. def flatMap[B](f: ((K, V)) ⇒ Stream[B, ApiIO]): Stream[B, ApiIO]
    Definition Classes
    MapStream → Streamable
  28. def foldLeft[B](initial: B)(f: (B, (K, V)) ⇒ B): ApiIO[B]
    Definition Classes
    MapStream → Streamable
  29. def foreach[U](f: ((K, V)) ⇒ U): Stream[Unit, ApiIO]
    Definition Classes
    MapStream → Streamable
  30. def from(key: K): MapStream[K, V]
    Definition Classes
    MapStream
  31. def fromOrAfter(key: K): MapStream[K, V]
    Definition Classes
    MapStream
  32. def fromOrBefore(key: K): MapStream[K, V]
    Definition Classes
    MapStream
  33. def get(key: K): ApiIO[Option[V]]

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

    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)]]
  37. def getValue(): ApiIO[Option[V]]

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

  38. def headOption: ApiIO[Option[(K, V)]]
    Definition Classes
    MapStream → Streamable
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. def isReverse: Boolean
    Definition Classes
    MapStream
  41. def keySize(key: K): Int
  42. def keys: MapKeysStream[K]
  43. def lastOption: ApiIO[Option[(K, V)]]

    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
  45. def levelMeter(levelNumber: Int): Option[LevelMeter]
  46. def map[B](f: ((K, V)) ⇒ B): Stream[B, ApiIO]
    Definition Classes
    MapStream → Streamable
  47. val map: swaydb.Map[Key[K], Option[V], ApiIO]
    Definition Classes
    MapStream
  48. val mapKey: Seq[K]
    Definition Classes
    MapStream
  49. def maps: Maps[K, V]
  50. val mapsOnly: Boolean
    Definition Classes
    MapStream
  51. def mightContain(key: K): ApiIO[Boolean]
  52. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  55. def preparePut(key: K, value: V, deadline: Deadline): Prepare[MapEntry[K], Option[V]]
  56. def preparePut(key: K, value: V, expireAfter: FiniteDuration): Prepare[MapEntry[K], Option[V]]
  57. def preparePut(key: K, value: V): Prepare[MapEntry[K], Option[V]]
  58. def prepareRemove(from: K, to: K): Prepare[MapEntry[K], Option[V]]
  59. def prepareRemove(key: K): Prepare[MapEntry[K], Option[V]]
  60. def put(keyValues: Iterable[(K, V)]): ApiIO[Done]
  61. def put(keyValues: (K, V)*): ApiIO[Done]
  62. def put(key: K, value: V, expireAt: Deadline): ApiIO[Done]
  63. def put(key: K, value: V, expireAfter: FiniteDuration): ApiIO[Done]
  64. def put(key: K, value: V): ApiIO[Done]
  65. def remove(keys: Iterable[K]): ApiIO[Done]
  66. def remove(keys: K*): ApiIO[Done]
  67. def remove(from: K, to: K): ApiIO[Done]
  68. def remove(key: K): ApiIO[Done]
  69. def reverse: MapStream[K, V]

    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]
    Definition Classes
    Map → MapStream → Streamable
  71. def sizeOfSegments: Long
  72. def stream: Stream[(K, V), ApiIO]
    Definition Classes
    MapStream
  73. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  74. def take(count: Int): Stream[(K, V), ApiIO]
    Definition Classes
    MapStream → Streamable
  75. def takeWhile(f: ((K, V)) ⇒ Boolean): Stream[(K, V), ApiIO]
    Definition Classes
    MapStream → Streamable
  76. def timeLeft(key: K): ApiIO[Option[FiniteDuration]]
  77. def toString(): String
    Definition Classes
    MapStream → AnyRef → Any
  78. def update(keyValues: Iterable[(K, V)]): ApiIO[Done]
  79. def update(keyValues: (K, V)*): ApiIO[Done]
  80. def update(from: K, to: K, value: V): ApiIO[Done]
  81. def update(key: K, value: V): ApiIO[Done]
  82. def updateValue(value: V): ApiIO[Map[K, V]]
  83. val userDefinedFrom: Boolean
    Definition Classes
    MapStream
  84. def valueSize(value: V): Int
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    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