Class/Object

com.trueaccord.scalapb.scalapb

FieldOptions

Related Docs: object FieldOptions | package scalapb

Permalink

final case class FieldOptions(type: Option[String] = None, scalaName: Option[String] = None, collectionType: Option[String] = None, keyType: Option[String] = None, valueType: Option[String] = None) extends GeneratedMessage with Message[FieldOptions] with Updatable[FieldOptions] with Product with Serializable

collectionType

Can be specified only if this field is repeated. If unspecified, it falls back to the file option named collection_type, which defaults to scala.collection.Seq.

keyType

If the field is a map, you can specify custom Scala types for the key or value.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[FieldOptions], Message[FieldOptions], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldOptions
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FieldOptions(type: Option[String] = None, scalaName: Option[String] = None, collectionType: Option[String] = None, keyType: Option[String] = None, valueType: Option[String] = None)

    Permalink

    collectionType

    Can be specified only if this field is repeated. If unspecified, it falls back to the file option named collection_type, which defaults to scala.collection.Seq.

    keyType

    If the field is a map, you can specify custom Scala types for the key or value.

Value Members

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

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clearCollectionType: FieldOptions

    Permalink
  6. def clearKeyType: FieldOptions

    Permalink
  7. def clearScalaName: FieldOptions

    Permalink
  8. def clearType: FieldOptions

    Permalink
  9. def clearValueType: FieldOptions

    Permalink
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val collectionType: Option[String]

    Permalink

    Can be specified only if this field is repeated.

    Can be specified only if this field is repeated. If unspecified, it falls back to the file option named collection_type, which defaults to scala.collection.Seq.

  12. def companion: FieldOptions.type

    Permalink
    Definition Classes
    FieldOptionsGeneratedMessage
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def getCollectionType: String

    Permalink
  17. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    FieldOptionsGeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    FieldOptionsGeneratedMessage
  19. def getKeyType: String

    Permalink
  20. def getScalaName: String

    Permalink
  21. def getType: String

    Permalink
  22. def getValueType: String

    Permalink
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. val keyType: Option[String]

    Permalink

    If the field is a map, you can specify custom Scala types for the key or value.

  25. def mergeFrom(_input__: CodedInputStream): FieldOptions

    Permalink
    Definition Classes
    FieldOptionsMessage
  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. val scalaName: Option[String]

    Permalink
  30. final def serializedSize: Int

    Permalink
    Definition Classes
    FieldOptionsGeneratedMessage
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage
  33. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage
  34. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage
  35. def toString(): String

    Permalink
    Definition Classes
    FieldOptions → AnyRef → Any
  36. val type: Option[String]

    Permalink
  37. def update(ms: (Lens[FieldOptions, FieldOptions]) ⇒ Mutation[FieldOptions]*): FieldOptions

    Permalink
    Definition Classes
    Updatable
  38. val valueType: Option[String]

    Permalink
  39. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def withCollectionType(__v: String): FieldOptions

    Permalink
  43. def withKeyType(__v: String): FieldOptions

    Permalink
  44. def withScalaName(__v: String): FieldOptions

    Permalink
  45. def withType(__v: String): FieldOptions

    Permalink
  46. def withValueType(__v: String): FieldOptions

    Permalink
  47. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage
  48. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    FieldOptionsGeneratedMessage
  49. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[FieldOptions]

Inherited from Message[FieldOptions]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped