ProtoAccessor

Contains either and option factory methods to produce ProtoAccessor from string-based paths. Note that conversions can be called explicitly or can be used implicitly. In the following examples, Score's definition can be found at aloha-proto/Scores.proto.

import com.eharmony.aloha.score.Scores.Score

// Explicit
val a1: Either[String, ProtoAccessor[Score, Option[Long]]] =
  ProtoAccessor.either[Score, Option[Long]]("error.model.id")

// a2: Either[String, ProtoAccessor[Score, Option[Long]]]
val a2 = ProtoAccessor.either[Score, Option[Long]]("error.model.id")

// Implicit
val a3: Either[String, ProtoAccessor[Score, Option[String]]] = "error.model.name"

// Implicit, many at a time ...
val as: Seq[Either[String, ProtoAccessor[Score, Option[Long]]]] =
  Seq("error.model.id", "error.model.id")

If error information isn't important, use the Option-based API:

import com.eharmony.aloha.score.Scores.Score

// Explicit

val a1: Option[ProtoAccessor[Score, Option[Long]]] =
  ProtoAccessor.option[Score, Option[Long]]("error.model.id")

// Implicit

val a3: Option[ProtoAccessor[Score, Option[String]]] = "error.model.name"

An attempt is made to fully respect types so the following won't work because "error.model.id" is represented by a Long in the protobuf definition:

// Returns error message on the Left.
import com.eharmony.aloha.score.Scores.Score
val a1: Either[String, ProtoAccessor[Score, Option[Int]]] = "error.model.id"

Additionally, Option and non-Option based accessors are respected. If a non-required path element is found in the path, and the accessor doesn't return an Option, an error will be returned:

// Returns error message on the Left because "error" is optional in the PB definition.
import com.eharmony.aloha.score.Scores.Score
val a1: Either[String, ProtoAccessor[Score, Long]] = "error.model.id"

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit def either[A <: GeneratedMessage, B](path: String)(implicit ops: ProtoOps[A], c: Caster[A, B]): Either[String, ProtoAccessor[A, B]]

Attempt to create a protobuf accessor: Right(ProtoAccessor[A, B]).
Attempt to create a protobuf accessor: Right(ProtoAccessor[A, B]). If an error is encountered Left will contain the error message.
A
type of GeneratedMessage from which data should be extracted.
B
type of data to be extracted from A.
path
the path string
ops
an instance of deaktator.pops.msgs.ProtoOps to help with accessor function creation.
c
a caster that takes the untyped value returned by the PB reflection APIs and provides a typesafe value.
returns
an accessor on the right or an error message on the left.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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
implicit def option[A <: GeneratedMessage, B](path: String)(implicit ops: ProtoOps[A], c: Caster[A, B]): Option[ProtoAccessor[A, B]]

Attempt to create a protobuf accessor: Some(ProtoAccessor[A, B]).
Attempt to create a protobuf accessor: Some(ProtoAccessor[A, B]). If an error is encountered None is returned. This doesn't provide diagnostic information like ProtoAccessor.either does.
A
type of GeneratedMessage from which data should be extracted.
B
type of data to be extracted from A.
path
the path string
ops
an instance of deaktator.pops.msgs.ProtoOps to help with accessor function creation.
c
a caster that takes the untyped value returned by the PB reflection APIs and provides a typesafe value.
returns
an accessor or None if an error is encountered.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

object ProtoAccessor extends Serializable

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

implicit def either[A <: GeneratedMessage, B](path: String)(implicit ops: ProtoOps[A], c: Caster[A, B]): Either[String, ProtoAccessor[A, B]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def option[A <: GeneratedMessage, B](path: String)(implicit ops: ProtoOps[A], c: Caster[A, B]): Option[ProtoAccessor[A, B]]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped