final case class FileOptions(javaPackage: scala.Option[String] = None, javaOuterClassname: scala.Option[String] = None, javaMultipleFiles: scala.Option[Boolean] = None, javaGenerateEqualsAndHash: scala.Option[Boolean] = None, javaStringCheckUtf8: scala.Option[Boolean] = None, optimizeFor: scala.Option[OptimizeMode] = None, goPackage: scala.Option[String] = None, ccGenericServices: scala.Option[Boolean] = None, javaGenericServices: scala.Option[Boolean] = None, pyGenericServices: scala.Option[Boolean] = None, deprecated: scala.Option[Boolean] = None, ccEnableArenas: scala.Option[Boolean] = None, objcClassPrefix: scala.Option[String] = None, csharpNamespace: scala.Option[String] = None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.collection.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet()) extends trueaccord.scalapb.GeneratedMessage with trueaccord.scalapb.Message[FileOptions] with Updatable[FileOptions] with ExtendableMessage[FileOptions] with Product with Serializable

javaPackage

Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names.

javaOuterClassname

If set, all the classes from the .proto file are wrapped in a single outer class with the given name. This applies to both Proto1 (equivalent to the old "--one_java_file" option) and Proto2 (where a .proto always translates to a single class, but you may want to explicitly choose the class name).

javaMultipleFiles

If set true, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will *not* be nested inside the outer class named by java_outer_classname. However, the outer class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

javaGenerateEqualsAndHash

If set true, then the Java code generator will generate equals() and hashCode() methods for all messages defined in the .proto file. This increases generated code size, potentially substantially for large protos, which may harm a memory-constrained application.

  • In the full runtime this is a speed optimization, as the AbstractMessage base class includes reflection-based implementations of these methods.
  • In the lite runtime, setting this option changes the semantics of equals() and hashCode() to more closely match those of the full runtime; the generated methods compute their results based on field values rather than object identity. (Implementations should not assume that hashcodes will be consistent across runtimes or versions of the protocol compiler.)
javaStringCheckUtf8

If set true, then the Java2 code generator will generate code that throws an exception whenever an attempt is made to assign a non-UTF-8 byte sequence to a string field. Message reflection will do the same. However, an extension field still accepts non-UTF-8 byte sequences. This option has no effect on when used with the lite runtime.

goPackage

Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:

  • The basename of the package import path, if provided.
  • Otherwise, the package statement in the .proto file, if present.
  • Otherwise, the basename of the .proto file, without extension.
ccGenericServices

Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins). Generic services were the only kind of service generation supported by early versions of google.protobuf. Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true.

deprecated

Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files.

ccEnableArenas

Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

objcClassPrefix

Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

csharpNamespace

Namespace for generated classes; defaults to the package.

uninterpretedOption

The parser stores options it doesn't recognize here. See above.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, ExtendableMessage[FileOptions], Updatable[FileOptions], trueaccord.scalapb.Message[FileOptions], trueaccord.scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileOptions
  2. Product
  3. Equals
  4. ExtendableMessage
  5. Updatable
  6. Message
  7. GeneratedMessage
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileOptions(javaPackage: scala.Option[String] = None, javaOuterClassname: scala.Option[String] = None, javaMultipleFiles: scala.Option[Boolean] = None, javaGenerateEqualsAndHash: scala.Option[Boolean] = None, javaStringCheckUtf8: scala.Option[Boolean] = None, optimizeFor: scala.Option[OptimizeMode] = None, goPackage: scala.Option[String] = None, ccGenericServices: scala.Option[Boolean] = None, javaGenericServices: scala.Option[Boolean] = None, pyGenericServices: scala.Option[Boolean] = None, deprecated: scala.Option[Boolean] = None, ccEnableArenas: scala.Option[Boolean] = None, objcClassPrefix: scala.Option[String] = None, csharpNamespace: scala.Option[String] = None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.collection.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet())

    javaPackage

    Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names.

    javaOuterClassname

    If set, all the classes from the .proto file are wrapped in a single outer class with the given name. This applies to both Proto1 (equivalent to the old "--one_java_file" option) and Proto2 (where a .proto always translates to a single class, but you may want to explicitly choose the class name).

    javaMultipleFiles

    If set true, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will *not* be nested inside the outer class named by java_outer_classname. However, the outer class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

    javaGenerateEqualsAndHash

    If set true, then the Java code generator will generate equals() and hashCode() methods for all messages defined in the .proto file. This increases generated code size, potentially substantially for large protos, which may harm a memory-constrained application.

    • In the full runtime this is a speed optimization, as the AbstractMessage base class includes reflection-based implementations of these methods.
    • In the lite runtime, setting this option changes the semantics of equals() and hashCode() to more closely match those of the full runtime; the generated methods compute their results based on field values rather than object identity. (Implementations should not assume that hashcodes will be consistent across runtimes or versions of the protocol compiler.)
    javaStringCheckUtf8

    If set true, then the Java2 code generator will generate code that throws an exception whenever an attempt is made to assign a non-UTF-8 byte sequence to a string field. Message reflection will do the same. However, an extension field still accepts non-UTF-8 byte sequences. This option has no effect on when used with the lite runtime.

    goPackage

    Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:

    • The basename of the package import path, if provided.
    • Otherwise, the package statement in the .proto file, if present.
    • Otherwise, the basename of the .proto file, without extension.
    ccGenericServices

    Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins). Generic services were the only kind of service generation supported by early versions of google.protobuf. Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true.

    deprecated

    Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files.

    ccEnableArenas

    Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

    objcClassPrefix

    Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

    csharpNamespace

    Namespace for generated classes; defaults to the package.

    uninterpretedOption

    The parser stores options it doesn't recognize here. See above.

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllUninterpretedOption(__vs: TraversableOnce[UninterpretedOption]): FileOptions
  5. def addUninterpretedOption(__vs: UninterpretedOption*): FileOptions
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val ccEnableArenas: scala.Option[Boolean]
  8. val ccGenericServices: scala.Option[Boolean]
  9. def clearCcEnableArenas: FileOptions
  10. def clearCcGenericServices: FileOptions
  11. def clearCsharpNamespace: FileOptions
  12. def clearDeprecated: FileOptions
  13. def clearGoPackage: FileOptions
  14. def clearJavaGenerateEqualsAndHash: FileOptions
  15. def clearJavaGenericServices: FileOptions
  16. def clearJavaMultipleFiles: FileOptions
  17. def clearJavaOuterClassname: FileOptions
  18. def clearJavaPackage: FileOptions
  19. def clearJavaStringCheckUtf8: FileOptions
  20. def clearObjcClassPrefix: FileOptions
  21. def clearOptimizeFor: FileOptions
  22. def clearPyGenericServices: FileOptions
  23. def clearUninterpretedOption: FileOptions
  24. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def companion: FileOptions.type
    Definition Classes
    FileOptionsGeneratedMessage
  26. val csharpNamespace: scala.Option[String]
  27. val deprecated: scala.Option[Boolean]
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def extension[T](generatedExtension: GeneratedExtension[FileOptions, T]): T
    Definition Classes
    ExtendableMessage
  30. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. def getCcEnableArenas: Boolean
  32. def getCcGenericServices: Boolean
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  34. def getCsharpNamespace: String
  35. def getDeprecated: Boolean
  36. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    FileOptionsGeneratedMessage
  37. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    FileOptionsGeneratedMessage
  38. def getGoPackage: String
  39. def getJavaGenerateEqualsAndHash: Boolean
  40. def getJavaGenericServices: Boolean
  41. def getJavaMultipleFiles: Boolean
  42. def getJavaOuterClassname: String
  43. def getJavaPackage: String
  44. def getJavaStringCheckUtf8: Boolean
  45. def getObjcClassPrefix: String
  46. def getOptimizeFor: OptimizeMode
  47. def getPyGenericServices: Boolean
  48. val goPackage: scala.Option[String]
  49. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  50. val javaGenerateEqualsAndHash: scala.Option[Boolean]
  51. val javaGenericServices: scala.Option[Boolean]
  52. val javaMultipleFiles: scala.Option[Boolean]
  53. val javaOuterClassname: scala.Option[String]
  54. val javaPackage: scala.Option[String]
  55. val javaStringCheckUtf8: scala.Option[Boolean]
  56. def mergeFrom(_input__: CodedInputStream): FileOptions
    Definition Classes
    FileOptionsMessage
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. final def notify(): Unit
    Definition Classes
    AnyRef
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  60. val objcClassPrefix: scala.Option[String]
  61. val optimizeFor: scala.Option[OptimizeMode]
  62. val pyGenericServices: scala.Option[Boolean]
  63. final def serializedSize: Int
    Definition Classes
    FileOptionsGeneratedMessage
  64. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  65. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  66. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  67. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  68. def toString(): String
    Definition Classes
    FileOptions → AnyRef → Any
  69. val uninterpretedOption: Seq[UninterpretedOption]
  70. val unknownFields: scalapb.UnknownFieldSet
    Definition Classes
    FileOptionsExtendableMessage
  71. def update(ms: (Lens[FileOptions, FileOptions]) ⇒ Mutation[FileOptions]*): FileOptions
    Definition Classes
    Updatable
  72. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. def withCcEnableArenas(__v: Boolean): FileOptions
  76. def withCcGenericServices(__v: Boolean): FileOptions
  77. def withCsharpNamespace(__v: String): FileOptions
  78. def withDeprecated(__v: Boolean): FileOptions
  79. def withGoPackage(__v: String): FileOptions
  80. def withJavaGenerateEqualsAndHash(__v: Boolean): FileOptions
  81. def withJavaGenericServices(__v: Boolean): FileOptions
  82. def withJavaMultipleFiles(__v: Boolean): FileOptions
  83. def withJavaOuterClassname(__v: String): FileOptions
  84. def withJavaPackage(__v: String): FileOptions
  85. def withJavaStringCheckUtf8(__v: Boolean): FileOptions
  86. def withObjcClassPrefix(__v: String): FileOptions
  87. def withOptimizeFor(__v: OptimizeMode): FileOptions
  88. def withPyGenericServices(__v: Boolean): FileOptions
  89. def withUninterpretedOption(__v: Seq[UninterpretedOption]): FileOptions
  90. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  91. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    FileOptionsGeneratedMessage
  92. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, scala.Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): scala.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 ExtendableMessage[FileOptions]

Inherited from Updatable[FileOptions]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from scala.Any

Ungrouped