com.google.protobuf.descriptor

FileOptions

final case class FileOptions(javaPackage: scala.Option[String] = scala.None, javaOuterClassname: scala.Option[String] = scala.None, javaMultipleFiles: scala.Option[Boolean] = scala.None, javaGenerateEqualsAndHash: scala.Option[Boolean] = scala.None, javaStringCheckUtf8: scala.Option[Boolean] = scala.None, optimizeFor: scala.Option[OptimizeMode] = scala.None, goPackage: scala.Option[String] = scala.None, ccGenericServices: scala.Option[Boolean] = scala.None, javaGenericServices: scala.Option[Boolean] = scala.None, pyGenericServices: scala.Option[Boolean] = scala.None, deprecated: scala.Option[Boolean] = scala.None, ccEnableArenas: scala.Option[Boolean] = scala.None, objcClassPrefix: scala.Option[String] = scala.None, csharpNamespace: scala.Option[String] = scala.None, uninterpretedOption: Seq[UninterpretedOption] = scala.collection.Seq.empty[Nothing], unknownFields: 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( 0L )
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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileOptions(javaPackage: scala.Option[String] = scala.None, javaOuterClassname: scala.Option[String] = scala.None, javaMultipleFiles: scala.Option[Boolean] = scala.None, javaGenerateEqualsAndHash: scala.Option[Boolean] = scala.None, javaStringCheckUtf8: scala.Option[Boolean] = scala.None, optimizeFor: scala.Option[OptimizeMode] = scala.None, goPackage: scala.Option[String] = scala.None, ccGenericServices: scala.Option[Boolean] = scala.None, javaGenericServices: scala.Option[Boolean] = scala.None, pyGenericServices: scala.Option[Boolean] = scala.None, deprecated: scala.Option[Boolean] = scala.None, ccEnableArenas: scala.Option[Boolean] = scala.None, objcClassPrefix: scala.Option[String] = scala.None, csharpNamespace: scala.Option[String] = scala.None, uninterpretedOption: Seq[UninterpretedOption] = scala.collection.Seq.empty[Nothing], unknownFields: 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: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: scala.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: scala.Any): Boolean

    Definition Classes
    Any

  6. def addAllUninterpretedOption(__vs: TraversableOnce[UninterpretedOption]): FileOptions

  7. def addUninterpretedOption(__vs: UninterpretedOption*): FileOptions

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. val ccEnableArenas: scala.Option[Boolean]

    Enables the use of arenas for the proto messages in this file.

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

  10. val ccGenericServices: scala.Option[Boolean]

    Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system.

    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.

  11. def clearCcEnableArenas: FileOptions

  12. def clearCcGenericServices: FileOptions

  13. def clearCsharpNamespace: FileOptions

  14. def clearDeprecated: FileOptions

  15. def clearGoPackage: FileOptions

  16. def clearJavaGenerateEqualsAndHash: FileOptions

  17. def clearJavaGenericServices: FileOptions

  18. def clearJavaMultipleFiles: FileOptions

  19. def clearJavaOuterClassname: FileOptions

  20. def clearJavaPackage: FileOptions

  21. def clearJavaStringCheckUtf8: FileOptions

  22. def clearObjcClassPrefix: FileOptions

  23. def clearOptimizeFor: FileOptions

  24. def clearPyGenericServices: FileOptions

  25. def clearUninterpretedOption: FileOptions

  26. def clone(): AnyRef

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

  27. def companion: FileOptions.type

    Definition Classes
    FileOptions → GeneratedMessage

  28. val csharpNamespace: scala.Option[String]

    Namespace for generated classes; defaults to the package.

  29. val deprecated: scala.Option[Boolean]

    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.

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

    Definition Classes
    AnyRef

  31. def extension[T](generatedExtension: GeneratedExtension[FileOptions, T]): T

    Definition Classes
    ExtendableMessage

  32. def finalize(): Unit

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

  33. def getCcEnableArenas: Boolean

  34. def getCcGenericServices: Boolean

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

    Definition Classes
    AnyRef → Any

  36. def getCsharpNamespace: String

  37. def getDeprecated: Boolean

  38. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    FileOptions → GeneratedMessage

  39. def getFieldByNumber(__fieldNumber: Int): scala.Any

    Definition Classes
    FileOptions → GeneratedMessage

  40. def getGoPackage: String

  41. def getJavaGenerateEqualsAndHash: Boolean

  42. def getJavaGenericServices: Boolean

  43. def getJavaMultipleFiles: Boolean

  44. def getJavaOuterClassname: String

  45. def getJavaPackage: String

  46. def getJavaStringCheckUtf8: Boolean

  47. def getObjcClassPrefix: String

  48. def getOptimizeFor: OptimizeMode

  49. def getPyGenericServices: Boolean

  50. val goPackage: scala.Option[String]

    Sets the Go package where structs generated from this .

    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.

  51. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  52. val javaGenerateEqualsAndHash: scala.Option[Boolean]

    If set true, then the Java code generator will generate equals() and hashCode() methods for all messages defined in the .

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

  53. val javaGenericServices: scala.Option[Boolean]

  54. val javaMultipleFiles: scala.Option[Boolean]

    If set true, then the Java code generator will generate a separate .

    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.

  55. val javaOuterClassname: scala.Option[String]

    If set, all the classes from the .

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

  56. val javaPackage: scala.Option[String]

    Sets the Java package where classes generated from this .

    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.

  57. val javaStringCheckUtf8: scala.Option[Boolean]

    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.

    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.

  58. def mergeFrom(_input__: CodedInputStream): FileOptions

    Definition Classes
    FileOptions → Message

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

    Definition Classes
    AnyRef

  60. final def notify(): Unit

    Definition Classes
    AnyRef

  61. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  62. val objcClassPrefix: scala.Option[String]

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

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

  63. val optimizeFor: scala.Option[OptimizeMode]

  64. val pyGenericServices: scala.Option[Boolean]

  65. final def serializedSize: Int

    Definition Classes
    FileOptions → GeneratedMessage

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

    Definition Classes
    AnyRef

  67. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage

  68. def toByteString: ByteString

    Definition Classes
    GeneratedMessage

  69. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage

  70. def toString(): String

    Definition Classes
    FileOptions → AnyRef → Any

  71. val uninterpretedOption: Seq[UninterpretedOption]

    The parser stores options it doesn't recognize here.

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

  72. val unknownFields: scalapb.UnknownFieldSet

    Definition Classes
    FileOptions → ExtendableMessage

  73. def update(ms: (Lens[FileOptions, FileOptions]) ⇒ (FileOptions) ⇒ FileOptions*): FileOptions

    Definition Classes
    Updatable

  74. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  77. def withCcEnableArenas(__v: Boolean): FileOptions

  78. def withCcGenericServices(__v: Boolean): FileOptions

  79. def withCsharpNamespace(__v: String): FileOptions

  80. def withDeprecated(__v: Boolean): FileOptions

  81. def withExtension[T](generatedExtension: GeneratedExtension[FileOptions, T])(value: T): FileOptions

    Definition Classes
    ExtendableMessage

  82. def withGoPackage(__v: String): FileOptions

  83. def withJavaGenerateEqualsAndHash(__v: Boolean): FileOptions

  84. def withJavaGenericServices(__v: Boolean): FileOptions

  85. def withJavaMultipleFiles(__v: Boolean): FileOptions

  86. def withJavaOuterClassname(__v: String): FileOptions

  87. def withJavaPackage(__v: String): FileOptions

  88. def withJavaStringCheckUtf8(__v: Boolean): FileOptions

  89. def withObjcClassPrefix(__v: String): FileOptions

  90. def withOptimizeFor(__v: OptimizeMode): FileOptions

  91. def withPyGenericServices(__v: Boolean): FileOptions

  92. def withUninterpretedOption(__v: Seq[UninterpretedOption]): FileOptions

  93. def withUnknownFields(__v: scalapb.UnknownFieldSet): FileOptions

    Definition Classes
    FileOptions → ExtendableMessage

  94. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

  95. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    FileOptions → GeneratedMessage

  96. 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 trueaccord.scalapb.Message[FileOptions]

Inherited from trueaccord.scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from scala.Any

Ungrouped