WithCaoKey1

This trait has a similar interface as CaoBase but: + Has an additional abstract method def key(a: A): String + When interact (get/set/update/..) with couchbase server, instead of

get(docId: String): Future[T]
set(docId: String, t: T): Future[D]

as in CaoBase, we can:

get(a): Future[T]
set(a: A, t: T): Future[D]

So, instead of working with docId: String directly, we can create a Cao (Couchbase Access Object) for own type T (ex UserCao for T=case class User(uid: Long,...)) , and in UserCao, we define def key(uid: Long) = s"my_prefix$id" , then using set/get/.. with uid: Long instead of docId: String To able to do that, we need implement this class' abstract methods: reads(u: U): T and writes(t: T): U

T: type that will be encoded before upsert using writes(t: T): U, and decoded after get using reads(u: U): T
U: the Document's content type, ex JsValue, primitive types,.. See classes that implement com.couchbase.client.java.document.Document for all available type (of course you can implement your own)
D: the Document type

Linear Supertypes

CaoTrait[T, A, U, D], AnyRef, Any

Known Subclasses

JsCao1, StrCao1

Type Members

final type DocumentCAS = (T, Long)

Definition Classes
CaoTrait

Abstract Value Members

abstract def createDoc(id: String, expiry: Int, content: U, cas: Long = 0L): D

Attributes
protected
Definition Classes
CaoTrait
abstract def key(a: A): String

Attributes
protected
abstract def reads(u: U): T

Attributes
protected
Definition Classes
CaoTrait
abstract def writes(t: T): U

Attributes
protected
Definition Classes
CaoTrait

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def change(a: A)(f: (Option[T]) ⇒ T): Future[D]
final def changeBulk(aa: Seq[A])(f: (Option[T]) ⇒ T): Future[Seq[D]]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def expiry(): Int

Attributes
protected
Definition Classes
CaoTrait
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def flatChange(a: A)(f: (Option[T]) ⇒ Future[T]): Future[D]
final def flatChangeBulk(aa: Seq[A])(f: (Option[T]) ⇒ Future[T]): Future[Seq[D]]
final def get(a: A): Future[T]

Definition Classes
WithCaoKey1 → CaoTrait
final def getBulk(aa: Seq[A]): Future[Seq[T]]
final def getBulkWithCAS(aa: Seq[A]): Future[Seq[DocumentCAS]]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getOrElse(a: A)(default: ⇒ T): Future[T]

Definition Classes
WithCaoKey1 → CaoTrait
final def getOrElseWithCAS(a: A)(default: ⇒ T): Future[DocumentCAS]

Definition Classes
WithCaoKey1 → CaoTrait
final def getWithCAS(a: A): Future[(T, Long)]

Definition Classes
WithCaoKey1 → CaoTrait
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def remove(a: A): Future[D]

Definition Classes
WithCaoKey1 → CaoTrait
final def set(a: A, t: T): Future[D]

Definition Classes
WithCaoKey1 → CaoTrait
final def setBulk(aa: Seq[A], tt: Seq[T]): Future[Seq[D]]
final def setT(a: A, t: T): Future[T]

convenient method.
convenient method. = set(..).map(_ => t)

Definition Classes
WithCaoKey1 → CaoTrait
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def update(a: A, t: T, cas: Long = 0): Future[D]

Definition Classes
WithCaoKey1 → CaoTrait
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

final def updateWithCAS(a: A, t: T, cas: Long = 0): Future[D]

Deprecated
use update instead

Related Doc: package access

trait WithCaoKey1[T, A, U, D <: Document[U]] extends CaoTrait[T, A, U, D]

Type Members

final type DocumentCAS = (T, Long)

Abstract Value Members

abstract def createDoc(id: String, expiry: Int, content: U, cas: Long = 0L): D

abstract def key(a: A): String

abstract def reads(u: U): T

abstract def writes(t: T): U

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def change(a: A)(f: (Option[T]) ⇒ T): Future[D]

final def changeBulk(aa: Seq[A])(f: (Option[T]) ⇒ T): Future[Seq[D]]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def expiry(): Int

def finalize(): Unit

final def flatChange(a: A)(f: (Option[T]) ⇒ Future[T]): Future[D]

final def flatChangeBulk(aa: Seq[A])(f: (Option[T]) ⇒ Future[T]): Future[Seq[D]]

final def get(a: A): Future[T]

final def getBulk(aa: Seq[A]): Future[Seq[T]]

final def getBulkWithCAS(aa: Seq[A]): Future[Seq[DocumentCAS]]

final def getClass(): Class[_]

final def getOrElse(a: A)(default: ⇒ T): Future[T]

final def getOrElseWithCAS(a: A)(default: ⇒ T): Future[DocumentCAS]

final def getWithCAS(a: A): Future[(T, Long)]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def remove(a: A): Future[D]

final def set(a: A, t: T): Future[D]

final def setBulk(aa: Seq[A], tt: Seq[T]): Future[Seq[D]]

final def setT(a: A, t: T): Future[T]

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

def toString(): String

final def update(a: A, t: T, cas: Long = 0): Future[D]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

final def updateWithCAS(a: A, t: T, cas: Long = 0): Future[D]

Inherited from CaoTrait[T, A, U, D]

Inherited from AnyRef

Inherited from Any

Ungrouped