Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-01 16:29:31 +01:00
Code Issues Projects Releases Wiki Activity
48c4b75b5c
Plan/all/com/djrapitops/plan/identification/Identifiers.html

382 lines
16 KiB
HTML
Raw Normal View History

Updated javadocs
2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
Updated javadocs
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>Identifiers (Plan 5.1-SNAPSHOT API)</title>
Updated javadocs
2019-08-05 11:13:19 +02:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
Updated javadocs
2020-03-21 15:43:05 +01:00
parent.document.title="Identifiers (Plan 5.1-SNAPSHOT API)";
Updated javadocs
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
Updated javadocs
2020-10-11 17:01:29 +02:00
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
Updated javadocs
2019-08-05 11:13:19 +02:00
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li><a href="../../../../com/djrapitops/plan/identification/BungeeServerInfo.html" title="class in com.djrapitops.plan.identification"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
Updated javadocs
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li><a href="../../../../index.html?com/djrapitops/plan/identification/Identifiers.html" target="_top">Frames</a></li>
<li><a href="Identifiers.html" target="_top">No&nbsp;Frames</a></li>
Updated javadocs
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
Updated javadocs
2019-10-05 10:27:37 +02:00
<div class="subTitle">com.djrapitops.plan.identification</div>
<h2 title="Class Identifiers" class="title">Class Identifiers</h2>
Updated javadocs
2019-08-05 11:13:19 +02:00
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li>com.djrapitops.plan.identification.Identifiers</li>
Updated javadocs
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>@Singleton
public class <span class="typeNameLabel">Identifiers</span>
extends java.lang.Object</pre>
<div class="block">Utility for getting server identifier from different sources.</div>
Updated javadocs
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colFirst"><code>protected <a href="../../../../com/djrapitops/plan/storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/identification/Identifiers.html#dbSystem">dbSystem</a></span></code>&nbsp;</td>
Updated javadocs
2019-08-05 11:13:19 +02:00
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
Updated javadocs
2020-03-21 15:43:05 +01:00
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/identification/Identifiers.html#Identifiers-com.djrapitops.plan.storage.database.DBSystem-com.djrapitops.plan.identification.UUIDUtility-">Identifiers</a></span>(<a href="../../../../com/djrapitops/plan/storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a>&nbsp;dbSystem,
<a href="../../../../com/djrapitops/plan/identification/UUIDUtility.html" title="class in com.djrapitops.plan.identification">UUIDUtility</a>&nbsp;uuidUtility)</code>&nbsp;</td>
Updated javadocs
2019-08-05 11:13:19 +02:00
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colFirst"><code>java.util.UUID</code></td>
Updated javadocs
2020-03-21 15:43:05 +01:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/identification/Identifiers.html#getPlayerUUID-com.djrapitops.plan.delivery.web.resolver.request.Request-">getPlayerUUID</a></span>(<a href="../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</code>
<div class="block">Obtain UUID of the player.</div>
</td>
Updated javadocs
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i1" class="rowColor">
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colFirst"><code>java.util.UUID</code></td>
Updated javadocs
2020-03-21 15:43:05 +01:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/identification/Identifiers.html#getPlayerUUID-java.lang.String-">getPlayerUUID</a></span>(java.lang.String&nbsp;name)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.UUID</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/identification/Identifiers.html#getServerUUID-com.djrapitops.plan.delivery.web.resolver.request.Request-">getServerUUID</a></span>(<a href="../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</code>
<div class="block">Obtain UUID of the server.</div>
</td>
Updated javadocs
2019-08-05 11:13:19 +02:00
</tr>
Updated javadocs
2020-10-11 17:01:29 +02:00
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Optional&lt;java.util.UUID&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/identification/Identifiers.html#getServerUUID-java.lang.String-">getServerUUID</a></span>(java.lang.String&nbsp;identifier)</code>
<div class="block">Obtain UUID of the server.</div>
</td>
</tr>
Updated javadocs
2019-08-05 11:13:19 +02:00
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="dbSystem">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<h4>dbSystem</h4>
<pre>protected final&nbsp;<a href="../../../../com/djrapitops/plan/storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a> dbSystem</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
Updated javadocs
2020-03-21 15:43:05 +01:00
<a name="Identifiers-com.djrapitops.plan.storage.database.DBSystem-com.djrapitops.plan.identification.UUIDUtility-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<h4>Identifiers</h4>
<pre>@Inject
Updated javadocs
2020-03-21 15:43:05 +01:00
public&nbsp;Identifiers(<a href="../../../../com/djrapitops/plan/storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a>&nbsp;dbSystem,
<a href="../../../../com/djrapitops/plan/identification/UUIDUtility.html" title="class in com.djrapitops.plan.identification">UUIDUtility</a>&nbsp;uuidUtility)</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
Updated javadocs
2020-03-21 15:43:05 +01:00
<a name="getServerUUID-com.djrapitops.plan.delivery.web.resolver.request.Request-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<h4>getServerUUID</h4>
Updated javadocs
2020-03-21 15:43:05 +01:00
<pre>public&nbsp;java.util.UUID&nbsp;getServerUUID(<a href="../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</pre>
<div class="block">Obtain UUID of the server.</div>
Updated javadocs
2019-08-05 11:13:19 +02:00
<dl>
Updated javadocs
2020-03-21 15:43:05 +01:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - for Request, URIQuery needs a 'server' parameter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>UUID of the server.</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dt><span class="throwsLabel">Throws:</span></dt>
Updated javadocs
2020-03-21 15:43:05 +01:00
<dd><code><a href="../../../../com/djrapitops/plan/delivery/web/resolver/exception/BadRequestException.html" title="class in com.djrapitops.plan.delivery.web.resolver.exception">BadRequestException</a></code> - If server parameter is not defined or the server is not in the database.</dd>
Updated javadocs
2019-08-05 11:13:19 +02:00
</dl>
</li>
</ul>
Updated javadocs
2020-10-11 17:01:29 +02:00
<a name="getServerUUID-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerUUID</h4>
<pre>public&nbsp;java.util.Optional&lt;java.util.UUID&gt;&nbsp;getServerUUID(java.lang.String&nbsp;identifier)</pre>
<div class="block">Obtain UUID of the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - Identifier (name or uuid string) of the server</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>UUID of the server.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/djrapitops/plan/delivery/web/resolver/exception/BadRequestException.html" title="class in com.djrapitops.plan.delivery.web.resolver.exception">BadRequestException</a></code> - If the server is not in the database.</dd>
</dl>
</li>
</ul>
Updated javadocs
2020-03-21 15:43:05 +01:00
<a name="getPlayerUUID-com.djrapitops.plan.delivery.web.resolver.request.Request-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
Updated javadocs
2020-03-21 15:43:05 +01:00
<ul class="blockList">
Updated javadocs
2019-08-05 11:13:19 +02:00
<li class="blockList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<h4>getPlayerUUID</h4>
Updated javadocs
2020-03-21 15:43:05 +01:00
<pre>public&nbsp;java.util.UUID&nbsp;getPlayerUUID(<a href="../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</pre>
<div class="block">Obtain UUID of the player.</div>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dl>
Updated javadocs
2020-03-21 15:43:05 +01:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - for Request, URIQuery needs a 'player' parameter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>UUID of the player.</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dt><span class="throwsLabel">Throws:</span></dt>
Updated javadocs
2020-03-21 15:43:05 +01:00
<dd><code><a href="../../../../com/djrapitops/plan/delivery/web/resolver/exception/BadRequestException.html" title="class in com.djrapitops.plan.delivery.web.resolver.exception">BadRequestException</a></code> - If player parameter is not defined or the player is not in the database.</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
</dl>
Updated javadocs
2019-08-05 11:13:19 +02:00
</li>
</ul>
Updated javadocs
2020-03-21 15:43:05 +01:00
<a name="getPlayerUUID-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPlayerUUID</h4>
<pre>public&nbsp;java.util.UUID&nbsp;getPlayerUUID(java.lang.String&nbsp;name)</pre>
</li>
</ul>
Updated javadocs
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li><a href="../../../../com/djrapitops/plan/identification/BungeeServerInfo.html" title="class in com.djrapitops.plan.identification"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
Updated javadocs
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li><a href="../../../../index.html?com/djrapitops/plan/identification/Identifiers.html" target="_top">Frames</a></li>
<li><a href="Identifiers.html" target="_top">No&nbsp;Frames</a></li>
Updated javadocs
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink