FileOptions

@SerialVersionUID(0L) final case class FileOptions(javaPackage: Option[String], javaOuterClassname: Option[String], javaMultipleFiles: Option[Boolean], javaGenerateEqualsAndHash: Option[Boolean], javaStringCheckUtf8: Option[Boolean], optimizeFor: Option[OptimizeMode], goPackage: Option[String], ccGenericServices: Option[Boolean], javaGenericServices: Option[Boolean], pyGenericServices: Option[Boolean], phpGenericServices: Option[Boolean], deprecated: Option[Boolean], ccEnableArenas: Option[Boolean], objcClassPrefix: Option[String], csharpNamespace: Option[String], swiftPrefix: Option[String], phpClassPrefix: Option[String], phpNamespace: Option[String], phpMetadataNamespace: Option[String], rubyPackage: Option[String], uninterpretedOption: Seq[UninterpretedOption], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[FileOptions] with ExtendableMessage[FileOptions]
Value Params
ccEnableArenas

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

ccGenericServices

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.

csharpNamespace

Namespace for generated classes; defaults to the package.

deprecated

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.

goPackage

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.
javaGenerateEqualsAndHash

This option does nothing.

javaMultipleFiles

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.

javaOuterClassname

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).

javaPackage

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.

javaStringCheckUtf8

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.

objcClassPrefix

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

phpClassPrefix

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

phpMetadataNamespace

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.

phpNamespace

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.

rubyPackage

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.

swiftPrefix

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.

uninterpretedOption

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

Companion
object
trait Updatable[FileOptions]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getCcEnableArenas: Boolean
def getCcGenericServices: Boolean
def getCsharpNamespace: String
def getDeprecated: Boolean
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
def getGoPackage: String
def getJavaMultipleFiles: Boolean
def getJavaPackage: String
def getObjcClassPrefix: String
def getPhpClassPrefix: String
def getPhpGenericServices: Boolean
def getPhpNamespace: String
def getPyGenericServices: Boolean
def getRubyPackage: String
def getSwiftPrefix: String
override def serializedSize: Int
Definition Classes
def toProtoString: String
def withCcEnableArenas(`__v`: Boolean): FileOptions
def withCcGenericServices(`__v`: Boolean): FileOptions
def withCsharpNamespace(`__v`: String): FileOptions
def withDeprecated(`__v`: Boolean): FileOptions
def withGoPackage(`__v`: String): FileOptions
def withJavaGenericServices(`__v`: Boolean): FileOptions
def withJavaMultipleFiles(`__v`: Boolean): FileOptions
def withJavaOuterClassname(`__v`: String): FileOptions
def withJavaPackage(`__v`: String): FileOptions
def withJavaStringCheckUtf8(`__v`: Boolean): FileOptions
def withObjcClassPrefix(`__v`: String): FileOptions
def withPhpClassPrefix(`__v`: String): FileOptions
def withPhpGenericServices(`__v`: Boolean): FileOptions
def withPhpNamespace(`__v`: String): FileOptions
def withPyGenericServices(`__v`: Boolean): FileOptions
def withRubyPackage(`__v`: String): FileOptions
def withSwiftPrefix(`__v`: String): FileOptions
def writeTo(`_output__`: CodedOutputStream): Unit

Inherited methods

def extension[T](generatedExtension: GeneratedExtension[FileOptions, T]): T
Inherited from
ExtendableMessage
def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
final def toByteArray: Array[Byte]

Serializes the messgae and returns a byte array containing its raw bytes

Serializes the messgae and returns a byte array containing its raw bytes

Inherited from
GeneratedMessage
final def toByteString: ByteString

Serializes the messgae and returns a ByteString containing its raw bytes

Serializes the messgae and returns a ByteString containing its raw bytes

Inherited from
GeneratedMessage
final def toPMessage: PMessage
Inherited from
GeneratedMessage
Inherited from
Updatable
def withExtension[T](generatedExtension: GeneratedExtension[FileOptions, T])(value: T): FileOptions
Inherited from
ExtendableMessage
final def writeDelimitedTo(output: OutputStream): Unit
Inherited from
GeneratedMessage
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Inherited from
GeneratedMessage