akka.contrib.couchbase

Key2

trait Key2[T, A, B] extends ReadsKey2[T, A, B] with WritesKey2[T, A, B]

This trait mix ReadsKey2 with WritesKey2

T

type of the data class that we want to read from and write to CB

A

type of the first param being used to generate the a of a CB document

B

type of the second param being used to generate the a of a CB document

Linear Supertypes
WritesKey2[T, A, B], CBWrites[T], ReadsKey2[T, A, B], CBReads[T], WithCB, HasKey2[A, B], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Key2
  2. WritesKey2
  3. CBWrites
  4. ReadsKey2
  5. CBReads
  6. WithCB
  7. HasKey2
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cb: CouchbaseClient

    Attributes
    protected
    Definition Classes
    WithCB
  2. abstract def key(a: A, b: B): String

    Map 2 param of type A, B to a CB key

    Map 2 param of type A, B to a CB key

    returns

    CB key

    Attributes
    protected
    Definition Classes
    HasKey2
  3. abstract def reads(v: AnyRef): T

    read an Object (gotten from CB) to the data object of type T

    read an Object (gotten from CB) to the data object of type T

    v

    the Object gotten from CB

    returns

    the data object of type T

    Attributes
    protected
    Definition Classes
    CBReads
  4. abstract def writes(v: T): String

    Attributes
    protected
    Definition Classes
    CBWrites

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def Expiry: Int

    Attributes
    protected
    Definition Classes
    CBWrites
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. final def changeBulk(l: Seq[A], b: B)(f: (Option[T]) ⇒ T): Future[Seq[Boolean]]

    Bulk get & change documents

    Bulk get & change documents

    l

    a Seq of type A, will be used to generate a Seq of CB keys

    b

    a value of type B, will be used with seq l to generate a Seq of CB keys

    f

    for each generated key, we will get the document from CB (then we will have a Option[T]). This function f is used to transform the gotten Option[T] to a value (of type T) to set to CB

    returns

    a Future

    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.HasKey2#key

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def delete(a: A, b: B): Future[Boolean]

    Delete the document has key generated from 2 params a, b

    Delete the document has key generated from 2 params a, b

    a

    be used to generate CB key

    b

    be used to generate CB key

    returns

    a Future of java.lang.Boolean

    Definition Classes
    WritesKey2
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.HasKey2#key

  11. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def get(a: A, b: B): Future[T]

    Get the document has key generated from 2 params a, b

    Get the document has key generated from 2 params a, b

    a

    be used to generate CB key

    b

    be used to generate CB key

    returns

    a Future of T (when get success, the gotten value can be null depends on the implement of CBReads[T].reads)

    Definition Classes
    ReadsKey2
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    CBException(ERR_NOT_FOUND) when key not found, or other CBException

    See also

    akka.contrib.couchbase.HasKey2#key

  15. final def get(key: String): Future[T]

    Get the document

    Get the document

    key

    CB key

    returns

    a Future of T (when get success, the gotten value can be null depends on the implement of CBReads[T].reads)

    Definition Classes
    CBReads
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    CBException(ERR_NOT_FOUND) when key not found, or other CBException

    See also

    akka.contrib.couchbase.CBReads#reads

  16. final def getBulk(l: Seq[A], b: B): Future[Seq[T]]

    Bulk get documents

    Bulk get documents

    l

    a Seq of type A, will be used to generate a Seq of CB keys

    b

    a value of type B, will be used with seq l to generate a Seq of CB keys

    returns

    a Future of Seq of T (can be null depends on the implement of CBReads[T].reads)

    Definition Classes
    ReadsKey2
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

    java.util.NoSuchElementException

    insteads of CBException(ERR_NOT_FOUND) when some keys not found

    See also

    akka.contrib.couchbase.CBReads#reads

    akka.contrib.couchbase.HasKey2#key

  17. final def getBulkImpl(keys: Seq[String]): Future[Seq[T]]

    Bulk get documents

    Bulk get documents

    keys

    a Seq of CB keys

    returns

    a Future of Seq of T (can be null depends on the implement of CBReads[T].reads)

    Definition Classes
    CBReads
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

    java.util.NoSuchElementException

    insteads of CBException(ERR_NOT_FOUND) when some keys not found

    See also

    akka.contrib.couchbase.CBReads#reads

  18. final def getBulkOption(l: Seq[A], b: B): Future[Seq[Option[T]]]

    Bulk get documents

    Bulk get documents

    l

    a Seq of type A, will be used to generate a Seq of CB keys

    b

    a value of type B, will be used with seq l to generate a Seq of CB keys

    returns

    a Future of Seq of Option[T]

    Definition Classes
    ReadsKey2
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.CBReads#reads

    akka.contrib.couchbase.HasKey2#key

  19. final def getBulkOptionImpl(keys: Seq[String]): Future[Seq[Option[T]]]

    Bulk get documents

    Bulk get documents

    keys

    a Seq of CB keys

    returns

    a Future of Seq of Option[T]

    Definition Classes
    CBReads
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.CBReads#reads

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

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. final def set(a: A, b: B, value: T): Future[Boolean]

    Set the document has key generated from 2 params a, b

    Set the document has key generated from 2 params a, b

    a

    be used to generate CB key

    b

    be used to generate CB key

    returns

    a Future of java.lang.Boolean

    Definition Classes
    WritesKey2
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.HasKey2#key

  27. final def set(key: String, value: T): Future[Boolean]

    Set the document to CB

    Set the document to CB

    returns

    a Future of java.lang.Boolean

    Definition Classes
    CBWrites
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

  28. final def setBulk(l: Seq[A], b: B, values: Seq[T]): Future[Seq[Boolean]]

    Bulk set documents

    Bulk set documents

    l

    a Seq of type A, will be used to generate a Seq of CB keys

    b

    a value of type B, will be used with seq l to generate a Seq of CB keys

    values

    a Seq of data to store to CB. l and values is mapped 1-1

    returns

    a Future

    Definition Classes
    WritesKey2
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.HasKey2#key

  29. final def setBulkImpl(keys: Seq[String], values: Seq[T]): Future[Seq[Boolean]]

    Bulk set documents

    Bulk set documents

    keys

    a Seq of CB keys

    values

    a Seq of data to store to CB. keys and values is mapped 1-1

    returns

    a Future

    Definition Classes
    CBWrites
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

    when the underlying CouchbaseClient's method fail

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

    Definition Classes
    AnyRef
  31. def toString(): String

    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from WritesKey2[T, A, B]

Inherited from CBWrites[T]

Inherited from ReadsKey2[T, A, B]

Inherited from CBReads[T]

Inherited from WithCB

Inherited from HasKey2[A, B]

Inherited from AnyRef

Inherited from Any

Ungrouped