Skip to content

Commit ab2e6a0

Browse files
committed
Add Site enum for easier methods
1 parent b59e2e8 commit ab2e6a0

31 files changed

+1753
-1156
lines changed

build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ plugins{
77
}
88

99
group = 'com.andre601'
10-
version = '2.0.2'
10+
version = '2.1.0'
1111

1212
sourceCompatibility = 1.8
1313

docs/allclasses-frame.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Sat Jul 27 00:50:18 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 12:24:23 CEST 2019 -->
66
<title>All Classes (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-27">
7+
<meta name="date" content="2019-07-31">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -16,6 +16,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
1616
<li><a href="com/andre601/javabotblockapi/BotBlockAPI.Builder.html" title="class in com.andre601.javabotblockapi" target="classFrame">BotBlockAPI.Builder</a></li>
1717
<li><a href="com/andre601/javabotblockapi/exceptions/RatelimitedException.html" title="class in com.andre601.javabotblockapi.exceptions" target="classFrame">RatelimitedException</a></li>
1818
<li><a href="com/andre601/javabotblockapi/RequestHandler.html" title="class in com.andre601.javabotblockapi" target="classFrame">RequestHandler</a></li>
19+
<li><a href="com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi" target="classFrame">Site</a></li>
1920
</ul>
2021
</div>
2122
</body>

docs/allclasses-noframe.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Sat Jul 27 00:50:18 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 12:24:23 CEST 2019 -->
66
<title>All Classes (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-27">
7+
<meta name="date" content="2019-07-31">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -16,6 +16,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
1616
<li><a href="com/andre601/javabotblockapi/BotBlockAPI.Builder.html" title="class in com.andre601.javabotblockapi">BotBlockAPI.Builder</a></li>
1717
<li><a href="com/andre601/javabotblockapi/exceptions/RatelimitedException.html" title="class in com.andre601.javabotblockapi.exceptions">RatelimitedException</a></li>
1818
<li><a href="com/andre601/javabotblockapi/RequestHandler.html" title="class in com.andre601.javabotblockapi">RequestHandler</a></li>
19+
<li><a href="com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi">Site</a></li>
1920
</ul>
2021
</div>
2122
</body>

docs/com/andre601/javabotblockapi/BotBlockAPI.Builder.html

+41-8
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Sat Jul 27 00:50:17 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 12:24:22 CEST 2019 -->
66
<title>BotBlockAPI.Builder (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-27">
7+
<meta name="date" content="2019-07-31">
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>
@@ -18,7 +18,7 @@
1818
catch(err) {
1919
}
2020
//-->
21-
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
21+
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
2222
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
2323
var altColor = "altColor";
2424
var rowColor = "rowColor";
@@ -154,24 +154,31 @@ <h3>Method Summary</h3>
154154
</tr>
155155
<tr id="i0" class="altColor">
156156
<td class="colFirst"><code><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html" title="class in com.andre601.javabotblockapi">BotBlockAPI.Builder</a></code></td>
157+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html#addAuthToken-com.andre601.javabotblockapi.Site-java.lang.String-">addAuthToken</a></span>(@NotNull <a href="../../../com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi">Site</a>&nbsp;site,
158+
@NotNull java.lang.String&nbsp;token)</code>
159+
<div class="block">Adds the provided <a href="../../../com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi"><code>Site name</code></a> and token to the Map.</div>
160+
</td>
161+
</tr>
162+
<tr id="i1" class="rowColor">
163+
<td class="colFirst"><code><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html" title="class in com.andre601.javabotblockapi">BotBlockAPI.Builder</a></code></td>
157164
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html#addAuthToken-java.lang.String-java.lang.String-">addAuthToken</a></span>(@NotNull java.lang.String&nbsp;site,
158165
@NotNull java.lang.String&nbsp;token)</code>
159166
<div class="block">Adds the provided Site name and token to the Map.</div>
160167
</td>
161168
</tr>
162-
<tr id="i1" class="rowColor">
169+
<tr id="i2" class="altColor">
163170
<td class="colFirst"><code><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.html" title="class in com.andre601.javabotblockapi">BotBlockAPI</a></code></td>
164171
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html#build--">build</a></span>()</code>
165172
<div class="block">Builds the instance of <a href="../../../com/andre601/javabotblockapi/BotBlockAPI.html" title="class in com.andre601.javabotblockapi"><code>BotBlockAPI</code></a>.</div>
166173
</td>
167174
</tr>
168-
<tr id="i2" class="altColor">
175+
<tr id="i3" class="rowColor">
169176
<td class="colFirst"><code><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html" title="class in com.andre601.javabotblockapi">BotBlockAPI.Builder</a></code></td>
170177
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html#setAuthTokens-java.util.Map-">setAuthTokens</a></span>(@NotNull java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;authTokens)</code>
171178
<div class="block">Sets the provided Map as the new Map.</div>
172179
</td>
173180
</tr>
174-
<tr id="i3" class="rowColor">
181+
<tr id="i4" class="altColor">
175182
<td class="colFirst"><code><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html" title="class in com.andre601.javabotblockapi">BotBlockAPI.Builder</a></code></td>
176183
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html#setUpdateInteval-int-">setUpdateInteval</a></span>(int&nbsp;updateInterval)</code>
177184
<div class="block">Sets the update interval in minutes for the auto-posting.</div>
@@ -217,6 +224,32 @@ <h4>Builder</h4>
217224
<!-- -->
218225
</a>
219226
<h3>Method Detail</h3>
227+
<a name="addAuthToken-com.andre601.javabotblockapi.Site-java.lang.String-">
228+
<!-- -->
229+
</a>
230+
<ul class="blockList">
231+
<li class="blockList">
232+
<h4>addAuthToken</h4>
233+
<pre>public&nbsp;<a href="../../../com/andre601/javabotblockapi/BotBlockAPI.Builder.html" title="class in com.andre601.javabotblockapi">BotBlockAPI.Builder</a>&nbsp;addAuthToken(@NotNull
234+
@NotNull <a href="../../../com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi">Site</a>&nbsp;site,
235+
@NotNull
236+
@NotNull java.lang.String&nbsp;token)</pre>
237+
<div class="block">Adds the provided <a href="../../../com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi"><code>Site name</code></a> and token to the Map.
238+
<br>Entries with the same key will be overwritten.</div>
239+
<dl>
240+
<dt><span class="paramLabel">Parameters:</span></dt>
241+
<dd><code>site</code> - The <a href="../../../com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi"><code>Site</code></a> to get the name from.</dd>
242+
<dd><code>token</code> - The API token from the corresponding botlist. May not be null or empty.
243+
<br>You may receive the API token from the botlist.</dd>
244+
<dt><span class="returnLabel">Returns:</span></dt>
245+
<dd>The Builder after the site and token were set. Useful for chaining.</dd>
246+
<dt><span class="throwsLabel">Throws:</span></dt>
247+
<dd><code>java.lang.NullPointerException</code> - When the provided token is empty (<code>""</code>).</dd>
248+
<dt><span class="simpleTagLabel">Since:</span></dt>
249+
<dd>v2.1.0</dd>
250+
</dl>
251+
</li>
252+
</ul>
220253
<a name="addAuthToken-java.lang.String-java.lang.String-">
221254
<!-- -->
222255
</a>
@@ -233,8 +266,8 @@ <h4>addAuthToken</h4>
233266
<dt><span class="paramLabel">Parameters:</span></dt>
234267
<dd><code>site</code> - The name of the site. May not be null.
235268
<br>A list of supported sites can be found <a href="https://botblock.org/api/docs#count" target="_blank">here</a>.</dd>
236-
<dd><code>token</code> - The API token you get from the corresponding botlist. May not be null.
237-
<br>You may receive the API-token from your botlist.</dd>
269+
<dd><code>token</code> - The API token from the corresponding botlist. May not be null or empty.
270+
<br>You may receive the API token from the botlist.</dd>
238271
<dt><span class="returnLabel">Returns:</span></dt>
239272
<dd>The Builder after the site and token were set. Useful for chaining.</dd>
240273
<dt><span class="throwsLabel">Throws:</span></dt>

docs/com/andre601/javabotblockapi/BotBlockAPI.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Sat Jul 27 00:50:17 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 12:24:22 CEST 2019 -->
66
<title>BotBlockAPI (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-27">
7+
<meta name="date" content="2019-07-31">
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>

0 commit comments

Comments
 (0)