Packages

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, auxMessageOptions: Seq[AuxMessageOptions] = _root_.scala.Seq.empty, auxFieldOptions: Seq[AuxFieldOptions] = _root_.scala.Seq.empty, auxEnumOptions: Seq[AuxEnumOptions] = _root_.scala.Seq.empty, bytesType: Option[String] = _root_.scala.None, testOnlyNoJavaConversions: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[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.

enumStripPrefix

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

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.

bytesType

Scala type to use for bytes fields.

testOnlyNoJavaConversions

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

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[ScalaPbOptions], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaPbOptions
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. 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, auxMessageOptions: Seq[AuxMessageOptions] = _root_.scala.Seq.empty, auxFieldOptions: Seq[AuxFieldOptions] = _root_.scala.Seq.empty, auxEnumOptions: Seq[AuxEnumOptions] = _root_.scala.Seq.empty, bytesType: Option[String] = _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.

    enumStripPrefix

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

    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.

    bytesType

    Scala type to use for bytes fields.

    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 addAllAuxFieldOptions(__vs: Iterable[AuxFieldOptions]): ScalaPbOptions
  6. def addAllAuxMessageOptions(__vs: Iterable[AuxMessageOptions]): ScalaPbOptions
  7. def addAllImport(__vs: Iterable[String]): ScalaPbOptions
  8. def addAllPreamble(__vs: Iterable[String]): ScalaPbOptions
  9. def addAuxEnumOptions(__vs: AuxEnumOptions*): ScalaPbOptions
  10. def addAuxFieldOptions(__vs: AuxFieldOptions*): ScalaPbOptions
  11. def addAuxMessageOptions(__vs: AuxMessageOptions*): ScalaPbOptions
  12. def addImport(__vs: String*): ScalaPbOptions
  13. def addPreamble(__vs: String*): ScalaPbOptions
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. val auxEnumOptions: Seq[AuxEnumOptions]
  16. val auxFieldOptions: Seq[AuxFieldOptions]
  17. val auxMessageOptions: Seq[AuxMessageOptions]
  18. val bytesType: Option[String]
  19. def clearAuxEnumOptions: ScalaPbOptions
  20. def clearAuxFieldOptions: ScalaPbOptions
  21. def clearAuxMessageOptions: ScalaPbOptions
  22. def clearBytesType: ScalaPbOptions
  23. def clearCollectionType: ScalaPbOptions
  24. def clearEnumStripPrefix: ScalaPbOptions
  25. def clearEnumValueNaming: ScalaPbOptions
  26. def clearFlatPackage: ScalaPbOptions
  27. def clearImport: ScalaPbOptions
  28. def clearLenses: ScalaPbOptions
  29. def clearMapType: ScalaPbOptions
  30. def clearNoDefaultValuesInConstructor: ScalaPbOptions
  31. def clearNoPrimitiveWrappers: ScalaPbOptions
  32. def clearObjectName: ScalaPbOptions
  33. def clearPackageName: ScalaPbOptions
  34. def clearPreamble: ScalaPbOptions
  35. def clearPreserveUnknownFields: ScalaPbOptions
  36. def clearPrimitiveWrappers: ScalaPbOptions
  37. def clearRetainSourceCodeInfo: ScalaPbOptions
  38. def clearScope: ScalaPbOptions
  39. def clearSingleFile: ScalaPbOptions
  40. def clearTestOnlyNoJavaConversions: ScalaPbOptions
  41. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  42. val collectionType: Option[String]
  43. def companion: ScalaPbOptions.type
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  44. def discardUnknownFields: ScalaPbOptions
  45. val enumStripPrefix: Option[Boolean]
  46. val enumValueNaming: Option[EnumValueNaming]
  47. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. val flatPackage: Option[Boolean]
  49. def getBytesType: String
  50. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  51. def getCollectionType: String
  52. def getEnumStripPrefix: Boolean
  53. def getEnumValueNaming: EnumValueNaming
  54. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  55. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  56. def getFlatPackage: Boolean
  57. def getLenses: Boolean
  58. def getMapType: String
  59. def getNoDefaultValuesInConstructor: Boolean
  60. def getNoPrimitiveWrappers: Boolean
  61. def getObjectName: String
  62. def getPackageName: String
  63. def getPreserveUnknownFields: Boolean
  64. def getPrimitiveWrappers: Boolean
  65. def getRetainSourceCodeInfo: Boolean
  66. def getScope: OptionsScope
  67. def getSingleFile: Boolean
  68. def getTestOnlyNoJavaConversions: Boolean
  69. val import: Seq[String]
  70. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  71. val lenses: Option[Boolean]
  72. val mapType: Option[String]
  73. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  74. val noDefaultValuesInConstructor: Option[Boolean]
  75. val noPrimitiveWrappers: Option[Boolean]
  76. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  77. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  78. val objectName: Option[String]
  79. val packageName: Option[String]
  80. val preamble: Seq[String]
  81. val preserveUnknownFields: Option[Boolean]
  82. val primitiveWrappers: Option[Boolean]
  83. val retainSourceCodeInfo: Option[Boolean]
  84. val scope: Option[OptionsScope]
  85. def serializedSize: Int
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  86. val singleFile: Option[Boolean]
  87. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  88. val testOnlyNoJavaConversions: Option[Boolean]
  89. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  90. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  91. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  92. 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
    ScalaPbOptions → GeneratedMessage
  93. val unknownFields: UnknownFieldSet
  94. def update(ms: (Lens[ScalaPbOptions, ScalaPbOptions]) ⇒ Mutation[ScalaPbOptions]*): ScalaPbOptions
    Definition Classes
    Updatable
  95. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  96. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  97. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  98. def withAuxEnumOptions(__v: Seq[AuxEnumOptions]): ScalaPbOptions
  99. def withAuxFieldOptions(__v: Seq[AuxFieldOptions]): ScalaPbOptions
  100. def withAuxMessageOptions(__v: Seq[AuxMessageOptions]): ScalaPbOptions
  101. def withBytesType(__v: String): ScalaPbOptions
  102. def withCollectionType(__v: String): ScalaPbOptions
  103. def withEnumStripPrefix(__v: Boolean): ScalaPbOptions
  104. def withEnumValueNaming(__v: EnumValueNaming): ScalaPbOptions
  105. def withFlatPackage(__v: Boolean): ScalaPbOptions
  106. def withImport(__v: Seq[String]): ScalaPbOptions
  107. def withLenses(__v: Boolean): ScalaPbOptions
  108. def withMapType(__v: String): ScalaPbOptions
  109. def withNoDefaultValuesInConstructor(__v: Boolean): ScalaPbOptions
  110. def withNoPrimitiveWrappers(__v: Boolean): ScalaPbOptions
  111. def withObjectName(__v: String): ScalaPbOptions
  112. def withPackageName(__v: String): ScalaPbOptions
  113. def withPreamble(__v: Seq[String]): ScalaPbOptions
  114. def withPreserveUnknownFields(__v: Boolean): ScalaPbOptions
  115. def withPrimitiveWrappers(__v: Boolean): ScalaPbOptions
  116. def withRetainSourceCodeInfo(__v: Boolean): ScalaPbOptions
  117. def withScope(__v: OptionsScope): ScalaPbOptions
  118. def withSingleFile(__v: Boolean): ScalaPbOptions
  119. def withTestOnlyNoJavaConversions(__v: Boolean): ScalaPbOptions
  120. def withUnknownFields(__v: UnknownFieldSet): ScalaPbOptions
  121. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  122. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  123. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from Updatable[ScalaPbOptions]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped