Package com.google.protobuf

Class DescriptorProtos.FileOptions

    • Field Detail

      • JAVA_PACKAGE_FIELD_NUMBER

        public static final int JAVA_PACKAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • JAVA_OUTER_CLASSNAME_FIELD_NUMBER

        public static final int JAVA_OUTER_CLASSNAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • JAVA_MULTIPLE_FILES_FIELD_NUMBER

        public static final int JAVA_MULTIPLE_FILES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • JAVA_GENERATE_EQUALS_AND_HASH_FIELD_NUMBER

        public static final int JAVA_GENERATE_EQUALS_AND_HASH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • JAVA_STRING_CHECK_UTF8_FIELD_NUMBER

        public static final int JAVA_STRING_CHECK_UTF8_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPTIMIZE_FOR_FIELD_NUMBER

        public static final int OPTIMIZE_FOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GO_PACKAGE_FIELD_NUMBER

        public static final int GO_PACKAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CC_GENERIC_SERVICES_FIELD_NUMBER

        public static final int CC_GENERIC_SERVICES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • JAVA_GENERIC_SERVICES_FIELD_NUMBER

        public static final int JAVA_GENERIC_SERVICES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PY_GENERIC_SERVICES_FIELD_NUMBER

        public static final int PY_GENERIC_SERVICES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PHP_GENERIC_SERVICES_FIELD_NUMBER

        public static final int PHP_GENERIC_SERVICES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPRECATED_FIELD_NUMBER

        public static final int DEPRECATED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CC_ENABLE_ARENAS_FIELD_NUMBER

        public static final int CC_ENABLE_ARENAS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OBJC_CLASS_PREFIX_FIELD_NUMBER

        public static final int OBJC_CLASS_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CSHARP_NAMESPACE_FIELD_NUMBER

        public static final int CSHARP_NAMESPACE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SWIFT_PREFIX_FIELD_NUMBER

        public static final int SWIFT_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PHP_CLASS_PREFIX_FIELD_NUMBER

        public static final int PHP_CLASS_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PHP_NAMESPACE_FIELD_NUMBER

        public static final int PHP_NAMESPACE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PHP_METADATA_NAMESPACE_FIELD_NUMBER

        public static final int PHP_METADATA_NAMESPACE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUBY_PACKAGE_FIELD_NUMBER

        public static final int RUBY_PACKAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNINTERPRETED_OPTION_FIELD_NUMBER

        public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • hasJavaPackage

        public 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;
        Specified by:
        hasJavaPackage in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the javaPackage field is set.

      • getJavaPackage

        public java.lang.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;
        Specified by:
        getJavaPackage in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The javaPackage.

      • getJavaPackageBytes

        public 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;
        Specified by:
        getJavaPackageBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for javaPackage.

      • hasJavaOuterClassname

        public boolean hasJavaOuterClassname()
         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).
        optional string java_outer_classname = 8;
        Specified by:
        hasJavaOuterClassname in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the javaOuterClassname field is set.

      • getJavaOuterClassname

        public java.lang.String getJavaOuterClassname()
         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).
        optional string java_outer_classname = 8;
        Specified by:
        getJavaOuterClassname in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The javaOuterClassname.

      • getJavaOuterClassnameBytes

        public ByteString getJavaOuterClassnameBytes()
         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).
        optional string java_outer_classname = 8;
        Specified by:
        getJavaOuterClassnameBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for javaOuterClassname.

      • hasJavaMultipleFiles

        public boolean hasJavaMultipleFiles()
         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.
        optional bool java_multiple_files = 10 [default = false];
        Specified by:
        hasJavaMultipleFiles in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the javaMultipleFiles field is set.

      • getJavaMultipleFiles

        public boolean getJavaMultipleFiles()
         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.
        optional bool java_multiple_files = 10 [default = false];
        Specified by:
        getJavaMultipleFiles in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The javaMultipleFiles.

      • hasJavaGenerateEqualsAndHash

        @Deprecated
public boolean hasJavaGenerateEqualsAndHash()
        Deprecated.
         This option does nothing.
        optional bool java_generate_equals_and_hash = 20 [deprecated = true];
        Specified by:
        hasJavaGenerateEqualsAndHash in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the javaGenerateEqualsAndHash field is set.

      • getJavaGenerateEqualsAndHash

        @Deprecated
