-
public final class FileOptionsKt.Dsl
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classFileOptionsKt.Dsl.Companionpublic final classFileOptionsKt.Dsl.UninterpretedOptionProxyAn uninstantiable, behaviorless type to represent the field in generics.
-
Field Summary
Fields Modifier and Type Field Description private StringjavaPackageprivate StringjavaOuterClassnameprivate BooleanjavaMultipleFilesprivate BooleanjavaGenerateEqualsAndHashprivate BooleanjavaStringCheckUtf8private DescriptorProtos.FileOptions.OptimizeModeoptimizeForprivate StringgoPackageprivate BooleanccGenericServicesprivate BooleanjavaGenericServicesprivate BooleanpyGenericServicesprivate BooleanphpGenericServicesprivate Booleandeprecatedprivate BooleanccEnableArenasprivate StringobjcClassPrefixprivate StringcsharpNamespaceprivate StringswiftPrefixprivate StringphpClassPrefixprivate StringphpNamespaceprivate StringphpMetadataNamespaceprivate StringrubyPackageprivate final DslList<DescriptorProtos.UninterpretedOption, FileOptionsKt.Dsl.UninterpretedOptionProxy>uninterpretedOption
-
Method Summary
Modifier and Type Method Description final StringgetJavaPackage()final UnitsetJavaPackage(String javaPackage)final StringgetJavaOuterClassname()final UnitsetJavaOuterClassname(String javaOuterClassname)final BooleangetJavaMultipleFiles()final UnitsetJavaMultipleFiles(Boolean javaMultipleFiles)final BooleangetJavaGenerateEqualsAndHash()final UnitsetJavaGenerateEqualsAndHash(@Deprecated(message = Field javaGenerateEqualsAndHash is deprecated) Boolean javaGenerateEqualsAndHash)final BooleangetJavaStringCheckUtf8()final UnitsetJavaStringCheckUtf8(Boolean javaStringCheckUtf8)final DescriptorProtos.FileOptions.OptimizeModegetOptimizeFor()final UnitsetOptimizeFor(DescriptorProtos.FileOptions.OptimizeMode optimizeFor)final StringgetGoPackage()final UnitsetGoPackage(String goPackage)final BooleangetCcGenericServices()final UnitsetCcGenericServices(Boolean ccGenericServices)final BooleangetJavaGenericServices()final UnitsetJavaGenericServices(Boolean javaGenericServices)final BooleangetPyGenericServices()final UnitsetPyGenericServices(Boolean pyGenericServices)final BooleangetPhpGenericServices()final UnitsetPhpGenericServices(Boolean phpGenericServices)final BooleangetDeprecated()final UnitsetDeprecated(Boolean deprecated)final BooleangetCcEnableArenas()final UnitsetCcEnableArenas(Boolean ccEnableArenas)final StringgetObjcClassPrefix()final UnitsetObjcClassPrefix(String objcClassPrefix)final StringgetCsharpNamespace()final UnitsetCsharpNamespace(String csharpNamespace)final StringgetSwiftPrefix()final UnitsetSwiftPrefix(String swiftPrefix)final StringgetPhpClassPrefix()final UnitsetPhpClassPrefix(String phpClassPrefix)final StringgetPhpNamespace()final UnitsetPhpNamespace(String phpNamespace)final StringgetPhpMetadataNamespace()final UnitsetPhpMetadataNamespace(String phpMetadataNamespace)final StringgetRubyPackage()final UnitsetRubyPackage(String rubyPackage)final UnitclearJavaPackage()<pre> Sets the Java package where classes generated from this .proto will be placed. final BooleanhasJavaPackage()<pre> Sets the Java package where classes generated from this .proto will be placed. final UnitclearJavaOuterClassname()<pre> Controls the name of the wrapper Java class generated for the .proto file. final BooleanhasJavaOuterClassname()<pre> Controls the name of the wrapper Java class generated for the .proto file. final UnitclearJavaMultipleFiles()<pre> 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. final BooleanhasJavaMultipleFiles()<pre> 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. final UnitclearJavaGenerateEqualsAndHash()<pre> This option does nothing. final BooleanhasJavaGenerateEqualsAndHash()<pre> This option does nothing. final UnitclearJavaStringCheckUtf8()<pre> 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. final BooleanhasJavaStringCheckUtf8()<pre> 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. final UnitclearOptimizeFor()<code>optional .google.protobuf.FileOptions. final BooleanhasOptimizeFor()<code>optional .google.protobuf.FileOptions. final UnitclearGoPackage()<pre> Sets the Go package where structs generated from this .proto will be placed. final BooleanhasGoPackage()<pre> Sets the Go package where structs generated from this .proto will be placed. final UnitclearCcGenericServices()<pre> Should generic services be generated in each language? final BooleanhasCcGenericServices()<pre> Should generic services be generated in each language? final UnitclearJavaGenericServices()<code>optional bool java_generic_services = 17 default = false;</code> final BooleanhasJavaGenericServices()<code>optional bool java_generic_services = 17 default = false;</code> final UnitclearPyGenericServices()<code>optional bool py_generic_services = 18 default = false;</code> final BooleanhasPyGenericServices()<code>optional bool py_generic_services = 18 default = false;</code> final UnitclearPhpGenericServices()<code>optional bool php_generic_services = 42 default = false;</code> final BooleanhasPhpGenericServices()<code>optional bool php_generic_services = 42 default = false;</code> final UnitclearDeprecated()<pre> Is this file deprecated? final BooleanhasDeprecated()<pre> Is this file deprecated? final UnitclearCcEnableArenas()<pre> Enables the use of arenas for the proto messages in this file. final BooleanhasCcEnableArenas()<pre> Enables the use of arenas for the proto messages in this file. final UnitclearObjcClassPrefix()<pre> Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. final BooleanhasObjcClassPrefix()<pre> Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. final UnitclearCsharpNamespace()<pre> Namespace for generated classes; defaults to the package. final BooleanhasCsharpNamespace()<pre> Namespace for generated classes; defaults to the package. final UnitclearSwiftPrefix()<pre> By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. final BooleanhasSwiftPrefix()<pre> By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. final UnitclearPhpClassPrefix()<pre> Sets the php class prefix which is prepended to all php generated classes from this .proto. final BooleanhasPhpClassPrefix()<pre> Sets the php class prefix which is prepended to all php generated classes from this .proto. final UnitclearPhpNamespace()<pre> Use this option to change the namespace of php generated classes. final BooleanhasPhpNamespace()<pre> Use this option to change the namespace of php generated classes. final UnitclearPhpMetadataNamespace()<pre> Use this option to change the namespace of php generated metadata classes. final BooleanhasPhpMetadataNamespace()<pre> Use this option to change the namespace of php generated metadata classes. final UnitclearRubyPackage()<pre> Use this option to change the package of ruby generated classes. final BooleanhasRubyPackage()<pre> Use this option to change the package of ruby generated classes. -
-
Method Detail
-
getJavaPackage
final String getJavaPackage()
-
setJavaPackage
final Unit setJavaPackage(String javaPackage)
-
getJavaOuterClassname
final String getJavaOuterClassname()
-
setJavaOuterClassname
final Unit setJavaOuterClassname(String javaOuterClassname)
-
getJavaMultipleFiles
final Boolean getJavaMultipleFiles()
-
setJavaMultipleFiles
final Unit setJavaMultipleFiles(Boolean javaMultipleFiles)
-
getJavaGenerateEqualsAndHash
final Boolean getJavaGenerateEqualsAndHash()
-
setJavaGenerateEqualsAndHash
final Unit setJavaGenerateEqualsAndHash(@Deprecated(message = Field javaGenerateEqualsAndHash is deprecated) Boolean javaGenerateEqualsAndHash)
-
getJavaStringCheckUtf8
final Boolean getJavaStringCheckUtf8()
-
setJavaStringCheckUtf8
final Unit setJavaStringCheckUtf8(Boolean javaStringCheckUtf8)
-
getOptimizeFor
final DescriptorProtos.FileOptions.OptimizeMode getOptimizeFor()
-
setOptimizeFor
final Unit setOptimizeFor(DescriptorProtos.FileOptions.OptimizeMode optimizeFor)
-
getGoPackage
final String getGoPackage()
-
setGoPackage
final Unit setGoPackage(String goPackage)
-
getCcGenericServices
final Boolean getCcGenericServices()
-
setCcGenericServices
final Unit setCcGenericServices(Boolean ccGenericServices)
-
getJavaGenericServices
final Boolean getJavaGenericServices()
-
setJavaGenericServices
final Unit setJavaGenericServices(Boolean javaGenericServices)
-
getPyGenericServices
final Boolean getPyGenericServices()
-
setPyGenericServices
final Unit setPyGenericServices(Boolean pyGenericServices)
-
getPhpGenericServices
final Boolean getPhpGenericServices()
-
setPhpGenericServices
final Unit setPhpGenericServices(Boolean phpGenericServices)
-
getDeprecated
final Boolean getDeprecated()
-
setDeprecated
final Unit setDeprecated(Boolean deprecated)
-
getCcEnableArenas
final Boolean getCcEnableArenas()
-
setCcEnableArenas
final Unit setCcEnableArenas(Boolean ccEnableArenas)
-
getObjcClassPrefix
final String getObjcClassPrefix()
-
setObjcClassPrefix
final Unit setObjcClassPrefix(String objcClassPrefix)
-
getCsharpNamespace
final String getCsharpNamespace()
-
setCsharpNamespace
final Unit setCsharpNamespace(String csharpNamespace)
-
getSwiftPrefix
final String getSwiftPrefix()
-
setSwiftPrefix
final Unit setSwiftPrefix(String swiftPrefix)
-
getPhpClassPrefix
final String getPhpClassPrefix()
-
setPhpClassPrefix
final Unit setPhpClassPrefix(String phpClassPrefix)
-
getPhpNamespace
final String getPhpNamespace()
-
setPhpNamespace
final Unit setPhpNamespace(String phpNamespace)
-
getPhpMetadataNamespace
final String getPhpMetadataNamespace()
-
setPhpMetadataNamespace
final Unit setPhpMetadataNamespace(String phpMetadataNamespace)
-
getRubyPackage
final String getRubyPackage()
-
setRubyPackage
final Unit setRubyPackage(String rubyPackage)
-
clearJavaPackage
final Unit clearJavaPackage()
<pre> 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. </pre><code>optional string java_package = 1;</code>
-
hasJavaPackage
final Boolean hasJavaPackage()
<pre> 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. </pre><code>optional string java_package = 1;</code>
-
clearJavaOuterClassname
final Unit clearJavaOuterClassname()
<pre> 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. </pre><code>optional string java_outer_classname = 8;</code>
-
hasJavaOuterClassname
final Boolean hasJavaOuterClassname()
<pre> 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. </pre><code>optional string java_outer_classname = 8;</code>
-
clearJavaMultipleFiles
final Unit clearJavaMultipleFiles()
<pre> 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. </pre><code>optional bool java_multiple_files = 10 default = false;</code>
-
hasJavaMultipleFiles
final Boolean hasJavaMultipleFiles()
<pre> 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. </pre><code>optional bool java_multiple_files = 10 default = false;</code>
-
clearJavaGenerateEqualsAndHash
final Unit clearJavaGenerateEqualsAndHash()
<pre> This option does nothing. </pre><code>optional bool java_generate_equals_and_hash = 20 deprecated = true;</code>
-
hasJavaGenerateEqualsAndHash
final Boolean hasJavaGenerateEqualsAndHash()
<pre> This option does nothing. </pre><code>optional bool java_generate_equals_and_hash = 20 deprecated = true;</code>
-
clearJavaStringCheckUtf8
final Unit clearJavaStringCheckUtf8()
<pre> 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. </pre><code>optional bool java_string_check_utf8 = 27 default = false;</code>
-
hasJavaStringCheckUtf8
final Boolean hasJavaStringCheckUtf8()
<pre> 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. </pre><code>optional bool java_string_check_utf8 = 27 default = false;</code>
-
clearOptimizeFor
final Unit clearOptimizeFor()
<code>optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 default = SPEED;</code>
-
hasOptimizeFor
final Boolean hasOptimizeFor()
<code>optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 default = SPEED;</code>
-
clearGoPackage
final Unit clearGoPackage()
<pre> 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. </pre><code>optional string go_package = 11;</code>
-
hasGoPackage
final Boolean hasGoPackage()
<pre> 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. </pre><code>optional string go_package = 11;</code>
-
clearCcGenericServices
final Unit clearCcGenericServices()
<pre> 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. </pre><code>optional bool cc_generic_services = 16 default = false;</code>
-
hasCcGenericServices
final Boolean hasCcGenericServices()
<pre> 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. </pre><code>optional bool cc_generic_services = 16 default = false;</code>
-
clearJavaGenericServices
final Unit clearJavaGenericServices()
<code>optional bool java_generic_services = 17 default = false;</code>
-
hasJavaGenericServices
final Boolean hasJavaGenericServices()
<code>optional bool java_generic_services = 17 default = false;</code>
-
clearPyGenericServices
final Unit clearPyGenericServices()
<code>optional bool py_generic_services = 18 default = false;</code>
-
hasPyGenericServices
final Boolean hasPyGenericServices()
<code>optional bool py_generic_services = 18 default = false;</code>
-
clearPhpGenericServices
final Unit clearPhpGenericServices()
<code>optional bool php_generic_services = 42 default = false;</code>
-
hasPhpGenericServices
final Boolean hasPhpGenericServices()
<code>optional bool php_generic_services = 42 default = false;</code>
-
clearDeprecated
final Unit clearDeprecated()
<pre> 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. </pre><code>optional bool deprecated = 23 default = false;</code>
-
hasDeprecated
final Boolean hasDeprecated()
<pre> 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. </pre><code>optional bool deprecated = 23 default = false;</code>
-
clearCcEnableArenas
final Unit clearCcEnableArenas()
<pre> Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. </pre><code>optional bool cc_enable_arenas = 31 default = true;</code>
-
hasCcEnableArenas
final Boolean hasCcEnableArenas()
<pre> Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++. </pre><code>optional bool cc_enable_arenas = 31 default = true;</code>
-
clearObjcClassPrefix
final Unit clearObjcClassPrefix()
<pre> Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. </pre><code>optional string objc_class_prefix = 36;</code>
-
hasObjcClassPrefix
final Boolean hasObjcClassPrefix()
<pre> Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default. </pre><code>optional string objc_class_prefix = 36;</code>
-
clearCsharpNamespace
final Unit clearCsharpNamespace()
<pre> Namespace for generated classes; defaults to the package. </pre><code>optional string csharp_namespace = 37;</code>
-
hasCsharpNamespace
final Boolean hasCsharpNamespace()
<pre> Namespace for generated classes; defaults to the package. </pre><code>optional string csharp_namespace = 37;</code>
-
clearSwiftPrefix
final Unit clearSwiftPrefix()
<pre> 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. </pre><code>optional string swift_prefix = 39;</code>
-
hasSwiftPrefix
final Boolean hasSwiftPrefix()
<pre> 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. </pre><code>optional string swift_prefix = 39;</code>
-
clearPhpClassPrefix
final Unit clearPhpClassPrefix()
<pre> Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. </pre><code>optional string php_class_prefix = 40;</code>
-
hasPhpClassPrefix
final Boolean hasPhpClassPrefix()
<pre> Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty. </pre><code>optional string php_class_prefix = 40;</code>
-
clearPhpNamespace
final Unit clearPhpNamespace()
<pre> 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. </pre><code>optional string php_namespace = 41;</code>
-
hasPhpNamespace
final Boolean hasPhpNamespace()
<pre> 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. </pre><code>optional string php_namespace = 41;</code>
-
clearPhpMetadataNamespace
final Unit clearPhpMetadataNamespace()
<pre> 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. </pre><code>optional string php_metadata_namespace = 44;</code>
-
hasPhpMetadataNamespace
final Boolean hasPhpMetadataNamespace()
<pre> 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. </pre><code>optional string php_metadata_namespace = 44;</code>
-
clearRubyPackage
final Unit clearRubyPackage()
<pre> 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. </pre><code>optional string ruby_package = 45;</code>
-
hasRubyPackage
final Boolean hasRubyPackage()
<pre> 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. </pre><code>optional string ruby_package = 45;</code>
-
-
-
-