FileOptions

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 addAllUninterpretedOption(__vs: TraversableOnce[UninterpretedOption]): FileOptions

   

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

   

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. val ccEnableArenas: 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++.

8. val ccGenericServices: 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.

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

    FileOptions → GeneratedMessage

26. val csharpNamespace: Option[String]

    

    Namespace for generated classes; defaults to the package.

27. val deprecated: 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.

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

    

    Definition Classes

    AnyRef

29. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

30. def getAllFields: Map[FieldDescriptor, Any]

    

    Definition Classes

    GeneratedMessage

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): Any

    

    Definition Classes

    FileOptions → GeneratedMessage

37. def getGoPackage: String

    

38. def getJavaGenerateEqualsAndHash: Boolean

    

39. def getJavaGenericServices: Boolean

    

40. def getJavaMultipleFiles: Boolean

    

41. def getJavaOuterClassname: String

    

42. def getJavaPackage: String

    

43. def getJavaStringCheckUtf8: Boolean

    

44. def getObjcClassPrefix: String

    

45. def getOptimizeFor: OptimizeMode

    

46. def getPyGenericServices: Boolean

    

47. val goPackage: Option[String]

    

    Sets the Go package where structs generated from this .proto will be placed.

    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.

48. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

49. val javaGenerateEqualsAndHash: Option[Boolean]

    

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

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

50. val javaGenericServices: Option[Boolean]

    

51. val javaMultipleFiles: Option[Boolean]

    

    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.

    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.

52. val javaOuterClassname: Option[String]

    

    If set, all the classes from the .proto file are wrapped in a single outer class with the given name.

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

53. val javaPackage: Option[String]

    

    Sets the Java package where classes generated from this .proto will be placed.

    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.

54. val javaStringCheckUtf8: 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.

55. def mergeFrom(_input__: CodedInputStream): FileOptions

    

    Definition Classes

    FileOptions → Message

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

    

    Definition Classes

    AnyRef

57. final def notify(): Unit

    

    Definition Classes

    AnyRef

58. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

59. val objcClassPrefix: Option[String]

    

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

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

60. val optimizeFor: Option[OptimizeMode]

    

61. val pyGenericServices: Option[Boolean]

    

62. final def serializedSize: Int

    

    Definition Classes

    FileOptions → GeneratedMessage

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

    

    Definition Classes

    AnyRef

64. def toByteArray: Array[Byte]

    

    Definition Classes

    GeneratedMessage

65. def toString(): String

    

    Definition Classes

    FileOptions → AnyRef → Any

66. val uninterpretedOption: Seq[UninterpretedOption]

    

    The parser stores options it doesn't recognize here.

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

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

    

    Definition Classes

    Updatable

68. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

71. def withCcEnableArenas(__v: Boolean): FileOptions

    

72. def withCcGenericServices(__v: Boolean): FileOptions

    

73. def withCsharpNamespace(__v: String): FileOptions

    

74. def withDeprecated(__v: Boolean): FileOptions

    

75. def withGoPackage(__v: String): FileOptions

    

76. def withJavaGenerateEqualsAndHash(__v: Boolean): FileOptions

    

77. def withJavaGenericServices(__v: Boolean): FileOptions

    

78. def withJavaMultipleFiles(__v: Boolean): FileOptions

    

79. def withJavaOuterClassname(__v: String): FileOptions

    

80. def withJavaPackage(__v: String): FileOptions

    

81. def withJavaStringCheckUtf8(__v: Boolean): FileOptions

    

82. def withObjcClassPrefix(__v: String): FileOptions

    

83. def withOptimizeFor(__v: OptimizeMode): FileOptions

    

84. def withPyGenericServices(__v: Boolean): FileOptions

    

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

    

86. def writeDelimitedTo(output: OutputStream): Unit

    

    Definition Classes

    GeneratedMessage

87. def writeTo(_output__: CodedOutputStream): Unit

    

    Definition Classes

    FileOptions → GeneratedMessage

88. def writeTo(output: OutputStream): Unit

    

    Definition Classes

    GeneratedMessage