public boolean getJavaGenerateEqualsAndHash()
        Deprecated.
         This option does nothing.
        optional bool java_generate_equals_and_hash = 20 [deprecated = true];
        Specified by:
        getJavaGenerateEqualsAndHash in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The javaGenerateEqualsAndHash.

      • hasJavaStringCheckUtf8

        public 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];
        Specified by:
        hasJavaStringCheckUtf8 in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the javaStringCheckUtf8 field is set.

      • getJavaStringCheckUtf8

        public 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];
        Specified by:
        getJavaStringCheckUtf8 in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The javaStringCheckUtf8.

      • hasOptimizeFor

        public boolean hasOptimizeFor()
        optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];
        Specified by:
        hasOptimizeFor in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the optimizeFor field is set.

      • hasGoPackage

        public 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;
        Specified by:
        hasGoPackage in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the goPackage field is set.

      • getGoPackage

        public java.lang.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;
        Specified by:
        getGoPackage in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The goPackage.

      • getGoPackageBytes

        public 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;
        Specified by:
        getGoPackageBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for goPackage.

      • hasCcGenericServices

        public 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];
        Specified by:
        hasCcGenericServices in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the ccGenericServices field is set.

      • getCcGenericServices

        public 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];
        Specified by:
        getCcGenericServices in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The ccGenericServices.

      • hasDeprecated

        public 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];
        Specified by:
        hasDeprecated in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the deprecated field is set.

      • getDeprecated

        public 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];
        Specified by:
        getDeprecated in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The deprecated.

      • hasCcEnableArenas

        public 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];
        Specified by:
        hasCcEnableArenas in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the ccEnableArenas field is set.

      • getCcEnableArenas

        public 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];
        Specified by:
        getCcEnableArenas in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The ccEnableArenas.

      • hasObjcClassPrefix

        public 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;
        Specified by:
        hasObjcClassPrefix in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the objcClassPrefix field is set.

      • getObjcClassPrefix

        public java.lang.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;
        Specified by:
        getObjcClassPrefix in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The objcClassPrefix.

      • getObjcClassPrefixBytes

        public 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;
        Specified by:
        getObjcClassPrefixBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for objcClassPrefix.

      • hasCsharpNamespace

        public boolean hasCsharpNamespace()
         Namespace for generated classes; defaults to the package.
        optional string csharp_namespace = 37;
        Specified by:
        hasCsharpNamespace in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the csharpNamespace field is set.

      • getCsharpNamespace

        public java.lang.String getCsharpNamespace()
         Namespace for generated classes; defaults to the package.
        optional string csharp_namespace = 37;
        Specified by:
        getCsharpNamespace in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The csharpNamespace.

      • hasSwiftPrefix

        public 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;
        Specified by:
        hasSwiftPrefix in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the swiftPrefix field is set.

      • getSwiftPrefix

        public java.lang.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;
        Specified by:
        getSwiftPrefix in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The swiftPrefix.

      • getSwiftPrefixBytes

        public 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;
        Specified by:
        getSwiftPrefixBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for swiftPrefix.

      • hasPhpClassPrefix

        public 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;
        Specified by:
        hasPhpClassPrefix in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the phpClassPrefix field is set.

      • getPhpClassPrefix

        public java.lang.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;
        Specified by:
        getPhpClassPrefix in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The phpClassPrefix.

      • getPhpClassPrefixBytes

        public 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;
        Specified by:
        getPhpClassPrefixBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for phpClassPrefix.

      • hasPhpNamespace

        public 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;
        Specified by:
        hasPhpNamespace in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the phpNamespace field is set.

      • getPhpNamespace

        public java.lang.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;
        Specified by:
        getPhpNamespace in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The phpNamespace.

      • getPhpNamespaceBytes

        public 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;
        Specified by:
        getPhpNamespaceBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for phpNamespace.

      • hasPhpMetadataNamespace

        public 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;
        Specified by:
        hasPhpMetadataNamespace in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the phpMetadataNamespace field is set.

      • getPhpMetadataNamespace

        public java.lang.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;
        Specified by:
        getPhpMetadataNamespace in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The phpMetadataNamespace.

      • getPhpMetadataNamespaceBytes

        public 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;
        Specified by:
        getPhpMetadataNamespaceBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for phpMetadataNamespace.

      • hasRubyPackage

        public 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;
        Specified by:
        hasRubyPackage in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        Whether the rubyPackage field is set.

      • getRubyPackage

        public java.lang.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;
        Specified by:
        getRubyPackage in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The rubyPackage.

      • getRubyPackageBytes

        public 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;
        Specified by:
        getRubyPackageBytes in interface DescriptorProtos.FileOptionsOrBuilder
        Returns:
        The bytes for rubyPackage.

      • getUninterpretedOptionCount

        public 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;
        Specified by:
        getUninterpretedOptionCount in interface DescriptorProtos.FileOptionsOrBuilder

      • equals

        public boolean equals​(java.lang.Object obj)
        Description copied from interface: Message
        Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.
        Specified by:
        equals in interface Message
        Overrides:
        equals in class AbstractMessage
        Parameters:
        obj - object to be compared for equality with this message
        Returns:
        true if the specified object is equal to this message

      • hashCode

        public int hashCode()
        Description copied from interface: Message
        Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.
        Specified by:
        hashCode in interface Message
        Overrides:
        hashCode in class AbstractMessage
        Returns:
        the hash code value for this message
        See Also:
        Map.hashCode()

      • parseFrom

        public static DescriptorProtos.FileOptions parseFrom​(java.io.InputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static DescriptorProtos.FileOptions parseDelimitedFrom​(java.io.InputStream input)
                                                       throws java.io.IOException
        Throws:
        java.io.IOException