Interface DescriptorProtos.FileOptionsOrBuilder

public static interface DescriptorProtos.FileOptionsOrBuilder extends GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.FileOptions>

Implements

com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<com.google.protobuf.DescriptorProtos.FileOptions>

Methods

getCcEnableArenas()

public abstract boolean getCcEnableArenas()

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

optional bool cc_enable_arenas = 31 [default = true];

Returns
TypeDescription
boolean

The ccEnableArenas.

getCcGenericServices()

public abstract boolean getCcGenericServices()

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.

optional bool cc_generic_services = 16 [default = false];

Returns
TypeDescription
boolean

The ccGenericServices.

getCsharpNamespace()

public abstract String getCsharpNamespace()

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

Returns
TypeDescription
String

The csharpNamespace.

getCsharpNamespaceBytes()

public abstract ByteString getCsharpNamespaceBytes()

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

Returns
TypeDescription
ByteString

The bytes for csharpNamespace.

getDeprecated()

public abstract boolean getDeprecated()

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.

optional bool deprecated = 23 [default = false];

Returns
TypeDescription
boolean

The deprecated.

getGoPackage()

public abstract String getGoPackage()

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.

optional string go_package = 11;

Returns
TypeDescription
String

The goPackage.

getGoPackageBytes()

public abstract ByteString getGoPackageBytes()

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.

optional string go_package = 11;

Returns
TypeDescription
ByteString

The bytes for goPackage.

getJavaGenerateEqualsAndHash()

public abstract boolean getJavaGenerateEqualsAndHash()

This option does nothing.

optional bool java_generate_equals_and_hash = 20 [deprecated = true];

Returns
TypeDescription
boolean

The javaGenerateEqualsAndHash.

getJavaGenericServices()

public abstract boolean getJavaGenericServices()

optional bool java_generic_services = 17 [default = false];

Returns
TypeDescription
boolean

The javaGenericServices.

getJavaMultipleFiles()

public abstract boolean getJavaMultipleFiles()

If enabled, 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 wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

optional bool java_multiple_files = 10 [default = false];

Returns
TypeDescription
boolean

The javaMultipleFiles.

getJavaOuterClassname()

public abstract String getJavaOuterClassname()

Controls the name of the wrapper Java class generated for the .proto file. That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

optional string java_outer_classname = 8;

Returns
TypeDescription
String

The javaOuterClassname.

getJavaOuterClassnameBytes()

public abstract ByteString getJavaOuterClassnameBytes()

Controls the name of the wrapper Java class generated for the .proto file. That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

optional string java_outer_classname = 8;

Returns
TypeDescription
ByteString

The bytes for javaOuterClassname.

getJavaPackage()

public abstract String getJavaPackage()

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.

optional string java_package = 1;

Returns
TypeDescription
String

The javaPackage.

getJavaPackageBytes()

public abstract ByteString getJavaPackageBytes()

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.

optional string java_package = 1;

Returns
TypeDescription
ByteString

The bytes for javaPackage.

getJavaStringCheckUtf8()

public abstract boolean getJavaStringCheckUtf8()

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.

optional bool java_string_check_utf8 = 27 [default = false];

Returns
TypeDescription
boolean

The javaStringCheckUtf8.

getObjcClassPrefix()

public abstract String getObjcClassPrefix()

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

optional string objc_class_prefix = 36;

Returns
TypeDescription
String

The objcClassPrefix.

getObjcClassPrefixBytes()

public abstract ByteString getObjcClassPrefixBytes()

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

optional string objc_class_prefix = 36;

Returns
TypeDescription
ByteString

The bytes for objcClassPrefix.

getOptimizeFor()

public abstract DescriptorProtos.FileOptions.OptimizeMode getOptimizeFor()

optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

Returns
TypeDescription
DescriptorProtos.FileOptions.OptimizeMode

The optimizeFor.

getPhpClassPrefix()

public abstract String getPhpClassPrefix()

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

optional string php_class_prefix = 40;

Returns
TypeDescription
String

The phpClassPrefix.

getPhpClassPrefixBytes()

public abstract ByteString getPhpClassPrefixBytes()

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

optional string php_class_prefix = 40;

Returns
TypeDescription
ByteString

The bytes for phpClassPrefix.

getPhpGenericServices()

public abstract boolean getPhpGenericServices()

optional bool php_generic_services = 42 [default = false];

Returns
TypeDescription
boolean

The phpGenericServices.

getPhpMetadataNamespace()

public abstract String getPhpMetadataNamespace()

Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace.

optional string php_metadata_namespace = 44;

Returns
TypeDescription
String

The phpMetadataNamespace.

getPhpMetadataNamespaceBytes()

public abstract ByteString getPhpMetadataNamespaceBytes()

Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace.

optional string php_metadata_namespace = 44;

Returns
TypeDescription
ByteString

The bytes for phpMetadataNamespace.

getPhpNamespace()

public abstract String getPhpNamespace()

Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.

optional string php_namespace = 41;

Returns
TypeDescription
String

The phpNamespace.

getPhpNamespaceBytes()

public abstract ByteString getPhpNamespaceBytes()

Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.

optional string php_namespace = 41;

Returns
TypeDescription
ByteString

The bytes for phpNamespace.

getPyGenericServices()

public abstract boolean getPyGenericServices()

optional bool py_generic_services = 18 [default = false];

Returns
TypeDescription
boolean

The pyGenericServices.

getRubyPackage()

public abstract String getRubyPackage()

Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.

optional string ruby_package = 45;

Returns
TypeDescription
String

The rubyPackage.

getRubyPackageBytes()

public abstract ByteString getRubyPackageBytes()

Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.

optional string ruby_package = 45;

Returns
TypeDescription
ByteString

The bytes for rubyPackage.

getSwiftPrefix()

public abstract String getSwiftPrefix()

By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.

optional string swift_prefix = 39;

Returns
TypeDescription
String

The swiftPrefix.

getSwiftPrefixBytes()

public abstract ByteString getSwiftPrefixBytes()

By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.

optional string swift_prefix = 39;

Returns
TypeDescription
ByteString

The bytes for swiftPrefix.

getUninterpretedOption(int index)

public abstract DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)

The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.UninterpretedOption

getUninterpretedOptionCount()

public abstract int getUninterpretedOptionCount()

The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
TypeDescription
int

getUninterpretedOptionList()

public abstract List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()

The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
TypeDescription
List<UninterpretedOption>

getUninterpretedOptionOrBuilder(int index)

public abstract DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)

The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.UninterpretedOptionOrBuilder

getUninterpretedOptionOrBuilderList()

public abstract List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()

The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.UninterpretedOptionOrBuilder>

hasCcEnableArenas()

public abstract boolean hasCcEnableArenas()

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

optional bool cc_enable_arenas = 31 [default = true];

Returns
TypeDescription
boolean

Whether the ccEnableArenas field is set.

hasCcGenericServices()

public abstract boolean hasCcGenericServices()

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.

optional bool cc_generic_services = 16 [default = false];

Returns
TypeDescription
boolean

Whether the ccGenericServices field is set.

hasCsharpNamespace()

public abstract boolean hasCsharpNamespace()

Namespace for generated classes; defaults to the package.

optional string csharp_namespace = 37;

Returns
TypeDescription
boolean

Whether the csharpNamespace field is set.

hasDeprecated()

public abstract boolean hasDeprecated()

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.

optional bool deprecated = 23 [default = false];

Returns
TypeDescription
boolean

Whether the deprecated field is set.

hasGoPackage()

public abstract boolean hasGoPackage()

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.

optional string go_package = 11;

Returns
TypeDescription
boolean

Whether the goPackage field is set.

hasJavaGenerateEqualsAndHash()

public abstract boolean hasJavaGenerateEqualsAndHash()

This option does nothing.

optional bool java_generate_equals_and_hash = 20 [deprecated = true];

Returns
TypeDescription
boolean

Whether the javaGenerateEqualsAndHash field is set.

hasJavaGenericServices()

public abstract boolean hasJavaGenericServices()

optional bool java_generic_services = 17 [default = false];

Returns
TypeDescription
boolean

Whether the javaGenericServices field is set.

hasJavaMultipleFiles()

public abstract boolean hasJavaMultipleFiles()

If enabled, 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 wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

optional bool java_multiple_files = 10 [default = false];

Returns
TypeDescription
boolean

Whether the javaMultipleFiles field is set.

hasJavaOuterClassname()

public abstract boolean hasJavaOuterClassname()

Controls the name of the wrapper Java class generated for the .proto file. That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

optional string java_outer_classname = 8;

Returns
TypeDescription
boolean

Whether the javaOuterClassname field is set.

hasJavaPackage()

public abstract boolean hasJavaPackage()

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.

optional string java_package = 1;

Returns
TypeDescription
boolean

Whether the javaPackage field is set.

hasJavaStringCheckUtf8()

public abstract boolean hasJavaStringCheckUtf8()

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.

optional bool java_string_check_utf8 = 27 [default = false];

Returns
TypeDescription
boolean

Whether the javaStringCheckUtf8 field is set.

hasObjcClassPrefix()

public abstract boolean hasObjcClassPrefix()

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

optional string objc_class_prefix = 36;

Returns
TypeDescription
boolean

Whether the objcClassPrefix field is set.

hasOptimizeFor()

public abstract boolean hasOptimizeFor()

optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

Returns
TypeDescription
boolean

Whether the optimizeFor field is set.

hasPhpClassPrefix()

public abstract boolean hasPhpClassPrefix()

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

optional string php_class_prefix = 40;

Returns
TypeDescription
boolean

Whether the phpClassPrefix field is set.

hasPhpGenericServices()

public abstract boolean hasPhpGenericServices()

optional bool php_generic_services = 42 [default = false];

Returns
TypeDescription
boolean

Whether the phpGenericServices field is set.

hasPhpMetadataNamespace()

public abstract boolean hasPhpMetadataNamespace()

Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace.

optional string php_metadata_namespace = 44;

Returns
TypeDescription
boolean

Whether the phpMetadataNamespace field is set.

hasPhpNamespace()

public abstract boolean hasPhpNamespace()

Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.

optional string php_namespace = 41;

Returns
TypeDescription
boolean

Whether the phpNamespace field is set.

hasPyGenericServices()

public abstract boolean hasPyGenericServices()

optional bool py_generic_services = 18 [default = false];

Returns
TypeDescription
boolean

Whether the pyGenericServices field is set.

hasRubyPackage()

public abstract boolean hasRubyPackage()

Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.

optional string ruby_package = 45;

Returns
TypeDescription
boolean

Whether the rubyPackage field is set.

hasSwiftPrefix()

public abstract boolean hasSwiftPrefix()

By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.

optional string swift_prefix = 39;

Returns
TypeDescription
boolean

Whether the swiftPrefix field is set.