Packages

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, testOnlyNoJavaConversions: Option[Boolean] = _root_.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.

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
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] = _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, 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

  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: Iterable[String]): ScalaPbOptions
  5. def addAllPreamble(__vs: Iterable[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 clearLenses: ScalaPbOptions
  13. def clearMapType: 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 clearRetainSourceCodeInfo: ScalaPbOptions
  21. def clearScope: ScalaPbOptions
  22. def clearSingleFile: ScalaPbOptions
  23. def clearTestOnlyNoJavaConversions: ScalaPbOptions
  24. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws(classOf[java.lang.CloneNotSupportedException])
  25. val collectionType: Option[String]
  26. def companion: ScalaPbOptions
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  29. val flatPackage: Option[Boolean]
  30. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def getCollectionType: String
  32. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  33. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  34. def getFlatPackage: Boolean
  35. def getLenses: Boolean
  36. def getMapType: String
  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]
  47. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  48. val lenses: Option[Boolean]
  49. val mapType: Option[String]
  50. def mergeFrom(_input__: CodedInputStream): ScalaPbOptions
    Definition Classes
    ScalaPbOptions → Message
  51. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. val noPrimitiveWrappers: Option[Boolean]
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  55. val objectName: Option[String]
  56. val packageName: Option[String]
  57. val preamble: Seq[String]
  58. val preserveUnknownFields: Option[Boolean]
  59. val primitiveWrappers: Option[Boolean]
  60. def productElementNames: Iterator[String]
    Definition Classes
    Product
  61. val retainSourceCodeInfo: Option[Boolean]
  62. val scope: Option[OptionsScope]
  63. final def serializedSize: Int
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  64. val singleFile: Option[Boolean]
  65. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  66. val testOnlyNoJavaConversions: Option[Boolean]
  67. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  68. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  69. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  70. 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
  71. def update(ms: (Lens[ScalaPbOptions, ScalaPbOptions]) ⇒ Mutation[ScalaPbOptions]*): ScalaPbOptions
    Definition Classes
    Updatable
  72. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws(classOf[java.lang.InterruptedException])
  75. def withCollectionType(__v: String): ScalaPbOptions
  76. def withFlatPackage(__v: Boolean): ScalaPbOptions
  77. def withImport(__v: Seq[String]): ScalaPbOptions
  78. def withLenses(__v: Boolean): ScalaPbOptions
  79. def withMapType(__v: String): ScalaPbOptions
  80. def withNoPrimitiveWrappers(__v: Boolean): ScalaPbOptions
  81. def withObjectName(__v: String): ScalaPbOptions
  82. def withPackageName(__v: String): ScalaPbOptions
  83. def withPreamble(__v: Seq[String]): ScalaPbOptions
  84. def withPreserveUnknownFields(__v: Boolean): ScalaPbOptions
  85. def withPrimitiveWrappers(__v: Boolean): ScalaPbOptions
  86. def withRetainSourceCodeInfo(__v: Boolean): ScalaPbOptions
  87. def withScope(__v: OptionsScope): ScalaPbOptions
  88. def withSingleFile(__v: Boolean): ScalaPbOptions
  89. def withTestOnlyNoJavaConversions(__v: Boolean): ScalaPbOptions
  90. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  91. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ScalaPbOptions → GeneratedMessage
  92. 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