Class/Object

scalapb.options

FieldOptions

Related Docs: object FieldOptions | package options

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, annotations: Seq[String] = _root_.scala.collection.Seq.empty) 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

Custom annotations to add to the field.

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, annotations: Seq[String] = _root_.scala.collection.Seq.empty)

    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.

    annotations

    Custom annotations to add to the field.

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. def addAllAnnotations(__vs: TraversableOnce[String]): FieldOptions

    Permalink

  5. def addAnnotations(__vs: String*): FieldOptions

    Permalink

  6. val annotations: Seq[String]

    Permalink

    Custom annotations to add to the field.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clearAnnotations: FieldOptions

    Permalink

  9. def clearCollectionType: FieldOptions

    Permalink

  10. def clearKeyType: FieldOptions

    Permalink

  11. def clearScalaName: FieldOptions

    Permalink

  12. def clearType: FieldOptions

    Permalink

  13. def clearValueType: FieldOptions

    Permalink

  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

  16. def companion: FieldOptions.type

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

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

    Permalink
    Definition Classes
    AnyRef

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. def getCollectionType: String

    Permalink

  21. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

  22. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

  23. def getKeyType: String

    Permalink

  24. def getScalaName: String

    Permalink

  25. def getType: String

    Permalink

  26. def getValueType: String

    Permalink

  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  28. val keyType: Option[String]

    Permalink

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

  29. def mergeFrom(_input__: CodedInputStream): FieldOptions

    Permalink
    Definition Classes
    FieldOptions → Message

  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  33. val scalaName: Option[String]

    Permalink

  34. final def serializedSize: Int

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

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

    Permalink
    Definition Classes
    AnyRef

  36. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage

  37. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage

  38. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage

  39. def toString(): String

    Permalink
    Definition Classes
    FieldOptions → AnyRef → Any

  40. val type: Option[String]

    Permalink

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

    Permalink
    Definition Classes
    Updatable

  42. val valueType: Option[String]

    Permalink

  43. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  46. def withAnnotations(__v: Seq[String]): FieldOptions

    Permalink

  47. def withCollectionType(__v: String): FieldOptions

    Permalink

  48. def withKeyType(__v: String): FieldOptions

    Permalink

  49. def withScalaName(__v: String): FieldOptions

    Permalink

  50. def withType(__v: String): FieldOptions

    Permalink

  51. def withValueType(__v: String): FieldOptions

    Permalink

  52. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

  53. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

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