ScalaPbOptions

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 not 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.
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], Message[ScalaPbOptions], GeneratedMessage, Serializable, Serializable, AnyRef, Any

Instance Constructors

new ScalaPbOptions(packageName: Option[String] = _root_.scala.None, flatPackage: Option[Boolean] = _root_.scala.None, import: Seq[String] = _root_.scala.collection.Seq.empty, preamble: Seq[String] = _root_.scala.collection.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, testOnlyNoJavaConversions: Option[Boolean] = _root_.scala.None)

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 not 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.
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 addAllImport(__vs: TraversableOnce[String]): ScalaPbOptions
def addAllPreamble(__vs: TraversableOnce[String]): ScalaPbOptions
def addImport(__vs: String*): ScalaPbOptions
def addPreamble(__vs: String*): ScalaPbOptions
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearCollectionType: ScalaPbOptions
def clearFlatPackage: ScalaPbOptions
def clearImport: ScalaPbOptions
def clearLenses: ScalaPbOptions
def clearMapType: ScalaPbOptions
def clearNoPrimitiveWrappers: ScalaPbOptions
def clearObjectName: ScalaPbOptions
def clearPackageName: ScalaPbOptions
def clearPreamble: ScalaPbOptions
def clearPreserveUnknownFields: ScalaPbOptions
def clearPrimitiveWrappers: ScalaPbOptions
def clearRetainSourceCodeInfo: ScalaPbOptions
def clearScope: ScalaPbOptions
def clearSingleFile: ScalaPbOptions
def clearTestOnlyNoJavaConversions: ScalaPbOptions
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val collectionType: Option[String]

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

Definition Classes
ScalaPbOptions → GeneratedMessage
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val flatPackage: Option[Boolean]

If true, the compiler does not append the proto base file name into the generated package name.
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.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getCollectionType: String
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 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]

Adds the following imports at the top of the file (this is meant to provide implicit TypeMappers)
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val lenses: Option[Boolean]

If true, lenses will not be generated.
val mapType: Option[String]

Scala type to be used for maps.
Scala type to be used for maps. If unspecified, scala.collection.immutable.Map will be used.
def mergeFrom(_input__: CodedInputStream): ScalaPbOptions

Definition Classes
ScalaPbOptions → Message
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val noPrimitiveWrappers: Option[Boolean]

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.
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.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val objectName: Option[String]

If defined, sets the name of the file-level object that would be generated.
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.
val packageName: Option[String]

If set then it overrides the java_package and package.
val preamble: Seq[String]

Text to add to the generated scala file.
Text to add to the generated scala file. This can be used only when single_file is true.
val preserveUnknownFields: Option[Boolean]

If set to true, all generated messages in this file will preserve unknown fields.
val primitiveWrappers: Option[Boolean]

DEPRECATED.
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.
val retainSourceCodeInfo: Option[Boolean]

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.
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.
val scope: Option[OptionsScope]

Experimental: scope to apply the given options.
final def serializedSize: Int

Definition Classes
ScalaPbOptions → GeneratedMessage
val singleFile: Option[Boolean]

If true, all messages and enums (but not services) will be written to a single Scala file.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val testOnlyNoJavaConversions: Option[Boolean]

For use in tests only.
For use in tests only. Inhibit Java conversions even when when generator parameters request for it.
def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
def toByteString: ByteString

Definition Classes
GeneratedMessage
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
def update(ms: (Lens[ScalaPbOptions, ScalaPbOptions]) ⇒ Mutation[ScalaPbOptions]*): ScalaPbOptions

Definition Classes
Updatable
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withCollectionType(__v: String): ScalaPbOptions
def withFlatPackage(__v: Boolean): ScalaPbOptions
def withImport(__v: Seq[String]): ScalaPbOptions
def withLenses(__v: Boolean): ScalaPbOptions
def withMapType(__v: String): ScalaPbOptions
def withNoPrimitiveWrappers(__v: Boolean): ScalaPbOptions
def withObjectName(__v: String): ScalaPbOptions
def withPackageName(__v: String): ScalaPbOptions
def withPreamble(__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 writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

Definition Classes
ScalaPbOptions → GeneratedMessage
def writeTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use toPMessage
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

Related Docs: object ScalaPbOptions | package options

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAllImport(__vs: TraversableOnce[String]): ScalaPbOptions

def addAllPreamble(__vs: TraversableOnce[String]): ScalaPbOptions

def addImport(__vs: String*): ScalaPbOptions

def addPreamble(__vs: String*): ScalaPbOptions

final def asInstanceOf[T0]: T0

def clearCollectionType: ScalaPbOptions

def clearFlatPackage: ScalaPbOptions

def clearImport: ScalaPbOptions

def clearLenses: ScalaPbOptions

def clearMapType: ScalaPbOptions

def clearNoPrimitiveWrappers: ScalaPbOptions

def clearObjectName: ScalaPbOptions

def clearPackageName: ScalaPbOptions

def clearPreamble: ScalaPbOptions

def clearPreserveUnknownFields: ScalaPbOptions

def clearPrimitiveWrappers: ScalaPbOptions

def clearRetainSourceCodeInfo: ScalaPbOptions

def clearScope: ScalaPbOptions

def clearSingleFile: ScalaPbOptions

def clearTestOnlyNoJavaConversions: ScalaPbOptions

def clone(): AnyRef

val collectionType: Option[String]

def companion: ScalaPbOptions.type

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val flatPackage: Option[Boolean]

final def getClass(): Class[_]

def getCollectionType: String

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

def getFlatPackage: Boolean

def getLenses: Boolean

def getMapType: String

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

val lenses: Option[Boolean]

val mapType: Option[String]

def mergeFrom(_input__: CodedInputStream): ScalaPbOptions

final def ne(arg0: AnyRef): Boolean

val noPrimitiveWrappers: Option[Boolean]

final def notify(): Unit

final def notifyAll(): Unit

val objectName: Option[String]

val packageName: Option[String]

val preamble: Seq[String]

val preserveUnknownFields: Option[Boolean]

val primitiveWrappers: Option[Boolean]

val retainSourceCodeInfo: Option[Boolean]

val scope: Option[OptionsScope]

final def serializedSize: Int

val singleFile: Option[Boolean]

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

val testOnlyNoJavaConversions: Option[Boolean]

def toByteArray: Array[Byte]

def toByteString: ByteString

def toPMessage: PMessage

def toProtoString: String

def update(ms: (Lens[ScalaPbOptions, ScalaPbOptions]) ⇒ Mutation[ScalaPbOptions]*): ScalaPbOptions

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withCollectionType(__v: String): ScalaPbOptions

def withFlatPackage(__v: Boolean): ScalaPbOptions

def withImport(__v: Seq[String]): ScalaPbOptions