CompiledSemanticsProtoPlugin

// Idiomatic scala construction.  Implicitly inject manifest.
val scala = ProtoSemantics[UserProto]

// idiomatic java construction.  Construct manifest from Class object.
Semantics<UserProto> java = new ProtoSemantics<UserProto>(UserProto.class);

// Java construction via prototype. Construct manifest from Class object extracted from prototype instance.
Semantics<UserProto> via = new ProtoSemantics<UserProto>(UserProto.getDefaultInstance());

Note, there are a bunch of equivalent ways to construct the semantics. See below:

scala> val lst = Seq(
  |   ProtoSemantics[UserProto],
  |   new ProtoSemantics[UserProto],
  |   ProtoSemantics[UserProto](true),
  |   new ProtoSemantics[UserProto](true),
  |   new ProtoSemantics[UserProto](classOf[UserProto], true),
  |   new ProtoSemantics(classOf[UserProto], true),
  |   new ProtoSemantics(UserProto.getDefaultInstance, true)
  | )
lst: Seq[ProtoSemantics[com.eharmony.matching.common.value.UserProtoBuffs.UserProto]] =
        List(ProtoSemantics(true), ProtoSemantics(true), ProtoSemantics(true), ProtoSemantics(true),
             ProtoSemantics(true), ProtoSemantics(true), ProtoSemantics(true))

scala> lst sameElements Seq.fill(lst.size)(lst.head)
res132: Boolean = true

A: a type of generated protocol buffer message.
dereferenceAsOptional: Whether to treat dereferenced list variables as an Option. If true treat the return value of a dereference operation as an Option. This removes the possibility of a java.lang.IndexOutOfBoundsException being thrown. Instead, it will silently return None. If false, treat the returned value as a required field and don't do any index checking. The default value is true.

Linear Supertypes

Serializable, Serializable, Product, Equals, EitherHelpers, MorphableCompiledSemanticsPlugin, CompiledSemanticsPlugin[A], AnyRef, Any

Instance Constructors

new CompiledSemanticsProtoPlugin(prototype: A)

Construct the semantics, given a prototypical instance of the message type.
Construct the semantics, given a prototypical instance of the message type.
prototype
a prototype instance of the type of message to create. For instance, from Java:
```
final Semantics<UserProto> semantics =
  new ProtoSemantics<UserProto>(UserProto.getDefaultInstance());
```
new CompiledSemanticsProtoPlugin(classValue: Class[A])

Construct the semantics, given the message's Class object.
Construct the semantics, given the message's Class object.
classValue
A Class object of the protocol buffer generated message. For instance, for Java
```
final Semantics<UserProto> semantics =
  new ProtoSemantics<UserProto>(UserProto.class);
```
new CompiledSemanticsProtoPlugin(prototype: A, dereferenceAsOptional: Boolean)

Construct the semantics, given a prototypical instance of the message type.
Construct the semantics, given a prototypical instance of the message type.
prototype
a prototype instance of the type of message to create. For instance, from Java:
```
final Semantics<UserProto> semantics =
  new ProtoSemantics<UserProto>(UserProto.getDefaultInstance(), false);
```
dereferenceAsOptional
Whether to treat dereferenced list variables as an Option.
new CompiledSemanticsProtoPlugin(classValue: Class[A], dereferenceAsOptional: Boolean)

Construct the semantics, given the message's Class object.
Construct the semantics, given the message's Class object.
classValue
A Class object of the protocol buffer generated message. For instance, for Java
```
final Semantics<UserProto> semantics =
  new ProtoSemantics<UserProto>(UserProto.class, false);
```
dereferenceAsOptional
Whether to treat dereferenced list variables as an Option.
new CompiledSemanticsProtoPlugin(dereferenceAsOptional: Boolean = true)(implicit refInfoA: RefInfo[A])

dereferenceAsOptional
Whether to treat dereferenced list variables as an Option. If true treat the return value of a dereference operation as an Option. This removes the possibility of a java.lang.IndexOutOfBoundsException being thrown. Instead, it will silently return None. If false, treat the returned value as a required field and don't do any index checking. The default value is true.

Type Members

type ENS[+A] = Either[Seq[String], A]

Attributes
protected[this]
Definition Classes
EitherHelpers

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
def accessorFunctionCode(spec: String): Either[Seq[String], VariableAccessorCode]

Generate the function body given a spec.
Generate the function body given a spec.
spec
a String specification of the feature for which function code should be generated

Definition Classes
CompiledSemanticsProtoPlugin → CompiledSemanticsPlugin
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dereferenceAsOptional: Boolean

Whether to treat dereferenced list variables as an Option.
Whether to treat dereferenced list variables as an Option. If true treat the return value of a dereference operation as an Option. This removes the possibility of a java.lang.IndexOutOfBoundsException being thrown. Instead, it will silently return None. If false, treat the returned value as a required field and don't do any index checking. The default value is true.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fromValidationNel[A](v: ValidationNel[String, A]): ENS[A]

Attributes
protected[this]
Definition Classes
EitherHelpers
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def inputTypeString: String

Definition Classes
CompiledSemanticsPlugin
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mapSeq[A, B](l: Seq[A])(f: (A) ⇒ ENS[B]): ENS[Seq[B]]

Attributes
protected[this]
Definition Classes
EitherHelpers
def morph[B](implicit ri: RefInfo[B]): Option[CompiledSemanticsPlugin[B]]

Definition Classes
CompiledSemanticsProtoPlugin → MorphableCompiledSemanticsPlugin
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit val refInfoA: RefInfo[A]

Definition Classes
CompiledSemanticsProtoPlugin → CompiledSemanticsPlugin
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toValidationNel[A](e: ENS[A]): ValidationNel[String, A]

Attributes
protected[this]
Definition Classes
EitherHelpers
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( ... )

Related Docs: object CompiledSemanticsProtoPlugin | package proto

case class CompiledSemanticsProtoPlugin[A <: GeneratedMessage](dereferenceAsOptional: Boolean = true)(implicit refInfoA: RefInfo[A]) extends CompiledSemanticsPlugin[A] with MorphableCompiledSemanticsPlugin with EitherHelpers with Product with Serializable

Instance Constructors

new CompiledSemanticsProtoPlugin(prototype: A)

new CompiledSemanticsProtoPlugin(classValue: Class[A])

new CompiledSemanticsProtoPlugin(prototype: A, dereferenceAsOptional: Boolean)

new CompiledSemanticsProtoPlugin(classValue: Class[A], dereferenceAsOptional: Boolean)

new CompiledSemanticsProtoPlugin(dereferenceAsOptional: Boolean = true)(implicit refInfoA: RefInfo[A])

Type Members

type ENS[+A] = Either[Seq[String], A]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def accessorFunctionCode(spec: String): Either[Seq[String], VariableAccessorCode]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val dereferenceAsOptional: Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def fromValidationNel[A](v: ValidationNel[String, A]): ENS[A]

final def getClass(): Class[_]

def inputTypeString: String

final def isInstanceOf[T0]: Boolean

def mapSeq[A, B](l: Seq[A])(f: (A) ⇒ ENS[B]): ENS[Seq[B]]

def morph[B](implicit ri: RefInfo[B]): Option[CompiledSemanticsPlugin[B]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit val refInfoA: RefInfo[A]

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

def toValidationNel[A](e: ENS[A]): ValidationNel[String, A]

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 Product

Inherited from Equals

Inherited from EitherHelpers

Inherited from MorphableCompiledSemanticsPlugin

Inherited from CompiledSemanticsPlugin[A]

Inherited from AnyRef

Inherited from Any

Ungrouped