Plan/all/com/djrapitops/plan/query/QuerySvc.html

360 lines
31 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
<html lang="en">
2019-08-05 11:13:19 +02:00
<head>
<!-- Generated by javadoc (17) -->
<title>QuerySvc (Plan 5.4-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.djrapitops.plan.query, class: QuerySvc">
<meta name="generator" content="javadoc/ClassWriterImpl">
2019-08-05 11:13:19 +02:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
2019-08-05 11:13:19 +02:00
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
2019-08-05 11:13:19 +02:00
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
2019-08-05 11:13:19 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
2019-08-05 11:13:19 +02:00
<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#class">Help</a></li>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="sub-nav">
2019-08-05 11:13:19 +02:00
<div>
<ul class="sub-nav-list">
2019-08-05 11:13:19 +02:00
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
2019-08-05 11:13:19 +02:00
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="sub-nav-list">
2019-08-05 11:13:19 +02:00
<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>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
2019-08-05 11:13:19 +02:00
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.query</a></div>
<h1 title="Class QuerySvc" class="title">Class QuerySvc</h1>
2019-08-05 11:13:19 +02:00
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">com.djrapitops.plan.query.QuerySvc</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
2019-08-05 11:13:19 +02:00
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
2019-08-05 11:13:19 +02:00
</dl>
<hr>
<div class="type-signature"><span class="annotations">@Singleton
</span><span class="modifiers">public class </span><span class="element-name type-name-label">QuerySvc</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
2019-08-05 11:13:19 +02:00
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-com.djrapitops.plan.query.QueryService">Nested classes/interfaces inherited from interface&nbsp;com.djrapitops.plan.query.<a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></h2>
<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>&lt;<a href="QueryService.ThrowingConsumer.html" title="type parameter in QueryService.ThrowingConsumer">T</a>&gt;, <a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;<a href="QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">T</a>,<wbr><a href="QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">R</a>&gt;, <a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a></code></div>
</section>
2019-08-05 11:13:19 +02:00
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><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)" class="member-name-link">QuerySvc</a><wbr>(<a href="../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
<a href="../storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a>&nbsp;dbSystem,
<a href="../identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a>&nbsp;serverInfo,
<a href="../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dataCleared()" class="member-name-link">dataCleared</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a>&lt;?&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)" class="member-name-link">execute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sql,
<a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/PreparedStatement.html" title="class or interface in java.sql" class="external-link">PreparedStatement</a>&gt;&nbsp;performStatement)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
2019-08-05 11:13:19 +02:00
<div class="block">Execute SQL against Plan database.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCommonQueries()" class="member-name-link">getCommonQueries</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
2019-08-05 11:13:19 +02:00
<div class="block">Perform some commonly wanted queries.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDBType()" class="member-name-link">getDBType</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
2019-08-05 11:13:19 +02:00
<div class="block">Get what kind of database is in use.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServerUUID()" class="member-name-link">getServerUUID</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
2019-08-05 11:13:19 +02:00
<div class="block">Get the UUID of this server.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#playerRemoved(java.util.UUID)" class="member-name-link">playerRemoved</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&nbsp;playerUUID)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>&lt;T&gt;&nbsp;T</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)" class="member-name-link">query</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sql,
<a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/PreparedStatement.html" title="class or interface in java.sql" class="external-link">PreparedStatement</a>,<wbr>T&gt;&nbsp;performQuery)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
2019-08-05 11:13:19 +02:00
<div class="block">Perform a query against Plan database.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#register()" class="member-name-link">register</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)" class="member-name-link">subscribeDataClearEvent</a><wbr>(<a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a>&nbsp;eventListener)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
2019-08-05 11:13:19 +02:00
<div class="block">Used for getting notified about removal of ALL data.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subscribeToPlayerRemoveEvent(java.util.function.Consumer)" class="member-name-link">subscribeToPlayerRemoveEvent</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&gt;&nbsp;eventListener)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
2019-08-05 11:13:19 +02:00
<div class="block">Used for getting notified about removal of player data.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
2019-08-05 11:13:19 +02:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,com.djrapitops.plan.identification.ServerInfo,com.djrapitops.plan.utilities.logging.ErrorLogger)">
<h3>QuerySvc</h3>
<div class="member-signature"><span class="annotations">@Inject
</span><span class="modifiers">public</span>&nbsp;<span class="element-name">QuerySvc</span><wbr><span class="parameters">(<a href="../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
<a href="../storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a>&nbsp;dbSystem,
<a href="../identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a>&nbsp;serverInfo,
<a href="../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger)</span></div>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
</li>
2019-08-05 11:13:19 +02:00
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="register()">
<h3>register</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">register</span>()</div>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="getDBType()">
<h3>getDBType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getDBType</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="QueryService.html#getDBType()">QueryService</a></code></span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Get what kind of database is in use.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="QueryService.html#getDBType()">getDBType</a></code>&nbsp;in interface&nbsp;<code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
<dt>Returns:</dt>
<dd>SQLITE or MYSQL</dd>
2019-08-05 11:13:19 +02:00
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">
<h3>query</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type">T</span>&nbsp;<span class="element-name">query</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sql,
<a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/PreparedStatement.html" title="class or interface in java.sql" class="external-link">PreparedStatement</a>,<wbr>T&gt;&nbsp;performQuery)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="QueryService.html#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">QueryService</a></code></span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Perform a query against Plan database.
<p>
Blocks thread until query is complete.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="QueryService.html#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">query</a></code>&nbsp;in interface&nbsp;<code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
<dt>Type Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>T</code> - Type of results.</dd>
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<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>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>The object returned by <code>results</code>.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a>&lt;?&gt;</span>&nbsp;<span class="element-name">execute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sql,
<a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/PreparedStatement.html" title="class or interface in java.sql" class="external-link">PreparedStatement</a>&gt;&nbsp;performStatement)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="QueryService.html#execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">QueryService</a></code></span></div>
2019-08-05 11:13:19 +02:00
<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 class="notes">
<dt>Specified by:</dt>
<dd><code><a href="QueryService.html#execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<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>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>A Future that tells when the transaction has completed. Blocks thread if Future#get is called.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="subscribeToPlayerRemoveEvent(java.util.function.Consumer)">
<h3>subscribeToPlayerRemoveEvent</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">subscribeToPlayerRemoveEvent</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&gt;&nbsp;eventListener)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="QueryService.html#subscribeToPlayerRemoveEvent(java.util.function.Consumer)">QueryService</a></code></span></div>
2019-08-05 11:13:19 +02:00
<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 -&gt; { do stuff })</code></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="QueryService.html#subscribeToPlayerRemoveEvent(java.util.function.Consumer)">subscribeToPlayerRemoveEvent</a></code>&nbsp;in interface&nbsp;<code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>eventListener</code> - Functional interface that is called on the event.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">
<h3>subscribeDataClearEvent</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">subscribeDataClearEvent</span><wbr><span class="parameters">(<a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a>&nbsp;eventListener)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="QueryService.html#subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">QueryService</a></code></span></div>
2019-08-05 11:13:19 +02:00
<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(() -&gt; { do stuff })</code></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="QueryService.html#subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">subscribeDataClearEvent</a></code>&nbsp;in interface&nbsp;<code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>eventListener</code> - Functional interface that is called on the event.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="playerRemoved(java.util.UUID)">
<h3>playerRemoved</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">playerRemoved</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&nbsp;playerUUID)</span></div>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="dataCleared()">
<h3>dataCleared</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">dataCleared</span>()</div>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="getServerUUID()">
<h3>getServerUUID</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&gt;</span>&nbsp;<span class="element-name">getServerUUID</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="QueryService.html#getServerUUID()">QueryService</a></code></span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Get the UUID of this server.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="QueryService.html#getServerUUID()">getServerUUID</a></code>&nbsp;in interface&nbsp;<code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
<dt>Returns:</dt>
<dd>Optional of the server UUID, empty if server did not start properly.</dd>
2019-08-05 11:13:19 +02:00
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="getCommonQueries()">
<h3>getCommonQueries</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a></span>&nbsp;<span class="element-name">getCommonQueries</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="QueryService.html#getCommonQueries()">QueryService</a></code></span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Perform some commonly wanted queries.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="QueryService.html#getCommonQueries()">getCommonQueries</a></code>&nbsp;in interface&nbsp;<code><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></dd>
<dt>Returns:</dt>
<dd><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query"><code>CommonQueries</code></a> implementation.</dd>
2019-08-05 11:13:19 +02:00
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
</main>
2019-08-05 11:13:19 +02:00
</div>
</div>
</body>
</html>