mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-12-27 03:27:37 +01:00
558 lines
25 KiB
HTML
558 lines
25 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>QuerySvc (Plan 5.2-SNAPSHOT API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="QuerySvc (Plan 5.2-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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";
|
|
var pathtoroot = "../../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.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" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.djrapitops.plan.query</a></div>
|
|
<h2 title="Class QuerySvc" class="title">Class QuerySvc</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.djrapitops.plan.query.QuerySvc</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>@Singleton
|
|
public class <span class="typeNameLabel">QuerySvc</span>
|
|
extends java.lang.Object
|
|
implements <a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></pre>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="nested.class.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Nested Class Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="nested.classes.inherited.from.class.com.djrapitops.plan.query.QueryService">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Nested classes/interfaces inherited from interface com.djrapitops.plan.query.<a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></h3>
|
|
<code><a href="QueryService.Holder.html" title="class in com.djrapitops.plan.query">QueryService.Holder</a>, <a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a><<a href="QueryService.ThrowingConsumer.html" title="type parameter in QueryService.ThrowingConsumer">T</a>>, <a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a><<a href="QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">T</a>,​<a href="QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">R</a>>, <a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,com.djrapitops.plan.identification.ServerInfo,com.djrapitops.plan.utilities.logging.ErrorLogger)">QuerySvc</a></span>​(<a href="../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config,
|
|
<a href="../storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a> dbSystem,
|
|
<a href="../identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a> serverInfo,
|
|
<a href="../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dataCleared()">dataCleared</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>java.util.concurrent.Future<?></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">execute</a></span>​(java.lang.String sql,
|
|
<a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a><java.sql.PreparedStatement> performStatement)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Execute SQL against Plan database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommonQueries()">getCommonQueries</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Perform some commonly wanted queries.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDBType()">getDBType</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get what kind of database is in use.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>java.util.Optional<java.util.UUID></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServerUUID()">getServerUUID</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the UUID of this server.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#playerRemoved(java.util.UUID)">playerRemoved</a></span>​(java.util.UUID playerUUID)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><T> T</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">query</a></span>​(java.lang.String sql,
|
|
<a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a><java.sql.PreparedStatement,​T> performQuery)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Perform a query against Plan database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register()">register</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">subscribeDataClearEvent</a></span>​(<a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a> eventListener)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Used for getting notified about removal of ALL data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subscribeToPlayerRemoveEvent(java.util.function.Consumer)">subscribeToPlayerRemoveEvent</a></span>​(java.util.function.Consumer<java.util.UUID> eventListener)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Used for getting notified about removal of player data.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a id="<init>(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,com.djrapitops.plan.identification.ServerInfo,com.djrapitops.plan.utilities.logging.ErrorLogger)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>QuerySvc</h4>
|
|
<pre>@Inject
|
|
public QuerySvc​(<a href="../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config,
|
|
<a href="../storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a> dbSystem,
|
|
<a href="../identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a> serverInfo,
|
|
<a href="../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="register()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>register</h4>
|
|
<pre class="methodSignature">public void register()</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="getDBType()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDBType</h4>
|
|
<pre class="methodSignature">public java.lang.String getDBType()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="QueryService.html#getDBType()">QueryService</a></code></span></div>
|
|
<div class="block">Get what kind of database is in use.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="QueryService.html#getDBType()">getDBType</a></code> in interface <code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>H2, SQLITE or MYSQL</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>query</h4>
|
|
<pre class="methodSignature">public <T> T query​(java.lang.String sql,
|
|
<a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a><java.sql.PreparedStatement,​T> performQuery)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="QueryService.html#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">QueryService</a></code></span></div>
|
|
<div class="block">Perform a query against Plan database.
|
|
<p>
|
|
Blocks thread until query is complete.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="QueryService.html#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">query</a></code> in interface <code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
|
<dd><code>T</code> - Type of results.</dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sql</code> - SQL String to execute, can contain parameterized queries (<code>?</code>).</dd>
|
|
<dd><code>performQuery</code> - set your parameters to the PreparedStatement and execute the query, return results.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The object returned by <code>results</code>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre class="methodSignature">public java.util.concurrent.Future<?> execute​(java.lang.String sql,
|
|
<a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a><java.sql.PreparedStatement> performStatement)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="QueryService.html#execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">QueryService</a></code></span></div>
|
|
<div class="block">Execute SQL against Plan database.
|
|
<p>
|
|
Does not block thread, SQL is executed in a single transaction to the database.
|
|
<p>
|
|
Differs from <a href="QueryService.html#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)"><code>QueryService.query(String, ThrowingFunction)</code></a> in that no results are returned.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="QueryService.html#execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">execute</a></code> in interface <code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sql</code> - SQL String to execute, can contain parameterized queries (<code>?</code>).</dd>
|
|
<dd><code>performStatement</code> - set your parameters to the PreparedStatement and execute the statement.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A Future that tells when the transaction has completed. Blocks thread if Future#get is called.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="subscribeToPlayerRemoveEvent(java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>subscribeToPlayerRemoveEvent</h4>
|
|
<pre class="methodSignature">public void subscribeToPlayerRemoveEvent​(java.util.function.Consumer<java.util.UUID> eventListener)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="QueryService.html#subscribeToPlayerRemoveEvent(java.util.function.Consumer)">QueryService</a></code></span></div>
|
|
<div class="block">Used for getting notified about removal of player data.
|
|
<p>
|
|
SQL for removing this player's data should be executed when this occurs.
|
|
<p>
|
|
Example usage:
|
|
<code>subscribeToPlayerRemoveEvent(playerUUID -> { do stuff })</code></div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="QueryService.html#subscribeToPlayerRemoveEvent(java.util.function.Consumer)">subscribeToPlayerRemoveEvent</a></code> in interface <code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>eventListener</code> - Functional interface that is called on the event.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>subscribeDataClearEvent</h4>
|
|
<pre class="methodSignature">public void subscribeDataClearEvent​(<a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a> eventListener)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="QueryService.html#subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">QueryService</a></code></span></div>
|
|
<div class="block">Used for getting notified about removal of ALL data.
|
|
<p>
|
|
SQL for removing all extra tables (and data) should be performed
|
|
<p>
|
|
Example usage:
|
|
<code>subscribeDataClearEvent(() -> { do stuff })</code></div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="QueryService.html#subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">subscribeDataClearEvent</a></code> in interface <code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>eventListener</code> - Functional interface that is called on the event.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="playerRemoved(java.util.UUID)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>playerRemoved</h4>
|
|
<pre class="methodSignature">public void playerRemoved​(java.util.UUID playerUUID)</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="dataCleared()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>dataCleared</h4>
|
|
<pre class="methodSignature">public void dataCleared()</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="getServerUUID()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getServerUUID</h4>
|
|
<pre class="methodSignature">public java.util.Optional<java.util.UUID> getServerUUID()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="QueryService.html#getServerUUID()">QueryService</a></code></span></div>
|
|
<div class="block">Get the UUID of this server.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="QueryService.html#getServerUUID()">getServerUUID</a></code> in interface <code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Optinal of the server UUID, empty if server did not start properly.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCommonQueries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getCommonQueries</h4>
|
|
<pre class="methodSignature">public <a href="CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a> getCommonQueries()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="QueryService.html#getCommonQueries()">QueryService</a></code></span></div>
|
|
<div class="block">Perform some commonly wanted queries.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="QueryService.html#getCommonQueries()">getCommonQueries</a></code> in interface <code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query"><code>CommonQueries</code></a> implementation.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses.html">All 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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|