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], noBox: Option[Boolean] = scala.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

Custom annotations to add to the field.

noBox

Do not box this value in Option[T]

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], noBox: Option[Boolean] = scala.None)

    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.

    noBox

    Do not box this value in Option[T]

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 clearNoBox: FieldOptions

  14. def clearScalaName: FieldOptions

  15. def clearType: FieldOptions

  16. def clearValueType: FieldOptions

  17. def clone(): AnyRef

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

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

  19. def companion: FieldOptions.type

    Definition Classes
    FieldOptions → GeneratedMessage

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

    Definition Classes
    AnyRef

  21. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  23. def getCollectionType: String

  24. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    FieldOptions → GeneratedMessage

  25. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    FieldOptions → GeneratedMessage

  26. def getKeyType: String

  27. def getNoBox: Boolean

  28. def getScalaName: String

  29. def getType: String

  30. def getValueType: String

  31. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  32. val keyType: Option[String]

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

  33. def mergeFrom(_input__: CodedInputStream): FieldOptions

    Definition Classes
    FieldOptions → Message

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

    Definition Classes
    AnyRef

  35. val noBox: Option[Boolean]

    Do not box this value in Option[T]

  36. final def notify(): Unit

    Definition Classes
    AnyRef

  37. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  38. val scalaName: Option[String]

  39. final def serializedSize: Int

    Definition Classes
    FieldOptions → GeneratedMessage

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

    Definition Classes
    AnyRef

  41. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage

  42. def toByteString: ByteString

    Definition Classes
    GeneratedMessage

  43. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage

  44. def toProtoString: String

    Returns a human-readable ASCII format representation of this message.

    Returns a human-readable ASCII format representation of this message.

    The original message can be decoded from this format by using fromAscii on the companion object.

    returns

    human-readable representation of this message.

    Definition Classes
    FieldOptions → GeneratedMessage

  45. val type: Option[String]

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

    Definition Classes
    Updatable

  47. val valueType: Option[String]

  48. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

  52. def withCollectionType(__v: String): FieldOptions

  53. def withKeyType(__v: String): FieldOptions

  54. def withNoBox(__v: Boolean): FieldOptions

  55. def withScalaName(__v: String): FieldOptions

  56. def withType(__v: String): FieldOptions

  57. def withValueType(__v: String): FieldOptions

  58. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

  59. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    FieldOptions → GeneratedMessage

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