final case class FileOptions(javaPackage: scala.Option[String] = None, javaOuterClassname: scala.Option[String] = None, javaMultipleFiles: scala.Option[Boolean] = None, javaGenerateEqualsAndHash: scala.Option[Boolean] = None, javaStringCheckUtf8: scala.Option[Boolean] = None, optimizeFor: scala.Option[OptimizeMode] = None, goPackage: scala.Option[String] = None, ccGenericServices: scala.Option[Boolean] = None, javaGenericServices: scala.Option[Boolean] = None, pyGenericServices: scala.Option[Boolean] = None, deprecated: scala.Option[Boolean] = None, ccEnableArenas: scala.Option[Boolean] = None, objcClassPrefix: scala.Option[String] = None, csharpNamespace: scala.Option[String] = None, swiftPrefix: scala.Option[String] = None, phpClassPrefix: scala.Option[String] = None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.collection.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet()) extends trueaccord.scalapb.GeneratedMessage with trueaccord.scalapb.Message[FileOptions] with Updatable[FileOptions] with ExtendableMessage[FileOptions] with Product with Serializable
- 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.
- 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).
- 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.
- javaGenerateEqualsAndHash
This option does nothing.
- 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.
- 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.
- 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.
- 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.
- ccEnableArenas
Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.
- objcClassPrefix
Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.
- csharpNamespace
Namespace for generated classes; defaults to the 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.
- phpClassPrefix
Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.
- uninterpretedOption
The parser stores options it doesn't recognize here. See above.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- FileOptions
- Product
- Equals
- ExtendableMessage
- Updatable
- Message
- GeneratedMessage
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
FileOptions(javaPackage: scala.Option[String] = None, javaOuterClassname: scala.Option[String] = None, javaMultipleFiles: scala.Option[Boolean] = None, javaGenerateEqualsAndHash: scala.Option[Boolean] = None, javaStringCheckUtf8: scala.Option[Boolean] = None, optimizeFor: scala.Option[OptimizeMode] = None, goPackage: scala.Option[String] = None, ccGenericServices: scala.Option[Boolean] = None, javaGenericServices: scala.Option[Boolean] = None, pyGenericServices: scala.Option[Boolean] = None, deprecated: scala.Option[Boolean] = None, ccEnableArenas: scala.Option[Boolean] = None, objcClassPrefix: scala.Option[String] = None, csharpNamespace: scala.Option[String] = None, swiftPrefix: scala.Option[String] = None, phpClassPrefix: scala.Option[String] = None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.collection.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet())
- 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.
- 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).
- 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.
- javaGenerateEqualsAndHash
This option does nothing.
- 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.
- 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.
- 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.
- 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.
- ccEnableArenas
Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.
- objcClassPrefix
Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.
- csharpNamespace
Namespace for generated classes; defaults to the 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.
- phpClassPrefix
Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.
- uninterpretedOption
The parser stores options it doesn't recognize here. See above.
Value Members
-
final
def
!=(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllUninterpretedOption(__vs: TraversableOnce[UninterpretedOption]): FileOptions
- def addUninterpretedOption(__vs: UninterpretedOption*): FileOptions
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val ccEnableArenas: scala.Option[Boolean]
- val ccGenericServices: scala.Option[Boolean]
- def clearCcEnableArenas: FileOptions
- def clearCcGenericServices: FileOptions
- def clearCsharpNamespace: FileOptions
- def clearDeprecated: FileOptions
- def clearGoPackage: FileOptions
- def clearJavaGenerateEqualsAndHash: FileOptions
- def clearJavaGenericServices: FileOptions
- def clearJavaMultipleFiles: FileOptions
- def clearJavaOuterClassname: FileOptions
- def clearJavaPackage: FileOptions
- def clearJavaStringCheckUtf8: FileOptions
- def clearObjcClassPrefix: FileOptions
- def clearOptimizeFor: FileOptions
- def clearPhpClassPrefix: FileOptions
- def clearPyGenericServices: FileOptions
- def clearSwiftPrefix: FileOptions
- def clearUninterpretedOption: FileOptions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
companion: FileOptions.type
- Definition Classes
- FileOptions → GeneratedMessage
- val csharpNamespace: scala.Option[String]
- val deprecated: scala.Option[Boolean]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
extension[T](generatedExtension: GeneratedExtension[FileOptions, T]): T
- Definition Classes
- ExtendableMessage
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def getCcEnableArenas: Boolean
- def getCcGenericServices: Boolean
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- def getCsharpNamespace: String
- def getDeprecated: Boolean
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- FileOptions → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): scala.Any
- Definition Classes
- FileOptions → GeneratedMessage
- def getGoPackage: String
- def getJavaGenerateEqualsAndHash: Boolean
- def getJavaGenericServices: Boolean
- def getJavaMultipleFiles: Boolean
- def getJavaOuterClassname: String
- def getJavaPackage: String
- def getJavaStringCheckUtf8: Boolean
- def getObjcClassPrefix: String
- def getOptimizeFor: OptimizeMode
- def getPhpClassPrefix: String
- def getPyGenericServices: Boolean
- def getSwiftPrefix: String
- val goPackage: scala.Option[String]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val javaGenerateEqualsAndHash: scala.Option[Boolean]
- val javaGenericServices: scala.Option[Boolean]
- val javaMultipleFiles: scala.Option[Boolean]
- val javaOuterClassname: scala.Option[String]
- val javaPackage: scala.Option[String]
- val javaStringCheckUtf8: scala.Option[Boolean]
-
def
mergeFrom(_input__: CodedInputStream): FileOptions
- Definition Classes
- FileOptions → Message
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- val objcClassPrefix: scala.Option[String]
- val optimizeFor: scala.Option[OptimizeMode]
- val phpClassPrefix: scala.Option[String]
- val pyGenericServices: scala.Option[Boolean]
-
final
def
serializedSize: Int
- Definition Classes
- FileOptions → GeneratedMessage
- val swiftPrefix: scala.Option[String]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
-
def
toByteString: ByteString
- Definition Classes
- GeneratedMessage
-
def
toPMessage: PMessage
- Definition Classes
- GeneratedMessage
-
def
toString(): String
- Definition Classes
- FileOptions → AnyRef → Any
- val uninterpretedOption: Seq[UninterpretedOption]
-
val
unknownFields: scalapb.UnknownFieldSet
- Definition Classes
- FileOptions → ExtendableMessage
-
def
update(ms: (Lens[FileOptions, FileOptions]) ⇒ Mutation[FileOptions]*): FileOptions
- Definition Classes
- Updatable
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def withCcEnableArenas(__v: Boolean): FileOptions
- def withCcGenericServices(__v: Boolean): FileOptions
- def withCsharpNamespace(__v: String): FileOptions
- def withDeprecated(__v: Boolean): FileOptions
-
def
withExtension[T](generatedExtension: GeneratedExtension[FileOptions, T])(value: T): FileOptions
- Definition Classes
- ExtendableMessage
- def withGoPackage(__v: String): FileOptions
- def withJavaGenerateEqualsAndHash(__v: Boolean): 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 withOptimizeFor(__v: OptimizeMode): FileOptions
- def withPhpClassPrefix(__v: String): FileOptions
- def withPyGenericServices(__v: Boolean): FileOptions
- def withSwiftPrefix(__v: String): FileOptions
- def withUninterpretedOption(__v: Seq[UninterpretedOption]): FileOptions
-
def
withUnknownFields(__v: scalapb.UnknownFieldSet): FileOptions
- Definition Classes
- FileOptions → ExtendableMessage
-
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- FileOptions → GeneratedMessage
-
def
writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
-
def
getAllFields: Map[FieldDescriptor, scala.Any]
- Definition Classes
- GeneratedMessage
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Use toPMessage
-
def
getField(field: FieldDescriptor): scala.Any
- Definition Classes
- GeneratedMessage
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue