Deploying to javadoc from @ 1792f69 🚀

brenoepics · Jan 15, 2024 · ca61379 · ca61379
1 parent 1c9b903
commit ca61379
Show file tree

Hide file tree

Showing 149 changed files with 391 additions and 348 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>All Classes and Interfaces (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>All Packages (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/javadoc/com/github/brenoepics/at4j/AT4J.html b/javadoc/com/github/brenoepics/at4j/AT4J.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>AT4J (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="declaration: package: com.github.brenoepics.at4j, class: AT4J">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/javadoc/com/github/brenoepics/at4j/AzureApi.html b/javadoc/com/github/brenoepics/at4j/AzureApi.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>AzureApi (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="declaration: package: com.github.brenoepics.at4j, interface: AzureApi">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
@@ -100,34 +100,39 @@ <h2>Method Summary</h2>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Detects the language of the given text.</div>
 </div>
-<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="azure/lang/Language.html" title="class in com.github.brenoepics.at4j.azure.lang">Language</a>&gt;&gt;&gt;</code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAvailableLanguages(com.github.brenoepics.at4j.data.request.AvailableLanguagesParams)" class="member-name-link">getAvailableLanguages</a><wbr>(<a href="data/request/AvailableLanguagesParams.html" title="class in com.github.brenoepics.at4j.data.request">AvailableLanguagesParams</a>&nbsp;params)</code></div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#disconnect()" class="member-name-link">disconnect</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
-<div class="block">Gets the available languages for translation.</div>
+<div class="block">Disconnects the AzureApi.</div>
 </div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="azure/BaseURL.html" title="enum in com.github.brenoepics.at4j.azure">BaseURL</a></code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBaseURL()" class="member-name-link">getBaseURL</a>()</code></div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="azure/lang/Language.html" title="class in com.github.brenoepics.at4j.azure.lang">Language</a>&gt;&gt;&gt;</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAvailableLanguages(com.github.brenoepics.at4j.data.request.AvailableLanguagesParams)" class="member-name-link">getAvailableLanguages</a><wbr>(<a href="data/request/AvailableLanguagesParams.html" title="class in com.github.brenoepics.at4j.data.request">AvailableLanguagesParams</a>&nbsp;params)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
-<div class="block">The BaseURL of the Azure Translator API.</div>
+<div class="block">Gets the available languages for translation.</div>
 </div>
-<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSubscriptionKey()" class="member-name-link">getSubscriptionKey</a>()</code></div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="azure/BaseURL.html" title="enum in com.github.brenoepics.at4j.azure">BaseURL</a></code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBaseURL()" class="member-name-link">getBaseURL</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
-<div class="block">Gets the used subscription key.</div>
+<div class="block">The BaseURL of the Azure Translator API.</div>
 </div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSubscriptionRegion()" class="member-name-link">getSubscriptionRegion</a>()</code></div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSubscriptionKey()" class="member-name-link">getSubscriptionKey</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
-<div class="block">Gets the used subscription region.</div>
+<div class="block">Gets the used subscription key.</div>
 </div>
-<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="core/thread/ThreadPool.html" title="interface in com.github.brenoepics.at4j.core.thread">ThreadPool</a></code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getThreadPool()" class="member-name-link">getThreadPool</a>()</code></div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSubscriptionRegion()" class="member-name-link">getSubscriptionRegion</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
-<div class="block">Gets the ThreadPool.</div>
+<div class="block">Gets the used subscription region.</div>
 </div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="data/response/TranslationResponse.html" title="class in com.github.brenoepics.at4j.data.response">TranslationResponse</a>&gt;&gt;</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#translate(com.github.brenoepics.at4j.data.request.TranslateParams)" class="member-name-link">translate</a><wbr>(<a href="data/request/TranslateParams.html" title="class in com.github.brenoepics.at4j.data.request">TranslateParams</a>&nbsp;params)</code></div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="core/thread/ThreadPool.html" title="interface in com.github.brenoepics.at4j.core.thread">ThreadPool</a></code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getThreadPool()" class="member-name-link">getThreadPool</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
+<div class="block">Gets the ThreadPool.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="data/response/TranslationResponse.html" title="class in com.github.brenoepics.at4j.data.response">TranslationResponse</a>&gt;&gt;</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#translate(com.github.brenoepics.at4j.data.request.TranslateParams)" class="member-name-link">translate</a><wbr>(<a href="data/request/TranslateParams.html" title="class in com.github.brenoepics.at4j.data.request">TranslateParams</a>&nbsp;params)</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Translates the given text from the given source language to the given target language.</div>
 </div>
 </div>
@@ -213,6 +218,16 @@ <h3>getThreadPool</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="disconnect()">
+<h3>disconnect</h3>
+<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">disconnect</span>()</div>
+<div class="block">Disconnects the AzureApi. <br>
+ This method should be called when the AzureApi is no longer needed.
+
+ <p><b>Note:</b> This method will shut down the ThreadPool. <br></div>
+</section>
+</li>
+<li>
 <section class="detail" id="translate(com.github.brenoepics.at4j.data.request.TranslateParams)">
 <h3>translate</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="data/response/TranslationResponse.html" title="class in com.github.brenoepics.at4j.data.response">TranslationResponse</a>&gt;&gt;</span>&nbsp;<span class="element-name">translate</span><wbr><span class="parameters">(<a href="data/request/TranslateParams.html" title="class in com.github.brenoepics.at4j.data.request">TranslateParams</a>&nbsp;params)</span></div>

diff --git a/javadoc/com/github/brenoepics/at4j/AzureApiBuilder.html b/javadoc/com/github/brenoepics/at4j/AzureApiBuilder.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>AzureApiBuilder (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="declaration: package: com.github.brenoepics.at4j, class: AzureApiBuilder">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
@@ -231,14 +231,13 @@ <h3>region</h3>
 <li>
 <section class="detail" id="build()">
 <h3>build</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AzureApi.html" title="interface in com.github.brenoepics.at4j">AzureApi</a></span>&nbsp;<span class="element-name">build</span>()
-               throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AzureApi.html" title="interface in com.github.brenoepics.at4j">AzureApi</a></span>&nbsp;<span class="element-name">build</span>()</div>
 <div class="block">Builds and returns an instance of AzureApi with the configured parameters.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>An instance of AzureApi with the specified configuration.</dd>
 <dt>Throws:</dt>
-<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code></dd>
+<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - If the subscription key is null.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">

diff --git a/javadoc/com/github/brenoepics/at4j/azure/BaseURL.html b/javadoc/com/github/brenoepics/at4j/azure/BaseURL.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>BaseURL (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="declaration: package: com.github.brenoepics.at4j.azure, enum: BaseURL">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/javadoc/com/github/brenoepics/at4j/azure/class-use/BaseURL.html b/javadoc/com/github/brenoepics/at4j/azure/class-use/BaseURL.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>Uses of Enum com.github.brenoepics.at4j.azure.BaseURL (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="use: package: com.github.brenoepics.at4j.azure, enum: BaseURL">
 <meta name="generator" content="javadoc/ClassUseWriter">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

diff --git a/javadoc/com/github/brenoepics/at4j/azure/lang/Language.html b/javadoc/com/github/brenoepics/at4j/azure/lang/Language.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>Language (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="declaration: package: com.github.brenoepics.at4j.azure.lang, class: Language">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

diff --git a/javadoc/com/github/brenoepics/at4j/azure/lang/LanguageDirection.html b/javadoc/com/github/brenoepics/at4j/azure/lang/LanguageDirection.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sat Jan 13 10:20:57 UTC 2024 -->
+<!-- Generated by javadoc (17) on Mon Jan 15 04:45:10 UTC 2024 -->
 <title>LanguageDirection (Azure Translator For Java 0.0.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-01-13">
+<meta name="dc.created" content="2024-01-15">
 <meta name="description" content="declaration: package: com.github.brenoepics.at4j.azure.lang, enum: LanguageDirection">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">