Class/Object

scalapb.options

FieldOptions

Related Docs: object FieldOptions | package options

Permalink

final case class FieldOptions(type: Option[String] = _root_.scala.None, scalaName: Option[String] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, keyType: Option[String] = _root_.scala.None, valueType: Option[String] = _root_.scala.None, annotations: Seq[String] = _root_.scala.collection.Seq.empty, mapType: Option[String] = _root_.scala.None, noBox: Option[Boolean] = _root_.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.

mapType

Can be specified only if this field is a map. If unspecified, it falls back to the file option named map_type which defaults to scala.collection.immutable.Map

noBox

Do not box this value in Option[T]

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] = _root_.scala.None, scalaName: Option[String] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, keyType: Option[String] = _root_.scala.None, valueType: Option[String] = _root_.scala.None, annotations: Seq[String] = _root_.scala.collection.Seq.empty, mapType: Option[String] = _root_.scala.None, noBox: Option[Boolean] = _root_.scala.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.

    annotations

    Custom annotations to add to the field.

    mapType

    Can be specified only if this field is a map. If unspecified, it falls back to the file option named map_type which defaults to scala.collection.immutable.Map

    noBox

    Do not box this value in Option[T]

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

    Permalink

  12. def clearNoBox: FieldOptions

    Permalink

  13. def clearScalaName: FieldOptions

    Permalink

  14. def clearType: FieldOptions

    Permalink

  15. def clearValueType: FieldOptions

    Permalink

  16. def clone(): AnyRef

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

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

  18. def companion: FieldOptions.type

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

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

    Permalink
    Definition Classes
    AnyRef

  20. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  22. def getCollectionType: String

    Permalink

  23. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

  24. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

  25. def getKeyType: String

    Permalink

  26. def getMapType: String

    Permalink

  27. def getNoBox: Boolean

    Permalink

  28. def getScalaName: String

    Permalink

  29. def getType: String

    Permalink

  30. def getValueType: String

    Permalink

  31. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  32. val keyType: Option[String]

    Permalink

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

  33. val mapType: Option[String]

    Permalink

    Can be specified only if this field is a map.

    Can be specified only if this field is a map. If unspecified, it falls back to the file option named map_type which defaults to scala.collection.immutable.Map

  34. def mergeFrom(_input__: CodedInputStream): FieldOptions

    Permalink
    Definition Classes
    FieldOptions → Message

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

    Permalink
    Definition Classes
    AnyRef

  36. val noBox: Option[Boolean]

    Permalink

    Do not box this value in Option[T]

  37. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  38. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  39. val scalaName: Option[String]

    Permalink

  40. final def serializedSize: Int

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

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

    Permalink
    Definition Classes
    AnyRef

  42. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage

  43. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage

  44. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage

  45. def toProtoString: String

    Permalink

    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

  46. val type: Option[String]

    Permalink

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

    Permalink
    Definition Classes
    Updatable

  48. val valueType: Option[String]

    Permalink

  49. final def wait(): Unit

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

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

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

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

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

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

    Permalink

  53. def withCollectionType(__v: String): FieldOptions

    Permalink

  54. def withKeyType(__v: String): FieldOptions

    Permalink

  55. def withMapType(__v: String): FieldOptions

    Permalink

  56. def withNoBox(__v: Boolean): FieldOptions

    Permalink

  57. def withScalaName(__v: String): FieldOptions

    Permalink

  58. def withType(__v: String): FieldOptions

    Permalink

  59. def withValueType(__v: String): FieldOptions

    Permalink

  60. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

  61. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    FieldOptions → GeneratedMessage

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