2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
2021-03-10 09:12:21 +01:00
< html lang = "en" >
2019-08-05 11:13:19 +02:00
< head >
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
2021-06-12 09:24:49 +02:00
< title > QueryService (Plan 5.4-SNAPSHOT API)< / title >
2021-03-10 09:12:21 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../stylesheet.css" title = "Style" >
2021-03-10 09:12:21 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../jquery/jquery-ui.css" title = "Style" >
2019-08-05 11:13:19 +02:00
< script type = "text/javascript" src = "../../../../script.js" > < / script >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2021-06-12 09:24:49 +02:00
parent.document.title="QueryService (Plan 5.4-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2021-03-10 09:12:21 +01:00
var data = {"i0":6,"i1":6,"i2":6,"i3":1,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
2019-08-05 11:13:19 +02:00
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');< / script >
2019-08-05 11:13:19 +02:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-03-10 09:12:21 +01:00
< header role = "banner" >
< nav role = "navigation" >
< div class = "fixedNav" >
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< div class = "topNav" > < a id = "navbar.top" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.top.firstrow" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< 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 = "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" >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-08-05 11:13:19 +02:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > < a href = "#nested.class.summary" > Nested< / a > | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.top" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
2021-03-10 09:12:21 +01:00
< / div >
< div class = "navPadding" > < / div >
< script type = "text/javascript" > < ! - -
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
< / script >
< / nav >
< / header >
2019-08-05 11:13:19 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2021-03-10 09:12:21 +01:00
< main role = "main" >
2019-08-05 11:13:19 +02:00
< div class = "header" >
2021-03-10 09:12:21 +01:00
< div class = "subTitle" > < span class = "packageLabelInType" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.query< / a > < / div >
2019-08-05 11:13:19 +02:00
< h2 title = "Interface QueryService" class = "title" > Interface QueryService< / h2 >
< / div >
< div class = "contentContainer" >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Known Implementing Classes:< / dt >
2021-03-10 09:12:21 +01:00
< dd > < code > < a href = "QuerySvc.html" title = "class in com.djrapitops.plan.query" > QuerySvc< / a > < / code > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< hr >
< pre > public interface < span class = "typeNameLabel" > QueryService< / span > < / pre >
< div class = "block" > Service for Query API.
< p >
Requires Capability QUERY_API< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ======== NESTED CLASS SUMMARY ======== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "nested.class.summary" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Nested Class Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2019-08-05 11:13:19 +02:00
< caption > < span > Nested Classes< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Interface< / th >
< th class = "colLast" scope = "col" > Description< / th >
2019-08-05 11:13:19 +02:00
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > static class < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "QueryService.Holder.html" title = "class in com.djrapitops.plan.query" > QueryService.Holder< / a > < / span > < / code > < / th >
< td class = "colLast" > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > static interface < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < 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 > > < / span > < / code > < / th >
< td class = "colLast" >
2019-08-05 11:13:19 +02:00
< div class = "block" > See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > static interface < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < 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 > > < / span > < / code > < / th >
< td class = "colLast" >
2019-08-05 11:13:19 +02:00
< div class = "block" > See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > static interface < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "QueryService.VoidFunction.html" title = "interface in com.djrapitops.plan.query" > QueryService.VoidFunction< / a > < / span > < / code > < / th >
< td class = "colLast" >
2019-08-05 11:13:19 +02:00
< div class = "block" > See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.summary" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
< caption > < span id = "t0" class = "activeTableTab" > < span > All Methods< / span > < span class = "tabEnd" > < / span > < / span > < span id = "t1" class = "tableTab" > < span > < a href = "javascript:show(1);" > Static Methods< / a > < / 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 = "t3" class = "tableTab" > < span > < a href = "javascript:show(4);" > Abstract Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < / caption >
2019-08-05 11:13:19 +02:00
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Method< / th >
< th class = "colLast" scope = "col" > Description< / th >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i0" class = "altColor" >
< td class = "colFirst" > < code > java.util.concurrent.Future< ?> < / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Execute SQL against Plan database.< / div >
< / td >
< / tr >
< tr id = "i1" class = "rowColor" >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Perform some commonly wanted queries.< / div >
< / td >
< / tr >
< tr id = "i2" class = "altColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getDBType()" > getDBType< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get what kind of database is in use.< / div >
< / td >
< / tr >
< tr id = "i3" class = "rowColor" >
2021-03-10 09:12:21 +01:00
< td class = "colFirst" > < code > static < a href = "QueryService.html" title = "interface in com.djrapitops.plan.query" > QueryService< / a > < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getInstance()" > getInstance< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Obtain instance of QueryService.< / div >
< / td >
< / tr >
< tr id = "i4" class = "altColor" >
< td class = "colFirst" > < code > java.util.Optional< java.util.UUID> < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getServerUUID()" > getServerUUID< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get the UUID of this server.< / div >
< / td >
< / tr >
< tr id = "i5" class = "rowColor" >
< td class = "colFirst" > < code > < T> T< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Perform a query against Plan database.< / div >
< / td >
< / tr >
< tr id = "i6" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Used for getting notified about removal of ALL data.< / div >
< / td >
< / tr >
< tr id = "i7" class = "rowColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Used for getting notified about removal of player data.< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ METHOD DETAIL ========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.detail" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "getInstance()" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getInstance< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > static < a href = "QueryService.html" title = "interface in com.djrapitops.plan.query" > QueryService< / a > getInstance()< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Obtain instance of QueryService.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > QueryService implementation.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.NoClassDefFoundError< / code > - If Plan is not installed and this class can not be found or if older Plan version is installed.< / dd >
< dd > < code > java.lang.IllegalStateException< / code > - If Plan is installed, but not enabled.< / dd >
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getDBType()" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getDBType< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > java.lang.String getDBType()< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get what kind of database is in use.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
2021-06-12 09:24:49 +02:00
< dd > SQLITE or MYSQL< / dd >
2019-08-05 11:13:19 +02:00
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.IllegalStateException< / code > - If database has not been initialized (Plugin failed to enable)< / dd >
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > query< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < 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)
2019-08-05 11:13:19 +02:00
throws java.lang.IllegalStateException< / pre >
< div class = "block" > Perform a query against Plan database.
< p >
Blocks thread until query is complete.< / div >
< dl >
< 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 >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.IllegalStateException< / code > - If something goes wrong with the query. SQLException might be as cause.< / dd >
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > execute< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > 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)
2019-08-05 11:13:19 +02:00
throws java.lang.IllegalStateException< / pre >
< div class = "block" > Execute SQL against Plan database.
< p >
Does not block thread, SQL is executed in a single transaction to the database.
< p >
2021-03-10 09:12:21 +01:00
Differs from < a href = "#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)" > < code > query(String, ThrowingFunction)< / code > < / a > in that no results are returned.< / div >
2019-08-05 11:13:19 +02:00
< dl >
< 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 >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.IllegalStateException< / code > - If something goes wrong with the query. SQLException might be as cause.< / dd >
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "subscribeToPlayerRemoveEvent(java.util.function.Consumer)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > subscribeToPlayerRemoveEvent< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > void subscribeToPlayerRemoveEvent​ (java.util.function.Consumer< java.util.UUID> eventListener)< / pre >
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 -> { do stuff })< / code > < / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > eventListener< / code > - Functional interface that is called on the event.< / dd >
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > subscribeDataClearEvent< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > void subscribeDataClearEvent​ (< a href = "QueryService.VoidFunction.html" title = "interface in com.djrapitops.plan.query" > QueryService.VoidFunction< / a > eventListener)< / pre >
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(() -> { do stuff })< / code > < / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > eventListener< / code > - Functional interface that is called on the event.< / dd >
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getServerUUID()" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getServerUUID< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > java.util.Optional< java.util.UUID> getServerUUID()< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get the UUID of this server.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
2021-03-23 11:01:11 +01:00
< dd > Optional of the server UUID, empty if server did not start properly.< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getCommonQueries()" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > getCommonQueries< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < a href = "CommonQueries.html" title = "interface in com.djrapitops.plan.query" > CommonQueries< / a > getCommonQueries()< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Perform some commonly wanted queries.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
2021-03-10 09:12:21 +01:00
< 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
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.IllegalStateException< / code > - If database has not been initialized (Plugin failed to enable)< / dd >
< / dl >
< / li >
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / main >
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-03-10 09:12:21 +01:00
< footer role = "contentinfo" >
< nav role = "navigation" >
2019-08-05 11:13:19 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2021-03-10 09:12:21 +01:00
< div class = "bottomNav" > < a id = "navbar.bottom" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.bottom.firstrow" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< 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 = "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" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../allclasses.html" > All Classes< / a > < / li >
2019-08-05 11:13:19 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-08-05 11:13:19 +02:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > < a href = "#nested.class.summary" > Nested< / a > | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.bottom" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< / nav >
< / footer >
2019-08-05 11:13:19 +02:00
< / body >
< / html >
