Package com.google.protobuf
Interface DescriptorProtos.FileOptionsOrBuilder
- All Superinterfaces:
GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.FileOptions>
,MessageLiteOrBuilder
,MessageOrBuilder
- All Known Implementing Classes:
DescriptorProtos.FileOptions
,DescriptorProtos.FileOptions.Builder
- Enclosing class:
- DescriptorProtos
public static interface DescriptorProtos.FileOptionsOrBuilder
extends GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.FileOptions>
-
Method Summary
Modifier and TypeMethodDescriptionboolean
optional bool cc_generic_services = 16 [default = false];
boolean
optional bool deprecated = 23 [default = false];
optional string go_package = 11;
optional string go_package = 11;
boolean
optional bool java_generate_equals_and_hash = 20 [default = false];
boolean
optional bool java_generic_services = 17 [default = false];
boolean
optional bool java_multiple_files = 10 [default = false];
optional string java_outer_classname = 8;
optional string java_outer_classname = 8;
optional string java_package = 1;
optional string java_package = 1;
boolean
optional bool java_string_check_utf8 = 27 [default = false];
optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];
boolean
optional bool py_generic_services = 18 [default = false];
getUninterpretedOption
(int index) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
int
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOptionOrBuilder
(int index) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
boolean
optional bool cc_generic_services = 16 [default = false];
boolean
optional bool deprecated = 23 [default = false];
boolean
optional string go_package = 11;
boolean
optional bool java_generate_equals_and_hash = 20 [default = false];
boolean
optional bool java_generic_services = 17 [default = false];
boolean
optional bool java_multiple_files = 10 [default = false];
boolean
optional string java_outer_classname = 8;
boolean
optional string java_package = 1;
boolean
optional bool java_string_check_utf8 = 27 [default = false];
boolean
optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];
boolean
optional bool py_generic_services = 18 [default = false];
Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder
getDefaultInstanceForType, getExtension, getExtension, getExtensionCount, hasExtension
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasJavaPackage
boolean hasJavaPackage()optional string java_package = 1;
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.
-
getJavaPackage
String getJavaPackage()optional string java_package = 1;
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.
-
getJavaPackageBytes
ByteString getJavaPackageBytes()optional string java_package = 1;
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.
-
hasJavaOuterClassname
boolean hasJavaOuterClassname()optional string java_outer_classname = 8;
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).
-
getJavaOuterClassname
String getJavaOuterClassname()optional string java_outer_classname = 8;
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).
-
getJavaOuterClassnameBytes
ByteString getJavaOuterClassnameBytes()optional string java_outer_classname = 8;
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).
-
hasJavaMultipleFiles
boolean hasJavaMultipleFiles()optional bool java_multiple_files = 10 [default = false];
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.
-
getJavaMultipleFiles
boolean getJavaMultipleFiles()optional bool java_multiple_files = 10 [default = false];
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.
-
hasJavaGenerateEqualsAndHash
boolean hasJavaGenerateEqualsAndHash()optional bool java_generate_equals_and_hash = 20 [default = false];
If set true, then the Java code generator will generate equals() and hashCode() methods for all messages defined in the .proto file. - In the full runtime, this is purely 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.)
-
getJavaGenerateEqualsAndHash
boolean getJavaGenerateEqualsAndHash()optional bool java_generate_equals_and_hash = 20 [default = false];
If set true, then the Java code generator will generate equals() and hashCode() methods for all messages defined in the .proto file. - In the full runtime, this is purely 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.)
-
hasJavaStringCheckUtf8
boolean hasJavaStringCheckUtf8()optional bool java_string_check_utf8 = 27 [default = false];
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.
-
getJavaStringCheckUtf8
boolean getJavaStringCheckUtf8()optional bool java_string_check_utf8 = 27 [default = false];
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.
-
hasOptimizeFor
boolean hasOptimizeFor()optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];
-
getOptimizeFor
DescriptorProtos.FileOptions.OptimizeMode getOptimizeFor()optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];
-
hasGoPackage
boolean hasGoPackage()optional string go_package = 11;
Sets the Go package where structs generated from this .proto will be placed. There is no default.
-
getGoPackage
String getGoPackage()optional string go_package = 11;
Sets the Go package where structs generated from this .proto will be placed. There is no default.
-
getGoPackageBytes
ByteString getGoPackageBytes()optional string go_package = 11;
Sets the Go package where structs generated from this .proto will be placed. There is no default.
-
hasCcGenericServices
boolean hasCcGenericServices()optional bool cc_generic_services = 16 [default = false];
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 proto2. 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.
-
getCcGenericServices
boolean getCcGenericServices()optional bool cc_generic_services = 16 [default = false];
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 proto2. 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.
-
hasJavaGenericServices
boolean hasJavaGenericServices()optional bool java_generic_services = 17 [default = false];
-
getJavaGenericServices
boolean getJavaGenericServices()optional bool java_generic_services = 17 [default = false];
-
hasPyGenericServices
boolean hasPyGenericServices()optional bool py_generic_services = 18 [default = false];
-
getPyGenericServices
boolean getPyGenericServices()optional bool py_generic_services = 18 [default = false];
-
hasDeprecated
boolean hasDeprecated()optional bool deprecated = 23 [default = false];
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.
-
getDeprecated
boolean getDeprecated()optional bool deprecated = 23 [default = false];
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.
-
getUninterpretedOptionList
List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
The parser stores options it doesn't recognize here. See above.
-
getUninterpretedOption
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
The parser stores options it doesn't recognize here. See above.
-
getUninterpretedOptionCount
int getUninterpretedOptionCount()repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
The parser stores options it doesn't recognize here. See above.
-
getUninterpretedOptionOrBuilderList
List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
The parser stores options it doesn't recognize here. See above.
-
getUninterpretedOptionOrBuilder
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
The parser stores options it doesn't recognize here. See above.
-