Skip to content

Commit ea6b535

Browse files
committed
Updated JavaDoc for version 4.0.
1 parent 8bc3767 commit ea6b535

661 files changed

Lines changed: 2691 additions & 2759 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

allclasses-frame.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>All Classes (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>All Classes (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="script.js"></script>

allclasses-index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>All Classes (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>All Classes (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="script.js"></script>
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="All Classes (com.authlete:authlete-java-common 3.97 API)";
25+
parent.document.title="All Classes (com.authlete:authlete-java-common 4.0-SNAPSHOT API)";
2626
}
2727
}
2828
catch(err) {

allclasses-noframe.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>All Classes (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>All Classes (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="script.js"></script>

allpackages-index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>All Packages (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>All Packages (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="script.js"></script>
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="All Packages (com.authlete:authlete-java-common 3.97 API)";
25+
parent.document.title="All Packages (com.authlete:authlete-java-common 4.0-SNAPSHOT API)";
2626
}
2727
}
2828
catch(err) {

com/authlete/common/api/AccessRight.html

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>AccessRight (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>AccessRight (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="../../../../script.js"></script>
@@ -22,13 +22,13 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="AccessRight (com.authlete:authlete-java-common 3.97 API)";
25+
parent.document.title="AccessRight (com.authlete:authlete-java-common 4.0-SNAPSHOT API)";
2626
}
2727
}
2828
catch(err) {
2929
}
3030
//-->
31-
var data = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9};
31+
var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":9,"i7":9};
3232
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
3333
var altColor = "altColor";
3434
var rowColor = "rowColor";
@@ -301,43 +301,52 @@ <h3>Method Summary</h3>
301301
</td>
302302
</tr>
303303
<tr id="i1" class="rowColor">
304+
<td class="colFirst"><code>boolean</code></td>
305+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canDoAny(long,com.authlete.common.api.AccessRight)">canDoAny</a></span>&#8203;(long&nbsp;serviceId,
306+
<a href="AccessRight.html" title="enum in com.authlete.common.api">AccessRight</a>&nbsp;compare)</code></th>
307+
<td class="colLast">
308+
<div class="block">Return true if this access right has at least the amount of access of the
309+
compared access right on any object in the list.</div>
310+
</td>
311+
</tr>
312+
<tr id="i2" class="altColor">
304313
<td class="colFirst"><code>static <a href="AccessRight.html" title="enum in com.authlete.common.api">AccessRight</a></code></td>
305314
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromJson(java.lang.String)">fromJson</a></span>&#8203;(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
306315
<td class="colLast">
307316
<div class="block">Look up and fetch an access right value based on its
308317
(lowercased) name from a JSON object.</div>
309318
</td>
310319
</tr>
311-
<tr id="i2" class="altColor">
320+
<tr id="i3" class="rowColor">
312321
<td class="colFirst"><code>boolean</code></td>
313322
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClientSpecific()">isClientSpecific</a></span>()</code></th>
314323
<td class="colLast">
315324
<div class="block">Return true if this access right requires a specific service and client to be applied.</div>
316325
</td>
317326
</tr>
318-
<tr id="i3" class="rowColor">
327+
<tr id="i4" class="altColor">
319328
<td class="colFirst"><code>boolean</code></td>
320329
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isServiceSpecific()">isServiceSpecific</a></span>()</code></th>
321330
<td class="colLast">
322331
<div class="block">Return true if this access right requires a specific service to be applied.</div>
323332
</td>
324333
</tr>
325-
<tr id="i4" class="altColor">
334+
<tr id="i5" class="rowColor">
326335
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
327336
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toJson()">toJson</a></span>()</code></th>
328337
<td class="colLast">
329338
<div class="block">Return the name of this access right in lowercase form,
330339
appropriate for use in JSON objects (such as RAR object values).</div>
331340
</td>
332341
</tr>
333-
<tr id="i5" class="rowColor">
342+
<tr id="i6" class="altColor">
334343
<td class="colFirst"><code>static <a href="AccessRight.html" title="enum in com.authlete.common.api">AccessRight</a></code></td>
335344
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
336345
<td class="colLast">
337346
<div class="block">Returns the enum constant of this type with the specified name.</div>
338347
</td>
339348
</tr>
340-
<tr id="i6" class="altColor">
349+
<tr id="i7" class="rowColor">
341350
<td class="colFirst"><code>static <a href="AccessRight.html" title="enum in com.authlete.common.api">AccessRight</a>[]</code></td>
342351
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
343352
<td class="colLast">
@@ -590,6 +599,24 @@ <h4>canDo</h4>
590599
to function.</div>
591600
</li>
592601
</ul>
602+
<a id="canDoAny(long,com.authlete.common.api.AccessRight)">
603+
<!-- -->
604+
</a>
605+
<ul class="blockList">
606+
<li class="blockList">
607+
<h4>canDoAny</h4>
608+
<pre class="methodSignature">public&nbsp;boolean&nbsp;canDoAny&#8203;(long&nbsp;serviceId,
609+
<a href="AccessRight.html" title="enum in com.authlete.common.api">AccessRight</a>&nbsp;compare)</pre>
610+
<div class="block">Return true if this access right has at least the amount of access of the
611+
compared access right on any object in the list. If the access right is client
612+
specific, the serviceId is a required parameter. If the access right is
613+
service specific, this is true for all possible services regardless of value.</div>
614+
<dl>
615+
<dt><span class="simpleTagLabel">Since:</span></dt>
616+
<dd>3.99</dd>
617+
</dl>
618+
</li>
619+
</ul>
593620
<a id="fromJson(java.lang.String)">
594621
<!-- -->
595622
</a>

com/authlete/common/api/AuthleteApi.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>AuthleteApi (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>AuthleteApi (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="../../../../script.js"></script>
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="AuthleteApi (com.authlete:authlete-java-common 3.97 API)";
25+
parent.document.title="AuthleteApi (com.authlete:authlete-java-common 4.0-SNAPSHOT API)";
2626
}
2727
}
2828
catch(err) {
@@ -589,7 +589,7 @@ <h3>Method Summary</h3>
589589
</tr>
590590
<tr id="i57" class="rowColor">
591591
<td class="colFirst"><code><a href="../dto/TokenCreateBatchStatusResponse.html" title="class in com.authlete.common.dto">TokenCreateBatchStatusResponse</a></code></td>
592-
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTokenCreateBatchStatus(com.authlete.common.dto.TokenCreateBatchStatusRequest)">getTokenCreateBatchStatus</a></span>&#8203;(<a href="../dto/TokenCreateBatchStatusRequest.html" title="class in com.authlete.common.dto">TokenCreateBatchStatusRequest</a>&nbsp;request)</code></th>
592+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTokenCreateBatchStatus(java.lang.String)">getTokenCreateBatchStatus</a></span>&#8203;(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;requestId)</code></th>
593593
<td class="colLast">
594594
<div class="block">Call Authlete's <code>/auth/token/create/batch/status</code> API.</div>
595595
</td>
@@ -3477,18 +3477,18 @@ <h4>tokenCreateBatch</h4>
34773477
</dl>
34783478
</li>
34793479
</ul>
3480-
<a id="getTokenCreateBatchStatus(com.authlete.common.dto.TokenCreateBatchStatusRequest)">
3480+
<a id="getTokenCreateBatchStatus(java.lang.String)">
34813481
<!-- -->
34823482
</a>
34833483
<ul class="blockListLast">
34843484
<li class="blockList">
34853485
<h4>getTokenCreateBatchStatus</h4>
3486-
<pre class="methodSignature"><a href="../dto/TokenCreateBatchStatusResponse.html" title="class in com.authlete.common.dto">TokenCreateBatchStatusResponse</a>&nbsp;getTokenCreateBatchStatus&#8203;(<a href="../dto/TokenCreateBatchStatusRequest.html" title="class in com.authlete.common.dto">TokenCreateBatchStatusRequest</a>&nbsp;request)
3486+
<pre class="methodSignature"><a href="../dto/TokenCreateBatchStatusResponse.html" title="class in com.authlete.common.dto">TokenCreateBatchStatusResponse</a>&nbsp;getTokenCreateBatchStatus&#8203;(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;requestId)
34873487
throws <a href="AuthleteApiException.html" title="class in com.authlete.common.api">AuthleteApiException</a></pre>
34883488
<div class="block">Call Authlete's <code>/auth/token/create/batch/status</code> API.</div>
34893489
<dl>
34903490
<dt><span class="paramLabel">Parameters:</span></dt>
3491-
<dd><code>request</code> - Request parameters passed to the API.</dd>
3491+
<dd><code>requestId</code> - A request Id issued from <code>/auth/token/create/batch/status</code> API.</dd>
34923492
<dt><span class="returnLabel">Returns:</span></dt>
34933493
<dd>Response from the API.</dd>
34943494
<dt><span class="throwsLabel">Throws:</span></dt>

com/authlete/common/api/AuthleteApiException.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>AuthleteApiException (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>AuthleteApiException (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="../../../../script.js"></script>
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="AuthleteApiException (com.authlete:authlete-java-common 3.97 API)";
25+
parent.document.title="AuthleteApiException (com.authlete:authlete-java-common 4.0-SNAPSHOT API)";
2626
}
2727
}
2828
catch(err) {

com/authlete/common/api/AuthleteApiFactory.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>AuthleteApiFactory (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>AuthleteApiFactory (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="../../../../script.js"></script>
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="AuthleteApiFactory (com.authlete:authlete-java-common 3.97 API)";
25+
parent.document.title="AuthleteApiFactory (com.authlete:authlete-java-common 4.0-SNAPSHOT API)";
2626
}
2727
}
2828
catch(err) {

com/authlete/common/api/Settings.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>Settings (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>Settings (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="../../../../script.js"></script>
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="Settings (com.authlete:authlete-java-common 3.97 API)";
25+
parent.document.title="Settings (com.authlete:authlete-java-common 4.0-SNAPSHOT API)";
2626
}
2727
}
2828
catch(err) {

com/authlete/common/api/class-use/AccessRight.html

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.8) on Tue Apr 23 15:16:22 JST 2024 -->
6-
<title>Uses of Class com.authlete.common.api.AccessRight (com.authlete:authlete-java-common 3.97 API)</title>
5+
<!-- Generated by javadoc (11.0.8) on Tue May 14 15:58:54 JST 2024 -->
6+
<title>Uses of Class com.authlete.common.api.AccessRight (com.authlete:authlete-java-common 4.0-SNAPSHOT API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-04-23">
8+
<meta name="dc.created" content="2024-05-14">
99
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="../../../../../script.js"></script>
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="Uses of Class com.authlete.common.api.AccessRight (com.authlete:authlete-java-common 3.97 API)";
25+
parent.document.title="Uses of Class com.authlete.common.api.AccessRight (com.authlete:authlete-java-common 4.0-SNAPSHOT API)";
2626
}
2727
}
2828
catch(err) {
@@ -178,6 +178,15 @@ <h3>Uses of <a href="../AccessRight.html" title="enum in com.authlete.common.api
178178
compared access right.</div>
179179
</td>
180180
</tr>
181+
<tr class="rowColor">
182+
<td class="colFirst"><code>boolean</code></td>
183+
<th class="colSecond" scope="row"><span class="typeNameLabel">AccessRight.</span><code><span class="memberNameLink"><a href="../AccessRight.html#canDoAny(long,com.authlete.common.api.AccessRight)">canDoAny</a></span>&#8203;(long&nbsp;serviceId,
184+
<a href="../AccessRight.html" title="enum in com.authlete.common.api">AccessRight</a>&nbsp;compare)</code></th>
185+
<td class="colLast">
186+
<div class="block">Return true if this access right has at least the amount of access of the
187+
compared access right on any object in the list.</div>
188+
</td>
189+
</tr>
181190
</tbody>
182191
</table>
183192
</section>

0 commit comments

Comments
 (0)