TranslatorOptions.Builder
Stay organized with collections
Save and categorize content based on your preferences.
Public Constructor Summary
Inherited Method Summary
From class java.lang.Object
|
Object
|
clone()
|
| boolean |
|
| void |
finalize()
|
|
final Class<?>
|
getClass()
|
| int |
hashCode()
|
| final void |
notify()
|
| final void |
notifyAll()
|
|
String
|
toString()
|
| final void |
wait(long arg0, int arg1)
|
| final void |
wait(long arg0)
|
| final void |
wait()
|
Public Methods
Creates a new TranslatorOptions
instance. The source and target language should be set before calling this method.
Sets the custom Executor
to use. If no Executor
is set, an internal background thread pool will be used.
Most clients should not need to call this method.
Returns
- this object, for chaining method calls
Sets the language to translate from.
Returns
- this object, for chaining method calls
Sets the language to translate to.
Returns
- this object, for chaining method calls
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eTranslatorOptions.Builder\u003c/code\u003e is used to create \u003ccode\u003eTranslatorOptions\u003c/code\u003e instances for configuring translation tasks.\u003c/p\u003e\n"],["\u003cp\u003eYou must specify the source and target languages using \u003ccode\u003esetSourceLanguage\u003c/code\u003e and \u003ccode\u003esetTargetLanguage\u003c/code\u003e before building the options.\u003c/p\u003e\n"],["\u003cp\u003eAn optional custom \u003ccode\u003eExecutor\u003c/code\u003e can be set via \u003ccode\u003esetExecutor\u003c/code\u003e for managing task execution, otherwise, a default thread pool is used.\u003c/p\u003e\n"],["\u003cp\u003eCalling \u003ccode\u003ebuild()\u003c/code\u003e creates an immutable \u003ccode\u003eTranslatorOptions\u003c/code\u003e instance based on the builder's configuration.\u003c/p\u003e\n"]]],[],null,["# TranslatorOptions.Builder\n\npublic static class **TranslatorOptions.Builder** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nBuilder to create a [TranslatorOptions](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions)\ninstance. \n\n### Public Constructor Summary\n\n|---|---------------------------------------------------------------------------------------------------|\n| | [Builder](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder#Builder())() |\n\n### Public Method Summary\n\n|---------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [TranslatorOptions](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions) | [build](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder#build())() Creates a new [TranslatorOptions](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions) instance. |\n| [TranslatorOptions.Builder](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder) | [setExecutor](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder#setExecutor(java.util.concurrent.Executor))([Executor](//developer.android.com/reference/java/util/concurrent/Executor.html) executor) Sets the custom [Executor](//developer.android.com/reference/java/util/concurrent/Executor.html) to use. |\n| [TranslatorOptions.Builder](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder) | [setSourceLanguage](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder#setSourceLanguage(java.lang.String))([String](//developer.android.com/reference/java/lang/String.html) sourceLanguage) Sets the language to translate from. |\n| [TranslatorOptions.Builder](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder) | [setTargetLanguage](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder#setTargetLanguage(java.lang.String))([String](//developer.android.com/reference/java/lang/String.html) targetLanguage) Sets the language to translate to. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Constructors\n-------------------\n\n#### public **Builder** ()\n\nPublic Methods\n--------------\n\n#### public [TranslatorOptions](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions)\n**build** ()\n\nCreates a new [TranslatorOptions](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions)\ninstance. The source and target language should be set before calling this method. \n\n#### public [TranslatorOptions.Builder](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder)\n**setExecutor** ([Executor](//developer.android.com/reference/java/util/concurrent/Executor.html) executor)\n\nSets the custom [Executor](//developer.android.com/reference/java/util/concurrent/Executor.html)\nto use. If no [Executor](//developer.android.com/reference/java/util/concurrent/Executor.html)\nis set, an internal background thread pool will be used.\n\nMost clients should not need to call this method. \n\n##### Parameters\n\n| executor | the [Executor](//developer.android.com/reference/java/util/concurrent/Executor.html) to use |\n|----------|---------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- this object, for chaining method calls \n\n#### public [TranslatorOptions.Builder](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder)\n**setSourceLanguage** ([String](//developer.android.com/reference/java/lang/String.html) sourceLanguage)\n\nSets the language to translate from. \n\n##### Parameters\n\n| sourceLanguage | the [BCP 47](//tools.ietf.org/html/bcp47) tag of the language to translate from. The value must be one of the possible values for [TranslateLanguage.Language](/android/reference/com/google/mlkit/nl/translate/TranslateLanguage.Language)). |\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- this object, for chaining method calls \n\n#### public [TranslatorOptions.Builder](/android/reference/com/google/mlkit/nl/translate/TranslatorOptions.Builder)\n**setTargetLanguage** ([String](//developer.android.com/reference/java/lang/String.html) targetLanguage)\n\nSets the language to translate to. \n\n##### Parameters\n\n| targetLanguage | the [BCP 47](//tools.ietf.org/html/bcp47) tag of the language to translate to. The value must be one of the possible values for [TranslateLanguage.Language](/android/reference/com/google/mlkit/nl/translate/TranslateLanguage.Language)). |\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- this object, for chaining method calls"]]
