scalapb.options

ScalaPbOptions

final case class ScalaPbOptions(packageName: Option[String] = scala.None, flatPackage: Option[Boolean] = scala.None, import: Seq[String] = scala.collection.Seq.empty[Nothing], preamble: Seq[String] = scala.collection.Seq.empty[Nothing], singleFile: Option[Boolean] = scala.None, noPrimitiveWrappers: Option[Boolean] = scala.None, primitiveWrappers: Option[Boolean] = scala.None, collectionType: Option[String] = scala.None, preserveUnknownFields: Option[Boolean] = scala.None, objectName: Option[String] = scala.None, scope: Option[OptionsScope] = scala.None, lenses: Option[Boolean] = scala.None, retainSourceCodeInfo: Option[Boolean] = scala.None, testOnlyNoJavaConversions: Option[Boolean] = scala.None) extends GeneratedMessage with Message[ScalaPbOptions] 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 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.

testOnlyNoJavaConversions

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

Annotations
@SerialVersionUID( 0L )
Linear Supertypes
Product, Equals, Updatable[ScalaPbOptions], Message[ScalaPbOptions], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ScalaPbOptions
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaPbOptions(packageName: Option[String] = scala.None, flatPackage: Option[Boolean] = scala.None, import: Seq[String] = scala.collection.Seq.empty[Nothing], preamble: Seq[String] = scala.collection.Seq.empty[Nothing], singleFile: Option[Boolean] = scala.None, noPrimitiveWrappers: Option[Boolean] = scala.None, primitiveWrappers: Option[Boolean] = scala.None, collectionType: Option[String] = scala.None, preserveUnknownFields: Option[Boolean] = scala.None, objectName: Option[String] = scala.None, scope: Option[OptionsScope] = scala.None, lenses: Option[Boolean] = scala.None, retainSourceCodeInfo: Option[Boolean] = scala.None, testOnlyNoJavaConversions: Option[Boolean] = 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.

    testOnlyNoJavaConversions

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

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

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

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

  8. def addImport(__vs: String*): ScalaPbOptions

  9. def addPreamble(__vs: String*): ScalaPbOptions

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def clearCollectionType: ScalaPbOptions

  12. def clearFlatPackage: ScalaPbOptions

  13. def clearImport: ScalaPbOptions

  14. def clearLenses: ScalaPbOptions

  15. def clearNoPrimitiveWrappers: ScalaPbOptions

  16. def clearObjectName: ScalaPbOptions

  17. def clearPackageName: ScalaPbOptions

  18. def clearPreamble: ScalaPbOptions

  19. def clearPreserveUnknownFields: ScalaPbOptions

  20. def clearPrimitiveWrappers: ScalaPbOptions

  21. def clearRetainSourceCodeInfo: ScalaPbOptions

  22. def clearScope: ScalaPbOptions

  23. def clearSingleFile: ScalaPbOptions

  24. def clearTestOnlyNoJavaConversions: ScalaPbOptions

  25. def clone(): AnyRef

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

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

  27. def companion: ScalaPbOptions.type

    Definition Classes
    ScalaPbOptions → GeneratedMessage

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

    Definition Classes
    AnyRef

  29. def finalize(): Unit

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

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

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

    Definition Classes
    AnyRef → Any

  32. def getCollectionType: String

  33. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    ScalaPbOptions → GeneratedMessage

  34. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    ScalaPbOptions → GeneratedMessage

  35. def getFlatPackage: Boolean

  36. def getLenses: Boolean

  37. def getNoPrimitiveWrappers: Boolean

  38. def getObjectName: String

  39. def getPackageName: String

  40. def getPreserveUnknownFields: Boolean

  41. def getPrimitiveWrappers: Boolean

  42. def getRetainSourceCodeInfo: Boolean

  43. def getScope: OptionsScope

  44. def getSingleFile: Boolean

  45. def getTestOnlyNoJavaConversions: Boolean

  46. val import: Seq[String]

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

  47. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  48. val lenses: Option[Boolean]

    If true, lenses will not be generated.

  49. def mergeFrom(_input__: CodedInputStream): ScalaPbOptions

    Definition Classes
    ScalaPbOptions → Message

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

    Definition Classes
    AnyRef

  51. val noPrimitiveWrappers: Option[Boolean]

    By default, wrappers defined at https://github.

    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.

  52. final def notify(): Unit

    Definition Classes
    AnyRef

  53. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

  55. val packageName: Option[String]

    If set then it overrides the java_package and package.

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

  57. val preserveUnknownFields: Option[Boolean]

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

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

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

  60. val scope: Option[OptionsScope]

    Experimental: scope to apply the given options.

  61. final def serializedSize: Int

    Definition Classes
    ScalaPbOptions → GeneratedMessage

  62. val singleFile: Option[Boolean]

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

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

    Definition Classes
    AnyRef

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

  65. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage

  66. def toByteString: ByteString

    Definition Classes
    GeneratedMessage

  67. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage

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

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

    Definition Classes
    Updatable

  70. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  73. def withCollectionType(__v: String): ScalaPbOptions

  74. def withFlatPackage(__v: Boolean): ScalaPbOptions

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

  76. def withLenses(__v: Boolean): ScalaPbOptions

  77. def withNoPrimitiveWrappers(__v: Boolean): ScalaPbOptions

  78. def withObjectName(__v: String): ScalaPbOptions

  79. def withPackageName(__v: String): ScalaPbOptions

  80. def withPreamble(__v: Seq[String]): ScalaPbOptions

  81. def withPreserveUnknownFields(__v: Boolean): ScalaPbOptions

  82. def withPrimitiveWrappers(__v: Boolean): ScalaPbOptions

  83. def withRetainSourceCodeInfo(__v: Boolean): ScalaPbOptions

  84. def withScope(__v: OptionsScope): ScalaPbOptions

  85. def withSingleFile(__v: Boolean): ScalaPbOptions

  86. def withTestOnlyNoJavaConversions(__v: Boolean): ScalaPbOptions

  87. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

  88. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    ScalaPbOptions → GeneratedMessage

  89. def writeTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

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

Inherited from Product

Inherited from Equals

Inherited from Updatable[ScalaPbOptions]

Inherited from Message[ScalaPbOptions]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped