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

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

    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 clearNoPrimitiveWrappers: ScalaPbOptions

  15. def clearObjectName: ScalaPbOptions

  16. def clearPackageName: ScalaPbOptions

  17. def clearPreamble: ScalaPbOptions

  18. def clearPreserveUnknownFields: ScalaPbOptions

  19. def clearPrimitiveWrappers: ScalaPbOptions

  20. def clearSingleFile: ScalaPbOptions

  21. def clearTestOnlyNoJavaConversions: ScalaPbOptions

  22. def clone(): AnyRef

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

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

  24. def companion: ScalaPbOptions.type

    Definition Classes
    ScalaPbOptions → GeneratedMessage

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

    Definition Classes
    AnyRef

  26. def finalize(): Unit

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

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

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

    Definition Classes
    AnyRef → Any

  29. def getCollectionType: String

  30. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    ScalaPbOptions → GeneratedMessage

  31. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    ScalaPbOptions → GeneratedMessage

  32. def getFlatPackage: Boolean

  33. def getNoPrimitiveWrappers: Boolean

  34. def getObjectName: String

  35. def getPackageName: String

  36. def getPreserveUnknownFields: Boolean

  37. def getPrimitiveWrappers: Boolean

  38. def getSingleFile: Boolean

  39. def getTestOnlyNoJavaConversions: Boolean

  40. val import: Seq[String]

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

  41. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  42. def mergeFrom(_input__: CodedInputStream): ScalaPbOptions

    Definition Classes
    ScalaPbOptions → Message

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

    Definition Classes
    AnyRef

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

  45. final def notify(): Unit

    Definition Classes
    AnyRef

  46. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

  48. val packageName: Option[String]

    If set then it overrides the java_package and package.

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

  50. val preserveUnknownFields: Option[Boolean]

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

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

  52. final def serializedSize: Int

    Definition Classes
    ScalaPbOptions → GeneratedMessage

  53. val singleFile: Option[Boolean]

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

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

    Definition Classes
    AnyRef

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

  56. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage

  57. def toByteString: ByteString

    Definition Classes
    GeneratedMessage

  58. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage

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

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

    Definition Classes
    Updatable

  61. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  64. def withCollectionType(__v: String): ScalaPbOptions

  65. def withFlatPackage(__v: Boolean): ScalaPbOptions

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

  67. def withNoPrimitiveWrappers(__v: Boolean): ScalaPbOptions

  68. def withObjectName(__v: String): ScalaPbOptions

  69. def withPackageName(__v: String): ScalaPbOptions

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

  71. def withPreserveUnknownFields(__v: Boolean): ScalaPbOptions

  72. def withPrimitiveWrappers(__v: Boolean): ScalaPbOptions

  73. def withSingleFile(__v: Boolean): ScalaPbOptions

  74. def withTestOnlyNoJavaConversions(__v: Boolean): ScalaPbOptions

  75. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

  76. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    ScalaPbOptions → GeneratedMessage

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