final case class ScalaPbOptions(packageName: Option[String] = _root_.scala.None, flatPackage: Option[Boolean] = _root_.scala.None, import: Seq[String] = _root_.scala.Seq.empty, preamble: Seq[String] = _root_.scala.Seq.empty, singleFile: Option[Boolean] = _root_.scala.None, noPrimitiveWrappers: Option[Boolean] = _root_.scala.None, primitiveWrappers: Option[Boolean] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, preserveUnknownFields: Option[Boolean] = _root_.scala.None, objectName: Option[String] = _root_.scala.None, scope: Option[OptionsScope] = _root_.scala.None, lenses: Option[Boolean] = _root_.scala.None, retainSourceCodeInfo: Option[Boolean] = _root_.scala.None, mapType: Option[String] = _root_.scala.None, noDefaultValuesInConstructor: Option[Boolean] = _root_.scala.None, enumValueNaming: Option[EnumValueNaming] = _root_.scala.None, enumStripPrefix: Option[Boolean] = _root_.scala.None, bytesType: Option[String] = _root_.scala.None, javaConversions: Option[Boolean] = _root_.scala.None, auxMessageOptions: Seq[AuxMessageOptions] = _root_.scala.Seq.empty, auxFieldOptions: Seq[AuxFieldOptions] = _root_.scala.Seq.empty, auxEnumOptions: Seq[AuxEnumOptions] = _root_.scala.Seq.empty, auxEnumValueOptions: Seq[AuxEnumValueOptions] = _root_.scala.Seq.empty, preprocessors: Seq[String] = _root_.scala.Seq.empty, fieldTransformations: Seq[FieldTransformation] = _root_.scala.Seq.empty, ignoreAllTransformations: Option[Boolean] = _root_.scala.None, getters: Option[Boolean] = _root_.scala.None, testOnlyNoJavaConversions: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ScalaPbOptions] with ExtendableMessage[ScalaPbOptions] with Product with Serializable

packageName

If set then it overrides the java_package and package.

flatPackage

If true, the compiler does not append the proto base file name into the generated package name. If false (the default), the generated scala package name is the package_name.basename where basename is the proto file name without the .proto extension.

import

Adds the following imports at the top of the file (this is meant to provide implicit TypeMappers)

preamble

Text to add to the generated scala file. This can be used only when single_file is true.

singleFile

If true, all messages and enums (but not services) will be written to a single Scala file.

noPrimitiveWrappers

By default, wrappers defined at https://github.com/google/protobuf/blob/master/src/google/protobuf/wrappers.proto, are mapped to an Option[T] where T is a primitive type. When this field is set to true, we do not perform this transformation.

primitiveWrappers

DEPRECATED. In ScalaPB <= 0.5.47, it was necessary to explicitly enable primitive_wrappers. This field remains here for backwards compatibility, but it has no effect on generated code. It is an error to set both primitive_wrappers and no_primitive_wrappers.

collectionType

Scala type to be used for repeated fields. If unspecified, scala.collection.Seq will be used.

preserveUnknownFields

If set to true, all generated messages in this file will preserve unknown fields.

objectName

If defined, sets the name of the file-level object that would be generated. This object extends GeneratedFileObject and contains descriptors, and list of message and enum companions.

scope

Experimental: scope to apply the given options.

lenses

If true, lenses will be generated.

retainSourceCodeInfo

If true, then source-code info information will be included in the generated code - normally the source code info is cleared out to reduce code size. The source code info is useful for extracting source code location from the descriptors as well as comments.

mapType

Scala type to be used for maps. If unspecified, scala.collection.immutable.Map will be used.

noDefaultValuesInConstructor

If true, no default values will be generated in message constructors. This setting can be overridden at the message-level and for individual fields.

enumStripPrefix

Indicate if prefix (enum name + optional underscore) should be removed in scala code Strip is applied before enum value naming changes.

bytesType

Scala type to use for bytes fields.

javaConversions

Enable java conversions for this file.

auxMessageOptions

List of message options to apply to some messages.

auxFieldOptions

List of message options to apply to some fields.

auxEnumOptions

List of message options to apply to some enums.

auxEnumValueOptions

List of enum value options to apply to some enum values.

preprocessors

List of preprocessors to apply.

ignoreAllTransformations

Ignores all transformations for this file. This is meant to allow specific files to opt out from transformations inherited through package-scoped options.

getters

If true, getters will be generated.

testOnlyNoJavaConversions

For use in tests only. Inhibit Java conversions even when when generator parameters request for it.

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

Instance Constructors

  1. new ScalaPbOptions(packageName: Option[String] = _root_.scala.None, flatPackage: Option[Boolean] = _root_.scala.None, import: Seq[String] = _root_.scala.Seq.empty, preamble: Seq[String] = _root_.scala.Seq.empty, singleFile: Option[Boolean] = _root_.scala.None, noPrimitiveWrappers: Option[Boolean] = _root_.scala.None, primitiveWrappers: Option[Boolean] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, preserveUnknownFields: Option[Boolean] = _root_.scala.None, objectName: Option[String] = _root_.scala.None, scope: Option[OptionsScope] = _root_.scala.None, lenses: Option[Boolean] = _root_.scala.None, retainSourceCodeInfo: Option[Boolean] = _root_.scala.None, mapType: Option[String] = _root_.scala.None, noDefaultValuesInConstructor: Option[Boolean] = _root_.scala.None, enumValueNaming: Option[EnumValueNaming] = _root_.scala.None, enumStripPrefix: Option[Boolean] = _root_.scala.None, bytesType: Option[String] = _root_.scala.None, javaConversions: Option[Boolean] = _root_.scala.None, auxMessageOptions: Seq[AuxMessageOptions] = _root_.scala.Seq.empty, auxFieldOptions: Seq[AuxFieldOptions] = _root_.scala.Seq.empty, auxEnumOptions: Seq[AuxEnumOptions] = _root_.scala.Seq.empty, auxEnumValueOptions: Seq[AuxEnumValueOptions] = _root_.scala.Seq.empty, preprocessors: Seq[String] = _root_.scala.Seq.empty, fieldTransformations: Seq[FieldTransformation] = _root_.scala.Seq.empty, ignoreAllTransformations: Option[Boolean] = _root_.scala.None, getters: Option[Boolean] = _root_.scala.None, testOnlyNoJavaConversions: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = ...)

    packageName

    If set then it overrides the java_package and package.

    flatPackage

    If true, the compiler does not append the proto base file name into the generated package name. If false (the default), the generated scala package name is the package_name.basename where basename is the proto file name without the .proto extension.

    import

    Adds the following imports at the top of the file (this is meant to provide implicit TypeMappers)

    preamble

    Text to add to the generated scala file. This can be used only when single_file is true.

    singleFile

    If true, all messages and enums (but not services) will be written to a single Scala file.

    noPrimitiveWrappers

    By default, wrappers defined at https://github.com/google/protobuf/blob/master/src/google/protobuf/wrappers.proto, are mapped to an Option[T] where T is a primitive type. When this field is set to true, we do not perform this transformation.

    primitiveWrappers

    DEPRECATED. In ScalaPB <= 0.5.47, it was necessary to explicitly enable primitive_wrappers. This field remains here for backwards compatibility, but it has no effect on generated code. It is an error to set both primitive_wrappers and no_primitive_wrappers.

    collectionType

    Scala type to be used for repeated fields. If unspecified, scala.collection.Seq will be used.

    preserveUnknownFields

    If set to true, all generated messages in this file will preserve unknown fields.

    objectName

    If defined, sets the name of the file-level object that would be generated. This object extends GeneratedFileObject and contains descriptors, and list of message and enum companions.

    scope

    Experimental: scope to apply the given options.

    lenses

    If true, lenses will be generated.

    retainSourceCodeInfo

    If true, then source-code info information will be included in the generated code - normally the source code info is cleared out to reduce code size. The source code info is useful for extracting source code location from the descriptors as well as comments.

    mapType

    Scala type to be used for maps. If unspecified, scala.collection.immutable.Map will be used.

    noDefaultValuesInConstructor

    If true, no default values will be generated in message constructors. This setting can be overridden at the message-level and for individual fields.

    enumStripPrefix

    Indicate if prefix (enum name + optional underscore) should be removed in scala code Strip is applied before enum value naming changes.

    bytesType

    Scala type to use for bytes fields.

    javaConversions

    Enable java conversions for this file.

    auxMessageOptions

    List of message options to apply to some messages.

    auxFieldOptions

    List of message options to apply to some fields.

    auxEnumOptions

    List of message options to apply to some enums.

    auxEnumValueOptions

    List of enum value options to apply to some enum values.

    preprocessors

    List of preprocessors to apply.

    ignoreAllTransformations

    Ignores all transformations for this file. This is meant to allow specific files to opt out from transformations inherited through package-scoped options.

    getters

    If true, getters will be generated.

    testOnlyNoJavaConversions

    For use in tests only. Inhibit Java conversions even when when generator parameters request for it.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllAuxEnumOptions(__vs: Iterable[AuxEnumOptions]): ScalaPbOptions
  5. def addAllAuxEnumValueOptions(__vs: Iterable[AuxEnumValueOptions]): ScalaPbOptions
  6. def addAllAuxFieldOptions(__vs: Iterable[AuxFieldOptions]): ScalaPbOptions
  7. def addAllAuxMessageOptions(__vs: Iterable[AuxMessageOptions]): ScalaPbOptions
  8. def addAllFieldTransformations(__vs: Iterable[FieldTransformation]): ScalaPbOptions
  9. def addAllImport(__vs: Iterable[String]): ScalaPbOptions
  10. def addAllPreamble(__vs: Iterable[String]): ScalaPbOptions
  11. def addAllPreprocessors(__vs: Iterable[String]): ScalaPbOptions
  12. def addAuxEnumOptions(__vs: AuxEnumOptions*): ScalaPbOptions
  13. def addAuxEnumValueOptions(__vs: AuxEnumValueOptions*): ScalaPbOptions
  14. def addAuxFieldOptions(__vs: AuxFieldOptions*): ScalaPbOptions
  15. def addAuxMessageOptions(__vs: AuxMessageOptions*): ScalaPbOptions
  16. def addFieldTransformations(__vs: FieldTransformation*): ScalaPbOptions
  17. def addImport(__vs: String*): ScalaPbOptions
  18. def addPreamble(__vs: String*): ScalaPbOptions
  19. def addPreprocessors(__vs: String*): ScalaPbOptions
  20. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  21. val auxEnumOptions: Seq[AuxEnumOptions]
  22. val auxEnumValueOptions: Seq[AuxEnumValueOptions]
  23. val auxFieldOptions: Seq[AuxFieldOptions]
  24. val auxMessageOptions: Seq[AuxMessageOptions]
  25. val bytesType: Option[String]
  26. def clearAuxEnumOptions: ScalaPbOptions
  27. def clearAuxEnumValueOptions: ScalaPbOptions
  28. def clearAuxFieldOptions: ScalaPbOptions
  29. def clearAuxMessageOptions: ScalaPbOptions
  30. def clearBytesType: ScalaPbOptions
  31. def clearCollectionType: ScalaPbOptions
  32. def clearEnumStripPrefix: ScalaPbOptions
  33. def clearEnumValueNaming: ScalaPbOptions
  34. def clearFieldTransformations: ScalaPbOptions
  35. def clearFlatPackage: ScalaPbOptions
  36. def clearGetters: ScalaPbOptions
  37. def clearIgnoreAllTransformations: ScalaPbOptions
  38. def clearImport: ScalaPbOptions
  39. def clearJavaConversions: ScalaPbOptions
  40. def clearLenses: ScalaPbOptions
  41. def clearMapType: ScalaPbOptions
  42. def clearNoDefaultValuesInConstructor: ScalaPbOptions
  43. def clearNoPrimitiveWrappers: ScalaPbOptions
  44. def clearObjectName: ScalaPbOptions
  45. def clearPackageName: ScalaPbOptions
  46. def clearPreamble: ScalaPbOptions
  47. def clearPreprocessors: ScalaPbOptions
  48. def clearPreserveUnknownFields: ScalaPbOptions
  49. def clearPrimitiveWrappers: ScalaPbOptions
  50. def clearRetainSourceCodeInfo: ScalaPbOptions
  51. def clearScope: ScalaPbOptions
  52. def clearSingleFile: ScalaPbOptions
  53. def clearTestOnlyNoJavaConversions: ScalaPbOptions
  54. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  55. val collectionType: Option[String]
  56. def companion: ScalaPbOptions.type
    Definition Classes
    ScalaPbOptionsGeneratedMessage
  57. def discardUnknownFields: ScalaPbOptions
  58. val enumStripPrefix: Option[Boolean]
  59. val enumValueNaming: Option[EnumValueNaming]
  60. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. def extension[T](generatedExtension: GeneratedExtension[ScalaPbOptions, T]): T
    Definition Classes
    ExtendableMessage
  62. val fieldTransformations: Seq[FieldTransformation]
  63. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  64. val flatPackage: Option[Boolean]
  65. def getBytesType: String
  66. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  67. def getCollectionType: String
  68. def getEnumStripPrefix: Boolean
  69. def getEnumValueNaming: EnumValueNaming
  70. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ScalaPbOptionsGeneratedMessage
  71. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ScalaPbOptionsGeneratedMessage
  72. def getFlatPackage: Boolean
  73. def getGetters: Boolean
  74. def getIgnoreAllTransformations: Boolean
  75. def getJavaConversions: Boolean
  76. def getLenses: Boolean
  77. def getMapType: String
  78. def getNoDefaultValuesInConstructor: Boolean
  79. def getNoPrimitiveWrappers: Boolean
  80. def getObjectName: String
  81. def getPackageName: String
  82. def getPreserveUnknownFields: Boolean
  83. def getPrimitiveWrappers: Boolean
  84. def getRetainSourceCodeInfo: Boolean
  85. def getScope: OptionsScope
  86. def getSingleFile: Boolean
  87. def getTestOnlyNoJavaConversions: Boolean
  88. val getters: Option[Boolean]
  89. val ignoreAllTransformations: Option[Boolean]
  90. val import: Seq[String]
  91. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  92. val javaConversions: Option[Boolean]
  93. val lenses: Option[Boolean]
  94. val mapType: Option[String]
  95. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  96. val noDefaultValuesInConstructor: Option[Boolean]
  97. val noPrimitiveWrappers: Option[Boolean]
  98. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  99. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  100. val objectName: Option[String]
  101. val packageName: Option[String]
  102. val preamble: Seq[String]
  103. val preprocessors: Seq[String]
  104. val preserveUnknownFields: Option[Boolean]
  105. val primitiveWrappers: Option[Boolean]
  106. val retainSourceCodeInfo: Option[Boolean]
  107. val scope: Option[OptionsScope]
  108. def serializedSize: Int
    Definition Classes
    ScalaPbOptionsGeneratedMessage
  109. val singleFile: Option[Boolean]
  110. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  111. val testOnlyNoJavaConversions: Option[Boolean]
  112. final def toByteArray: Array[Byte]

    Serializes the message and returns a byte array containing its raw bytes

    Serializes the message and returns a byte array containing its raw bytes

    Definition Classes
    GeneratedMessage
  113. final def toByteString: ByteString

    Serializes the message and returns a ByteString containing its raw bytes

    Serializes the message and returns a ByteString containing its raw bytes

    Definition Classes
    GeneratedMessage
  114. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  115. 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
    ScalaPbOptionsGeneratedMessage
  116. val unknownFields: UnknownFieldSet
    Definition Classes
    ScalaPbOptionsExtendableMessage
  117. def update(ms: (Lens[ScalaPbOptions, ScalaPbOptions]) ⇒ Mutation[ScalaPbOptions]*): ScalaPbOptions
    Definition Classes
    Updatable
  118. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  120. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  121. def withAuxEnumOptions(__v: Seq[AuxEnumOptions]): ScalaPbOptions
  122. def withAuxEnumValueOptions(__v: Seq[AuxEnumValueOptions]): ScalaPbOptions
  123. def withAuxFieldOptions(__v: Seq[AuxFieldOptions]): ScalaPbOptions
  124. def withAuxMessageOptions(__v: Seq[AuxMessageOptions]): ScalaPbOptions
  125. def withBytesType(__v: String): ScalaPbOptions
  126. def withCollectionType(__v: String): ScalaPbOptions
  127. def withEnumStripPrefix(__v: Boolean): ScalaPbOptions
  128. def withEnumValueNaming(__v: EnumValueNaming): ScalaPbOptions
  129. def withExtension[T](generatedExtension: GeneratedExtension[ScalaPbOptions, T])(value: T): ScalaPbOptions
    Definition Classes
    ExtendableMessage
  130. def withFieldTransformations(__v: Seq[FieldTransformation]): ScalaPbOptions
  131. def withFlatPackage(__v: Boolean): ScalaPbOptions
  132. def withGetters(__v: Boolean): ScalaPbOptions
  133. def withIgnoreAllTransformations(__v: Boolean): ScalaPbOptions
  134. def withImport(__v: Seq[String]): ScalaPbOptions
  135. def withJavaConversions(__v: Boolean): ScalaPbOptions
  136. def withLenses(__v: Boolean): ScalaPbOptions
  137. def withMapType(__v: String): ScalaPbOptions
  138. def withNoDefaultValuesInConstructor(__v: Boolean): ScalaPbOptions
  139. def withNoPrimitiveWrappers(__v: Boolean): ScalaPbOptions
  140. def withObjectName(__v: String): ScalaPbOptions
  141. def withPackageName(__v: String): ScalaPbOptions
  142. def withPreamble(__v: Seq[String]): ScalaPbOptions
  143. def withPreprocessors(__v: Seq[String]): ScalaPbOptions
  144. def withPreserveUnknownFields(__v: Boolean): ScalaPbOptions
  145. def withPrimitiveWrappers(__v: Boolean): ScalaPbOptions
  146. def withRetainSourceCodeInfo(__v: Boolean): ScalaPbOptions
  147. def withScope(__v: OptionsScope): ScalaPbOptions
  148. def withSingleFile(__v: Boolean): ScalaPbOptions
  149. def withTestOnlyNoJavaConversions(__v: Boolean): ScalaPbOptions
  150. def withUnknownFields(__v: UnknownFieldSet): ScalaPbOptions
    Definition Classes
    ScalaPbOptionsExtendableMessage
  151. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  152. def writeTo(_output__: CodedOutputStream): Unit

    Serializes the message into the given coded output stream

    Serializes the message into the given coded output stream

    Definition Classes
    ScalaPbOptionsGeneratedMessage
  153. final def writeTo(output: OutputStream): Unit

    Serializes the message into the given output stream

    Serializes the message into the given output stream

    Definition Classes
    GeneratedMessage

Inherited from Updatable[ScalaPbOptions]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped