Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-10-18 00:05:03 +02:00
Code Issues Projects Releases Wiki Activity
a66b4d8104
Plan/docs/main/java/com/djrapitops/plan/api/API.html
Rsl1122 1df9eb1fd8 Javadocs about 50% complete.
2017-05-14 15:19:33 +03:00

652 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
<!-- Generated by javadoc (1.8.0_112) on Sun May 14 15:04:20 EEST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>API (Plan 3.1.1 API)</title>
<meta name="date" content="2017-05-14">
<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) {
parent.document.title="API (Plan 3.1.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
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="class-use/API.html">Use</a></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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../main/java/com/djrapitops/plan/api/Gender.html" title="enum in main.java.com.djrapitops.plan.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?main/java/com/djrapitops/plan/api/API.html" target="_top">Frames</a></li>
<li><a href="API.html" target="_top">No&nbsp;Frames</a></li>
</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>Field&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>Field&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">
<div class="subTitle">main.java.com.djrapitops.plan.api</div>
<h2 title="Class API" class="title">Class API</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>main.java.com.djrapitops.plan.api.API</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">API</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class contains the API methods.
Methods can be called from Asyncronous task and are thread safe unless
otherwise stated.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Rsl1122</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#API-main.java.com.djrapitops.plan.Plan-">API</a></span>(<a href="../../../../../../main/java/com/djrapitops/plan/Plan.html" title="class in main.java.com.djrapitops.plan">Plan</a>&nbsp;plugin)</code>
<div class="block">Class Construcor.</div>
</td>
</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">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#addPluginDataSource-main.java.com.djrapitops.plan.data.additional.PluginData-">addPluginDataSource</a></span>(<a href="../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html" title="class in main.java.com.djrapitops.plan.data.additional">PluginData</a>&nbsp;dataSource)</code>
<div class="block">Add a source of plugin data to the Plugins tab on Analysis and/or Inspect
page.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#cacheUserDataToInspectCache-java.util.UUID-">cacheUserDataToInspectCache</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</code>
<div class="block">Cache the UserData to InspectCache.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../main/java/com/djrapitops/plan/data/AnalysisData.html" title="class in main.java.com.djrapitops.plan.data">AnalysisData</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#getAnalysisDataFromCache--">getAnalysisDataFromCache</a></span>()</code>
<div class="block">Used to get the AnalysisData object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#getAnalysisHtmlAsString--">getAnalysisHtmlAsString</a></span>()</code>
<div class="block">Used to get the full Html of the Analysis page as a string.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#getPlayerHtmlAsString-java.util.UUID-">getPlayerHtmlAsString</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</code>
<div class="block">Used to get the full Html of the Inspect page as a string.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#getPlayerInspectPageLink-java.lang.String-">getPlayerInspectPageLink</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Used to get the link to InspectPage of a player.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#getPlayerName-java.util.UUID-">getPlayerName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</code>
<div class="block">Used to get the playerName of a player who has played on the server.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#isAnalysisCached--">isAnalysisCached</a></span>()</code>
<div class="block">Check if the Analysis has been run and is cached to the AnalysisCache.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#isEnabled--">isEnabled</a></span>()</code>
<div class="block">Check whether or not the plugin enabled successfully.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#isPlayersDataInspectCached-java.util.UUID-">isPlayersDataInspectCached</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</code>
<div class="block">Check if the UserData is cached to the InspectCache.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#placeDataToCache-main.java.com.djrapitops.plan.data.UserData-">placeDataToCache</a></span>(<a href="../../../../../../main/java/com/djrapitops/plan/data/UserData.html" title="class in main.java.com.djrapitops.plan.data">UserData</a>&nbsp;data)</code>
<div class="block">Used to cache a UserData object.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#playerNameToUUID-java.lang.String-">playerNameToUUID</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;playerName)</code>
<div class="block">Uses UUIDFetcher to turn PlayerName to UUID.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#saveCachedData--">saveCachedData</a></span>()</code>
<div class="block">Used to save the cached data to the database.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#scheduleEventHandlingInfo-main.java.com.djrapitops.plan.data.handling.info.HandlingInfo-">scheduleEventHandlingInfo</a></span>(<a href="../../../../../../main/java/com/djrapitops/plan/data/handling/info/HandlingInfo.html" title="class in main.java.com.djrapitops.plan.data.handling.info">HandlingInfo</a>&nbsp;info)</code>
<div class="block">Schedule a HandlingInfo object to be processed.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#scheduleForGet-java.util.UUID-main.java.com.djrapitops.plan.data.cache.DBCallableProcessor-">scheduleForGet</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid,
<a href="../../../../../../main/java/com/djrapitops/plan/data/cache/DBCallableProcessor.html" title="class in main.java.com.djrapitops.plan.data.cache">DBCallableProcessor</a>&nbsp;processor)</code>
<div class="block">Schedule a UserData object to be fetched from the database or cache if
the player is online.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/API.html#updateAnalysisCache--">updateAnalysisCache</a></span>()</code>
<div class="block">Run's the analysis with the current data in the cache and fetches rest from
the database.</div>
</td>
</tr>
</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.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="API-main.java.com.djrapitops.plan.Plan-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>API</h4>
<pre>public&nbsp;API(<a href="../../../../../../main/java/com/djrapitops/plan/Plan.html" title="class in main.java.com.djrapitops.plan">Plan</a>&nbsp;plugin)</pre>
<div class="block">Class Construcor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - Current instance of Plan</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isEnabled()</pre>
<div class="block">Check whether or not the plugin enabled successfully.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if plugin is enabled correctly.</dd>
</dl>
</li>
</ul>
<a name="addPluginDataSource-main.java.com.djrapitops.plan.data.additional.PluginData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPluginDataSource</h4>
<pre>public&nbsp;void&nbsp;addPluginDataSource(<a href="../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html" title="class in main.java.com.djrapitops.plan.data.additional">PluginData</a>&nbsp;dataSource)</pre>
<div class="block">Add a source of plugin data to the Plugins tab on Analysis and/or Inspect
page.
Refer to documentation on github or Javadoc of PluginData to set-up a
data source that extends PluginData correctly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataSource</code> - an object that extends PluginData-object, thus allowing
Analysis and Inspect to manage the data of a plugin correctly.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html" title="class in main.java.com.djrapitops.plan.data.additional"><code>PluginData</code></a></dd>
</dl>
</li>
</ul>
<a name="getPlayerInspectPageLink-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerInspectPageLink</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPlayerInspectPageLink(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Used to get the link to InspectPage of a player.
This method is useful if you have a table and want to link to the inspect
page.
Html.LINK.parse("Link", "Playername") can be used to get a link
<code>&lt;a href="Link"&gt;Playername&lt;/a&gt;</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Playername of the player</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ip:port/security/player/Playername</dd>
</dl>
</li>
</ul>
<a name="scheduleForGet-java.util.UUID-main.java.com.djrapitops.plan.data.cache.DBCallableProcessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleForGet</h4>
<pre>public&nbsp;void&nbsp;scheduleForGet(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid,
<a href="../../../../../../main/java/com/djrapitops/plan/data/cache/DBCallableProcessor.html" title="class in main.java.com.djrapitops.plan.data.cache">DBCallableProcessor</a>&nbsp;processor)</pre>
<div class="block">Schedule a UserData object to be fetched from the database or cache if
the player is online.
The data will not be cached if it is not already cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - UUID of the player.</dd>
<dd><code>processor</code> - Object implementing DBCallableProcessor, which
process(UserData data) method will be called.</dd>
</dl>
</li>
</ul>
<a name="scheduleEventHandlingInfo-main.java.com.djrapitops.plan.data.handling.info.HandlingInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleEventHandlingInfo</h4>
<pre>public&nbsp;void&nbsp;scheduleEventHandlingInfo(<a href="../../../../../../main/java/com/djrapitops/plan/data/handling/info/HandlingInfo.html" title="class in main.java.com.djrapitops.plan.data.handling.info">HandlingInfo</a>&nbsp;info)</pre>
<div class="block">Schedule a HandlingInfo object to be processed.
UserData associated with the UUID of the HandlingInfo object will be
cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>info</code> - object that extends HandlingInfo.</dd>
</dl>
</li>
</ul>
<a name="placeDataToCache-main.java.com.djrapitops.plan.data.UserData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>placeDataToCache</h4>
<pre>public&nbsp;void&nbsp;placeDataToCache(<a href="../../../../../../main/java/com/djrapitops/plan/data/UserData.html" title="class in main.java.com.djrapitops.plan.data">UserData</a>&nbsp;data)</pre>
<div class="block">Used to cache a UserData object.
If data is already cached it will be overridden.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - UserData object. Will be placed to the data.getUuid() key in
the cache.</dd>
</dl>
</li>
</ul>
<a name="saveCachedData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveCachedData</h4>
<pre>public&nbsp;void&nbsp;saveCachedData()</pre>
<div class="block">Used to save the cached data to the database.
Should be only called from an Asyncronous thread.</div>
</li>
</ul>
<a name="isPlayersDataInspectCached-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPlayersDataInspectCached</h4>
<pre>public&nbsp;boolean&nbsp;isPlayersDataInspectCached(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</pre>
<div class="block">Check if the UserData is cached to the InspectCache.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - UUID of the player.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true/false</dd>
</dl>
</li>
</ul>
<a name="cacheUserDataToInspectCache-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheUserDataToInspectCache</h4>
<pre>public&nbsp;void&nbsp;cacheUserDataToInspectCache(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</pre>
<div class="block">Cache the UserData to InspectCache.
Uses cache if data is cached or database if not. Call from an Asyncronous
thread.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - UUID of the player.</dd>
</dl>
</li>
</ul>
<a name="getPlayerHtmlAsString-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerHtmlAsString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPlayerHtmlAsString(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</pre>
<div class="block">Used to get the full Html of the Inspect page as a string.
Check if the data is cached to InspectCache before calling this.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - UUID of the player.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>player.html with all placeholders replaced.</dd>
</dl>
</li>
</ul>
<a name="isAnalysisCached--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAnalysisCached</h4>
<pre>public&nbsp;boolean&nbsp;isAnalysisCached()</pre>
<div class="block">Check if the Analysis has been run and is cached to the AnalysisCache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true/false</dd>
</dl>
</li>
</ul>
<a name="updateAnalysisCache--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAnalysisCache</h4>
<pre>public&nbsp;void&nbsp;updateAnalysisCache()</pre>
<div class="block">Run's the analysis with the current data in the cache and fetches rest from
the database.
Starts a new Asyncronous task to run the analysis.</div>
</li>
</ul>
<a name="getAnalysisHtmlAsString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAnalysisHtmlAsString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getAnalysisHtmlAsString()</pre>
<div class="block">Used to get the full Html of the Analysis page as a string.
Check if the data is cached to AnalysisCache before calling this.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>analysis.html with all placeholders replaced.</dd>
</dl>
</li>
</ul>
<a name="getAnalysisDataFromCache--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAnalysisDataFromCache</h4>
<pre>public&nbsp;<a href="../../../../../../main/java/com/djrapitops/plan/data/AnalysisData.html" title="class in main.java.com.djrapitops.plan.data">AnalysisData</a>&nbsp;getAnalysisDataFromCache()</pre>
<div class="block">Used to get the AnalysisData object.
Check if the data is cached to AnalysisCache before calling this.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>AnalysisData object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../main/java/com/djrapitops/plan/data/AnalysisData.html" title="class in main.java.com.djrapitops.plan.data"><code>AnalysisData</code></a></dd>
</dl>
</li>
</ul>
<a name="getPlayerName-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPlayerName(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre>
<div class="block">Used to get the playerName of a player who has played on the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - UUID of the player.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Playername, eg "Rsl1122"</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the player has not played on the server
before.</dd>
</dl>
</li>
</ul>
<a name="playerNameToUUID-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>playerNameToUUID</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;playerNameToUUID(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;playerName)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Uses UUIDFetcher to turn PlayerName to UUID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>playerName</code> - Player's name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>UUID of the Player</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if player's name is not registered at Mojang</dd>
</dl>
</li>
</ul>
</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="class-use/API.html">Use</a></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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../main/java/com/djrapitops/plan/api/Gender.html" title="enum in main.java.com.djrapitops.plan.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?main/java/com/djrapitops/plan/api/API.html" target="_top">Frames</a></li>
<li><a href="API.html" target="_top">No&nbsp;Frames</a></li>
</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>Field&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>Field&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink