Trait

play.api.cache.redis

RedisMap

Related Doc: package redis

Permalink

trait RedisMap[Elem, Result[_]] extends RedisCollection[Map[String, Elem], Result]

Redis Hashes are simply hash maps with strings as keys. It is possible to add elements to a Redis Hashes by adding new elements into the collection.

This simplified wrapper implements only unordered Maps.

Elem

Data type of the inserted element

Linear Supertypes
RedisCollection[Map[String, Elem], Result], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedisMap
  2. RedisCollection
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type This = RedisMap[Elem, Result]

    Permalink
    Definition Classes
    RedisMap → RedisCollection

Abstract Value Members

  1. abstract def add(field: String, value: Elem): Result[This]

    Permalink

    Insert the value at the given key into the map

    Insert the value at the given key into the map

    field

    key

    value

    inserted value

    returns

    the map for the chaining calls

  2. abstract def contains(field: String): Result[Boolean]

    Permalink

    Tests if the field is contained in the map.

    Tests if the field is contained in the map. Returns true if exists, otherwise returns false

    field

    tested field

    returns

    true if exists in the map, otherwise false

    Note

    Time complexity: O(1)

  3. abstract def get(field: String): Result[Option[Elem]]

    Permalink

    Returns the value at the given key into the map

    Returns the value at the given key into the map

    field

    key

    returns

    Some if the value exists in the map, None otherwise

  4. abstract def getFields(fields: Iterable[String]): Result[Seq[Option[Elem]]]

    Permalink

    Returns the values stored at given keys in the map.

    Returns the values stored at given keys in the map. The collection or results has same size as the collection of given fields, it preserves ordering.

    fields

    keys to get

    returns

    Some if the value exists in the map, None otherwise

  5. abstract def increment(field: String, incrementBy: Long = 1): Result[Long]

    Permalink

    Increment a value at the given key in the map

    Increment a value at the given key in the map

    field

    key

    incrementBy

    increment by this

    returns

    value after incrementation

  6. abstract def isEmpty: Result[Boolean]

    Permalink
    Definition Classes
    RedisCollection

  7. abstract def keySet: Result[Set[String]]

    Permalink

    Returns all keys defined in the map

    Returns all keys defined in the map

    returns

    all used keys

  8. abstract def nonEmpty: Result[Boolean]

    Permalink
    Definition Classes
    RedisCollection

  9. abstract def remove(field: String*): Result[This]

    Permalink

    Removes the specified members from the sorted map stored at key.

    Removes the specified members from the sorted map stored at key. Non existing members are ignored. An error is returned when key exists and does not hold a sorted map.

    field

    fields to be removed

    returns

    the map for chaining calls

    Note

    Time complexity: O(N) where N is the number of members to be removed.

  10. abstract def size: Result[Long]

    Permalink

    Returns the length of the collection stored at key.

    Returns the length of the collection stored at key. If key does not exist, it is interpreted as an empty collection and 0 is returned. An error is returned when the value stored at key is not a proper collection.

    Time complexity: O(1)

    returns

    size of the list

    Definition Classes
    RedisCollection

  11. abstract def toMap: Result[Map[String, Elem]]

    Permalink

    Returns all elements in the map

    Returns all elements in the map

    returns

    all elements in the map

    Note

    Time complexity: O(N) where N is the map cardinality.

  12. abstract def values: Result[Set[Elem]]

    Permalink

    Returns all values stored in the map

    Returns all values stored in the map

    returns

    all stored values

Concrete 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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def getFields(fields: String*): Result[Seq[Option[Elem]]]

    Permalink

    Returns the values stored at given keys in the map.

    Returns the values stored at given keys in the map. The collection or results has same size as the collection of given fields, it preserves ordering.

    fields

    keys to get

    returns

    Some if the value exists in the map, None otherwise

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

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

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

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

  20. final def wait(arg0: Long): Unit

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

Inherited from RedisCollection[Map[String, Elem], Result]

Inherited from AnyRef

Inherited from Any

Ungrouped