scalapb.options

FieldOptions

final case class FieldOptions(type: Option[String] = scala.None, scalaName: Option[String] = scala.None, collectionType: Option[String] = scala.None, keyType: Option[String] = scala.None, valueType: Option[String] = scala.None, annotations: Seq[String] = scala.collection.Seq.empty[Nothing]) 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( 0L )
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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FieldOptions(type: Option[String] = scala.None, scalaName: Option[String] = scala.None, collectionType: Option[String] = scala.None, keyType: Option[String] = scala.None, valueType: Option[String] = scala.None, annotations: Seq[String] = scala.collection.Seq.empty[Nothing])

    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: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def addAllAnnotations(__vs: TraversableOnce[String]): FieldOptions

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

  8. val annotations: Seq[String]

    Custom annotations to add to the field.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clearAnnotations: FieldOptions

  11. def clearCollectionType: FieldOptions

  12. def clearKeyType: FieldOptions

  13. def clearScalaName: FieldOptions

  14. def clearType: FieldOptions

  15. def clearValueType: FieldOptions

  16. def clone(): AnyRef

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

  17. val collectionType: Option[String]

    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.

  18. def companion: FieldOptions.type

    Definition Classes
    FieldOptions → GeneratedMessage

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

    Definition Classes
    AnyRef

  20. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  22. def getCollectionType: String

  23. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    FieldOptions → GeneratedMessage

  24. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    FieldOptions → GeneratedMessage

  25. def getKeyType: String

  26. def getScalaName: String

  27. def getType: String

  28. def getValueType: String

  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  30. val keyType: Option[String]

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

  31. def mergeFrom(_input__: CodedInputStream): FieldOptions

    Definition Classes
    FieldOptions → Message

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

    Definition Classes
    AnyRef

  33. final def notify(): Unit

    Definition Classes
    AnyRef

  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  35. val scalaName: Option[String]

  36. final def serializedSize: Int

    Definition Classes
    FieldOptions → GeneratedMessage

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

    Definition Classes
    AnyRef

  38. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage

  39. def toByteString: ByteString

    Definition Classes
    GeneratedMessage

  40. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage

  41. def toString(): String

    Definition Classes
    FieldOptions → AnyRef → Any

  42. val type: Option[String]

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

    Definition Classes
    Updatable

  44. val valueType: Option[String]

  45. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

  49. def withCollectionType(__v: String): FieldOptions

  50. def withKeyType(__v: String): FieldOptions

  51. def withScalaName(__v: String): FieldOptions

  52. def withType(__v: String): FieldOptions

  53. def withValueType(__v: String): FieldOptions

  54. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

  55. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    FieldOptions → GeneratedMessage

  56. def writeTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    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