final case class ScalaPbOptions(packageName: Option[String] = None, flatPackage: Option[Boolean] = None, import: Seq[String] = _root_.scala.collection.Seq.empty, preamble: Seq[String] = _root_.scala.collection.Seq.empty, singleFile: Option[Boolean] = None, noPrimitiveWrappers: Option[Boolean] = None, primitiveWrappers: Option[Boolean] = None, collectionType: Option[String] = None, preserveUnknownFields: Option[Boolean] = None, testOnlyNoJavaConversions: Option[Boolean] = 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.

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
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
Visibility
  1. Public
  2. All

Instance Constructors

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

    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 addAllImport(__vs: TraversableOnce[String]): ScalaPbOptions
  5. def addAllPreamble(__vs: TraversableOnce[String]): ScalaPbOptions
  6. def addImport(__vs: String*): ScalaPbOptions
  7. def addPreamble(__vs: String*): ScalaPbOptions
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearCollectionType: ScalaPbOptions
  10. def clearFlatPackage: ScalaPbOptions
  11. def clearImport: ScalaPbOptions
  12. def clearNoPrimitiveWrappers: ScalaPbOptions
  13. def clearPackageName: ScalaPbOptions
  14. def clearPreamble: ScalaPbOptions
  15. def clearPreserveUnknownFields: ScalaPbOptions
  16. def clearPrimitiveWrappers: ScalaPbOptions
  17. def clearSingleFile: ScalaPbOptions
  18. def clearTestOnlyNoJavaConversions: ScalaPbOptions
  19. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. val collectionType: Option[String]
  21. def companion: ScalaPbOptions.type
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. val flatPackage: Option[Boolean]
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  26. def getCollectionType: String
  27. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  28. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  29. def getFlatPackage: Boolean
  30. def getNoPrimitiveWrappers: Boolean
  31. def getPackageName: String
  32. def getPreserveUnknownFields: Boolean
  33. def getPrimitiveWrappers: Boolean
  34. def getSingleFile: Boolean
  35. def getTestOnlyNoJavaConversions: Boolean
  36. val import: Seq[String]
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. def mergeFrom(_input__: CodedInputStream): ScalaPbOptions
    Definition Classes
    ScalaPbOptions → Message
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. val noPrimitiveWrappers: Option[Boolean]
  41. final def notify(): Unit
    Definition Classes
    AnyRef
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  43. val packageName: Option[String]
  44. val preamble: Seq[String]
  45. val preserveUnknownFields: Option[Boolean]
  46. val primitiveWrappers: Option[Boolean]
  47. final def serializedSize: Int
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  48. val singleFile: Option[Boolean]
  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. val testOnlyNoJavaConversions: Option[Boolean]
  51. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  52. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  53. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  54. def toString(): String
    Definition Classes
    ScalaPbOptions → AnyRef → Any
  55. def update(ms: (Lens[ScalaPbOptions, ScalaPbOptions]) ⇒ Mutation[ScalaPbOptions]*): ScalaPbOptions
    Definition Classes
    Updatable
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. def withCollectionType(__v: String): ScalaPbOptions
  60. def withFlatPackage(__v: Boolean): ScalaPbOptions
  61. def withImport(__v: Seq[String]): ScalaPbOptions
  62. def withNoPrimitiveWrappers(__v: Boolean): ScalaPbOptions
  63. def withPackageName(__v: String): ScalaPbOptions
  64. def withPreamble(__v: Seq[String]): ScalaPbOptions
  65. def withPreserveUnknownFields(__v: Boolean): ScalaPbOptions
  66. def withPrimitiveWrappers(__v: Boolean): ScalaPbOptions
  67. def withSingleFile(__v: Boolean): ScalaPbOptions
  68. def withTestOnlyNoJavaConversions(__v: Boolean): ScalaPbOptions
  69. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  70. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  71. 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