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, preprocessors: Seq[String] = _root_.scala.Seq.empty, testOnlyNoJavaConversions: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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
andno_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()
- Alphabetic
- By Inheritance
- ScalaPbOptions
- Product
- Equals
- ExtendableMessage
- Updatable
- GeneratedMessage
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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, preprocessors: Seq[String] = _root_.scala.Seq.empty, testOnlyNoJavaConversions: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- 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
andno_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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllAuxEnumOptions(__vs: Iterable[AuxEnumOptions]): ScalaPbOptions
- def addAllAuxFieldOptions(__vs: Iterable[AuxFieldOptions]): ScalaPbOptions
- def addAllAuxMessageOptions(__vs: Iterable[AuxMessageOptions]): ScalaPbOptions
- def addAllImport(__vs: Iterable[String]): ScalaPbOptions
- def addAllPreamble(__vs: Iterable[String]): ScalaPbOptions
- def addAllPreprocessors(__vs: Iterable[String]): ScalaPbOptions
- def addAuxEnumOptions(__vs: AuxEnumOptions*): ScalaPbOptions
- def addAuxFieldOptions(__vs: AuxFieldOptions*): ScalaPbOptions
- def addAuxMessageOptions(__vs: AuxMessageOptions*): ScalaPbOptions
- def addImport(__vs: String*): ScalaPbOptions
- def addPreamble(__vs: String*): ScalaPbOptions
- def addPreprocessors(__vs: String*): ScalaPbOptions
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val auxEnumOptions: Seq[AuxEnumOptions]
- val auxFieldOptions: Seq[AuxFieldOptions]
- val auxMessageOptions: Seq[AuxMessageOptions]
- val bytesType: Option[String]
- def clearAuxEnumOptions: ScalaPbOptions
- def clearAuxFieldOptions: ScalaPbOptions
- def clearAuxMessageOptions: ScalaPbOptions
- def clearBytesType: ScalaPbOptions
- def clearCollectionType: ScalaPbOptions
- def clearEnumStripPrefix: ScalaPbOptions
- def clearEnumValueNaming: ScalaPbOptions
- def clearFlatPackage: ScalaPbOptions
- def clearImport: ScalaPbOptions
- def clearLenses: ScalaPbOptions
- def clearMapType: ScalaPbOptions
- def clearNoDefaultValuesInConstructor: ScalaPbOptions
- def clearNoPrimitiveWrappers: ScalaPbOptions
- def clearObjectName: ScalaPbOptions
- def clearPackageName: ScalaPbOptions
- def clearPreamble: ScalaPbOptions
- def clearPreprocessors: ScalaPbOptions
- def clearPreserveUnknownFields: ScalaPbOptions
- def clearPrimitiveWrappers: ScalaPbOptions
- def clearRetainSourceCodeInfo: ScalaPbOptions
- def clearScope: ScalaPbOptions
- def clearSingleFile: ScalaPbOptions
- def clearTestOnlyNoJavaConversions: ScalaPbOptions
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val collectionType: Option[String]
- def companion: ScalaPbOptions
- Definition Classes
- ScalaPbOptions → GeneratedMessage
- def discardUnknownFields: ScalaPbOptions
- val enumStripPrefix: Option[Boolean]
- val enumValueNaming: Option[EnumValueNaming]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def extension[T](generatedExtension: GeneratedExtension[ScalaPbOptions, T]): T
- Definition Classes
- ExtendableMessage
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- val flatPackage: Option[Boolean]
- def getBytesType: String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getCollectionType: String
- def getEnumStripPrefix: Boolean
- def getEnumValueNaming: EnumValueNaming
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- ScalaPbOptions → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- ScalaPbOptions → GeneratedMessage
- def getFlatPackage: Boolean
- def getLenses: Boolean
- def getMapType: String
- def getNoDefaultValuesInConstructor: Boolean
- def getNoPrimitiveWrappers: Boolean
- def getObjectName: String
- def getPackageName: String
- def getPreserveUnknownFields: Boolean
- def getPrimitiveWrappers: Boolean
- def getRetainSourceCodeInfo: Boolean
- def getScope: OptionsScope
- def getSingleFile: Boolean
- def getTestOnlyNoJavaConversions: Boolean
- val import: Seq[String]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val lenses: Option[Boolean]
- val mapType: Option[String]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noDefaultValuesInConstructor: Option[Boolean]
- val noPrimitiveWrappers: Option[Boolean]
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val objectName: Option[String]
- val packageName: Option[String]
- val preamble: Seq[String]
- val preprocessors: Seq[String]
- val preserveUnknownFields: Option[Boolean]
- val primitiveWrappers: Option[Boolean]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val retainSourceCodeInfo: Option[Boolean]
- val scope: Option[OptionsScope]
- def serializedSize: Int
- Definition Classes
- ScalaPbOptions → GeneratedMessage
- val singleFile: Option[Boolean]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val testOnlyNoJavaConversions: Option[Boolean]
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- 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
- val unknownFields: UnknownFieldSet
- Definition Classes
- ScalaPbOptions → ExtendableMessage
- def update(ms: (Lens[ScalaPbOptions, ScalaPbOptions]) => Mutation[ScalaPbOptions]*): ScalaPbOptions
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAuxEnumOptions(__v: Seq[AuxEnumOptions]): ScalaPbOptions
- def withAuxFieldOptions(__v: Seq[AuxFieldOptions]): ScalaPbOptions
- def withAuxMessageOptions(__v: Seq[AuxMessageOptions]): ScalaPbOptions
- def withBytesType(__v: String): ScalaPbOptions
- def withCollectionType(__v: String): ScalaPbOptions
- def withEnumStripPrefix(__v: Boolean): ScalaPbOptions
- def withEnumValueNaming(__v: EnumValueNaming): ScalaPbOptions
- def withExtension[T](generatedExtension: GeneratedExtension[ScalaPbOptions, T])(value: T): ScalaPbOptions
- Definition Classes
- ExtendableMessage
- def withFlatPackage(__v: Boolean): ScalaPbOptions
- def withImport(__v: Seq[String]): ScalaPbOptions
- def withLenses(__v: Boolean): ScalaPbOptions
- def withMapType(__v: String): ScalaPbOptions
- def withNoDefaultValuesInConstructor(__v: Boolean): ScalaPbOptions
- def withNoPrimitiveWrappers(__v: Boolean): ScalaPbOptions
- def withObjectName(__v: String): ScalaPbOptions
- def withPackageName(__v: String): ScalaPbOptions
- def withPreamble(__v: Seq[String]): ScalaPbOptions
- def withPreprocessors(__v: Seq[String]): ScalaPbOptions
- def withPreserveUnknownFields(__v: Boolean): ScalaPbOptions
- def withPrimitiveWrappers(__v: Boolean): ScalaPbOptions
- def withRetainSourceCodeInfo(__v: Boolean): ScalaPbOptions
- def withScope(__v: OptionsScope): ScalaPbOptions
- def withSingleFile(__v: Boolean): ScalaPbOptions
- def withTestOnlyNoJavaConversions(__v: Boolean): ScalaPbOptions
- def withUnknownFields(__v: UnknownFieldSet): ScalaPbOptions
- Definition Classes
- ScalaPbOptions → ExtendableMessage
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- ScalaPbOptions → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage