akka.contrib.couchbase

Key1

trait Key1[T, A] extends ReadsKey1[T, A] with WritesKey1[T, A]

This trait mix ReadsKey1 with WritesKey1

T

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

A

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

Linear Supertypes
WritesKey1[T, A], CBWrites[T], ReadsKey1[T, A], CBReads[T], WithCB, HasKey1[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Key1
  2. WritesKey1
  3. CBWrites
  4. ReadsKey1
  5. CBReads
  6. WithCB
  7. HasKey1
  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): String

    Map a param of type A to a CB key

    Map a param of type A to a CB key

    returns

    CB key

    Attributes
    protected
    Definition Classes
    HasKey1
  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. def clone(): AnyRef

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

    Delete the document has key generated from param a

    Delete the document has key generated from param a

    a

    be used to generate CB key

    returns

    a Future of java.lang.Boolean

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

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.HasKey1#key

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

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

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

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

    Get the document has key generated from param a

    Get the document has key generated from param a

    a

    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
    ReadsKey1
    Exceptions thrown
    akka.contrib.couchbase.CbFutureAsScala.CBException

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

    See also

    akka.contrib.couchbase.HasKey1#key

  14. 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

  15. final def getBulk(l: Seq[A]): 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

    returns

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

    Definition Classes
    ReadsKey1
    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.HasKey1#key

  16. 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

  17. final def getBulkOption(l: Seq[A]): 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

    returns

    a Future of Seq of Option[T]

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

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.CBReads#reads

    akka.contrib.couchbase.HasKey1#key

  18. 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

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

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

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

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

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

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

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

    Set the document has key generated from param a

    Set the document has key generated from param a

    a

    be used to generate CB key

    returns

    a Future of java.lang.Boolean

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

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.HasKey1#key

  26. 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

  27. final def setBulk(l: Seq[A], 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

    values

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

    returns

    a Future

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

    when the underlying CouchbaseClient's method fail

    See also

    akka.contrib.couchbase.HasKey1#key

  28. 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

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

    Definition Classes
    AnyRef
  30. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from WritesKey1[T, A]

Inherited from CBWrites[T]

Inherited from ReadsKey1[T, A]

Inherited from CBReads[T]

Inherited from WithCB

Inherited from HasKey1[A]

Inherited from AnyRef

Inherited from Any

Ungrouped