FileOptions class

Inheritance
  • Object
  • GeneratedMessage
  • FileOptions
Available extensions

Constructors

FileOptions.new({String? javaPackage, String? javaOuterClassname, FileOptions_OptimizeMode? optimizeFor, bool? javaMultipleFiles, String? goPackage, bool? ccGenericServices, bool? javaGenericServices, bool? pyGenericServices, @Deprecated('This field is deprecated.') bool? javaGenerateEqualsAndHash, bool? deprecated, bool? javaStringCheckUtf8, bool? ccEnableArenas, String? objcClassPrefix, String? csharpNamespace, String? swiftPrefix, String? phpClassPrefix, String? phpNamespace, bool? phpGenericServices, String? phpMetadataNamespace, String? rubyPackage, Iterable<UninterpretedOption>? uninterpretedOption})
factory
FileOptions.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
FileOptions.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

ccEnableArenas ↔ bool
Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.
getter/setter pair
ccGenericServices ↔ bool
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.
getter/setter pair
csharpNamespace ↔ String
Namespace for generated classes; defaults to the package.
getter/setter pair
deprecated ↔ bool
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.
getter/setter pair
goPackage ↔ String
Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
javaGenerateEqualsAndHash ↔ bool
This option does nothing.
getter/setter pair
javaGenericServices ↔ bool
getter/setter pair
javaMultipleFiles ↔ bool
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.
getter/setter pair
javaOuterClassname ↔ String
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.
getter/setter pair
javaPackage ↔ String
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.
getter/setter pair
javaStringCheckUtf8 ↔ bool
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.
getter/setter pair
objcClassPrefix ↔ String
Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.
getter/setter pair
optimizeFor ↔ FileOptions_OptimizeMode
getter/setter pair
phpClassPrefix ↔ String
Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.
getter/setter pair
phpGenericServices ↔ bool
getter/setter pair
phpMetadataNamespace ↔ String
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.
getter/setter pair
phpNamespace ↔ String
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.
getter/setter pair
pyGenericServices ↔ bool
getter/setter pair
rubyPackage ↔ String
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.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
swiftPrefix ↔ String
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.
getter/setter pair
uninterpretedOption → PbList<UninterpretedOption>
The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.
no setter
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearCcEnableArenas() → void
clearCcGenericServices() → void
clearCsharpNamespace() → void
clearDeprecated() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearGoPackage() → void
clearJavaGenerateEqualsAndHash() → void
clearJavaGenericServices() → void
clearJavaMultipleFiles() → void
clearJavaOuterClassname() → void
clearJavaPackage() → void
clearJavaStringCheckUtf8() → void
clearObjcClassPrefix() → void
clearOptimizeFor() → void
clearPhpClassPrefix() → void
clearPhpGenericServices() → void
clearPhpMetadataNamespace() → void
clearPhpNamespace() → void
clearPyGenericServices() → void
clearRubyPackage() → void
clearSwiftPrefix() → void
clone() → FileOptions
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(FileOptions)) → FileOptions
Apply updates to a copy of this message.
override
createEmptyInstance() → FileOptions
Creates an empty instance of the same message type as this.
override
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasCcEnableArenas() → bool
hasCcGenericServices() → bool
hasCsharpNamespace() → bool
hasDeprecated() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasGoPackage() → bool
hasJavaGenerateEqualsAndHash() → bool
hasJavaGenericServices() → bool
hasJavaMultipleFiles() → bool
hasJavaOuterClassname() → bool
hasJavaPackage() → bool
hasJavaStringCheckUtf8() → bool
hasObjcClassPrefix() → bool
hasOptimizeFor() → bool
hasPhpClassPrefix() → bool
hasPhpGenericServices() → bool
hasPhpMetadataNamespace() → bool
hasPhpNamespace() → bool
hasPyGenericServices() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRubyPackage() → bool
hasSwiftPrefix() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

create() → FileOptions
createRepeated() → PbList<FileOptions>
getDefault() → FileOptions