Packages

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

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)

    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.

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