2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< html lang = "fi" >
< head >
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
< title > SQLDB (Plan 5.1-SNAPSHOT API)< / title >
2019-10-05 10:27:37 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../stylesheet.css" title = "Style" >
< script type = "text/javascript" src = "../../../../../script.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) {
2020-03-21 15:43:05 +01:00
parent.document.title="SQLDB (Plan 5.1-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2020-10-11 17:01:29 +02:00
var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":6,"i11":10,"i12":6};
2019-08-05 11:13:19 +02:00
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../overview-summary.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 >
2019-10-05 10:27:37 +02:00
< 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 >
2019-08-05 11:13:19 +02:00
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/storage/database/SpongeDBSystem.html" title = "class in com.djrapitops.plan.storage.database" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLiteDB.html" title = "class in com.djrapitops.plan.storage.database" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../index.html?com/djrapitops/plan/storage/database/SQLDB.html" target = "_top" > Frames< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "SQLDB.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../allclasses-noframe.html" > All Classes< / a > < / 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 >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > < a href = "#field.summary" > Field< / a > | < / 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 > < a href = "#field.detail" > Field< / a > | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / 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" >
2019-10-05 10:27:37 +02:00
< div class = "subTitle" > com.djrapitops.plan.storage.database< / div >
2019-08-05 11:13:19 +02:00
< h2 title = "Class SQLDB" class = "title" > Class SQLDB< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html" title = "class in com.djrapitops.plan.storage.database" > com.djrapitops.plan.storage.database.AbstractDatabase< / a > < / li >
2019-08-05 11:13:19 +02:00
< li >
< ul class = "inheritance" >
2019-10-05 10:27:37 +02:00
< li > com.djrapitops.plan.storage.database.SQLDB< / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Implemented Interfaces:< / dt >
2019-10-05 10:27:37 +02:00
< dd > < a href = "../../../../../com/djrapitops/plan/storage/database/Database.html" title = "interface in com.djrapitops.plan.storage.database" > Database< / a > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< dl >
< dt > Direct Known Subclasses:< / dt >
2019-10-05 10:27:37 +02:00
< dd > < a href = "../../../../../com/djrapitops/plan/storage/database/H2DB.html" title = "class in com.djrapitops.plan.storage.database" > H2DB< / a > , < a href = "../../../../../com/djrapitops/plan/storage/database/MySQLDB.html" title = "class in com.djrapitops.plan.storage.database" > MySQLDB< / a > , < a href = "../../../../../com/djrapitops/plan/storage/database/SQLiteDB.html" title = "class in com.djrapitops.plan.storage.database" > SQLiteDB< / a > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< hr >
< br >
< pre > public abstract class < span class = "typeNameLabel" > SQLDB< / span >
2019-10-05 10:27:37 +02:00
extends < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html" title = "class in com.djrapitops.plan.storage.database" > AbstractDatabase< / a > < / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Class containing main logic for different data related save and load functionality.< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ======== NESTED CLASS SUMMARY ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "nested.class.summary" >
<!-- -->
< / a >
< h3 > Nested Class Summary< / h3 >
< ul class = "blockList" >
2019-10-05 10:27:37 +02:00
< li class = "blockList" > < a name = "nested.classes.inherited.from.class.com.djrapitops.plan.storage.database.Database" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
2019-10-05 10:27:37 +02:00
< h3 > Nested classes/interfaces inherited from interface com.djrapitops.plan.storage.database.< a href = "../../../../../com/djrapitops/plan/storage/database/Database.html" title = "interface in com.djrapitops.plan.storage.database" > Database< / a > < / h3 >
< code > < a href = "../../../../../com/djrapitops/plan/storage/database/Database.State.html" title = "enum in com.djrapitops.plan.storage.database" > Database.State< / a > < / code > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / li >
< / ul >
<!-- =========== FIELD SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "field.summary" >
<!-- -->
< / a >
< h3 > Field Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Field Summary table, listing fields, and an explanation" >
< caption > < span > Fields< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colLast" scope = "col" > Field and Description< / th >
< / tr >
< tr class = "altColor" >
2019-10-05 10:27:37 +02:00
< td class = "colFirst" > < code > protected < a href = "../../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#config" > config< / a > < / span > < / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr class = "rowColor" >
2020-06-21 19:24:04 +02:00
< td class = "colFirst" > < code > protected < a href = "../../../../../com/djrapitops/plan/utilities/logging/ErrorLogger.html" title = "class in com.djrapitops.plan.utilities.logging" > ErrorLogger< / a > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#errorLogger" > errorLogger< / a > < / span > < / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr class = "altColor" >
2019-10-05 10:27:37 +02:00
< td class = "colFirst" > < code > protected < a href = "../../../../../com/djrapitops/plan/settings/locale/Locale.html" title = "class in com.djrapitops.plan.settings.locale" > Locale< / a > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#locale" > locale< / a > < / span > < / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > protected com.djrapitops.plugin.logging.console.PluginLogger< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#logger" > logger< / a > < / span > < / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > protected com.djrapitops.plugin.task.RunnableFactory< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#runnableFactory" > runnableFactory< / a > < / span > < / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< / table >
< ul class = "blockList" >
2019-10-05 10:27:37 +02:00
< li class = "blockList" > < a name = "fields.inherited.from.class.com.djrapitops.plan.storage.database.AbstractDatabase" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
2019-10-05 10:27:37 +02:00
< h3 > Fields inherited from class com.djrapitops.plan.storage.database.< a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html" title = "class in com.djrapitops.plan.storage.database" > AbstractDatabase< / a > < / h3 >
< code > < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html#accessLock" > accessLock< / a > < / code > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / li >
< / ul >
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor.summary" >
<!-- -->
< / a >
< h3 > Constructor Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Constructor Summary table, listing constructors, and an explanation" >
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colOne" scope = "col" > Constructor and Description< / th >
< / tr >
< tr class = "altColor" >
2020-06-21 19:24:04 +02:00
< td class = "colOne" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#SQLDB-java.util.function.Supplier-com.djrapitops.plan.settings.locale.Locale-com.djrapitops.plan.settings.config.PlanConfig-com.djrapitops.plugin.task.RunnableFactory-com.djrapitops.plugin.logging.console.PluginLogger-com.djrapitops.plan.utilities.logging.ErrorLogger-" > SQLDB< / a > < / span > (java.util.function.Supplier< java.util.UUID> serverUUIDSupplier,
2019-10-05 10:27:37 +02:00
< a href = "../../../../../com/djrapitops/plan/settings/locale/Locale.html" title = "class in com.djrapitops.plan.settings.locale" > Locale< / a > locale,
< a href = "../../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > config,
2019-08-05 11:13:19 +02:00
com.djrapitops.plugin.task.RunnableFactory runnableFactory,
com.djrapitops.plugin.logging.console.PluginLogger logger,
2020-06-21 19:24:04 +02:00
< a href = "../../../../../com/djrapitops/plan/utilities/logging/ErrorLogger.html" title = "class in com.djrapitops.plan.utilities.logging" > ErrorLogger< / a > errorLogger)< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< / table >
< / li >
< / ul >
<!-- ========== METHOD SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.summary" >
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Method Summary table, listing methods, and an explanation" >
< caption > < span id = "t0" class = "activeTableTab" > < span > All Methods< / span > < span class = "tabEnd" > < / 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 > < 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 = "colLast" scope = "col" > Method and Description< / th >
< / tr >
< tr id = "i0" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#close--" > close< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#equals-java.lang.Object-" > equals< / a > < / span > (java.lang.Object o)< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i2" class = "altColor" >
< td class = "colFirst" > < code > java.util.concurrent.Future< ?> < / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#executeTransaction-com.djrapitops.plan.storage.database.transactions.Transaction-" > executeTransaction< / a > < / span > (< a href = "../../../../../com/djrapitops/plan/storage/database/transactions/Transaction.html" title = "class in com.djrapitops.plan.storage.database.transactions" > Transaction< / a > transaction)< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Execute an SQL Transaction.< / div >
< / td >
< / tr >
< tr id = "i3" class = "rowColor" >
< td class = "colFirst" > < code > abstract java.sql.Connection< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#getConnection--" > getConnection< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i4" class = "altColor" >
2020-10-11 17:01:29 +02:00
< td class = "colFirst" > < code > com.djrapitops.plugin.logging.console.PluginLogger< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#getLogger--" > getLogger< / a > < / span > ()< / code > < / td >
< / tr >
< tr id = "i5" class = "rowColor" >
< td class = "colFirst" > < code > com.djrapitops.plugin.task.RunnableFactory< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#getRunnableFactory--" > getRunnableFactory< / a > < / span > ()< / code > < / td >
< / tr >
< tr id = "i6" class = "altColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > java.util.function.Supplier< java.util.UUID> < / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#getServerUUIDSupplier--" > getServerUUIDSupplier< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
2020-10-11 17:01:29 +02:00
< tr id = "i7" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > int< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#hashCode--" > hashCode< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
2020-10-11 17:01:29 +02:00
< tr id = "i8" class = "altColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#init--" > init< / a > < / span > ()< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Initializes the Database.< / div >
< / td >
< / tr >
2020-10-11 17:01:29 +02:00
< tr id = "i9" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > < T> T< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#query-com.djrapitops.plan.storage.database.queries.Query-" > query< / a > < / span > (< a href = "../../../../../com/djrapitops/plan/storage/database/queries/Query.html" title = "interface in com.djrapitops.plan.storage.database.queries" > Query< / a > < T> query)< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Execute an SQL Query statement to get a result.< / div >
< / td >
< / tr >
2020-10-11 17:01:29 +02:00
< tr id = "i10" class = "altColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > abstract void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#returnToPool-java.sql.Connection-" > returnToPool< / a > < / span > (java.sql.Connection connection)< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
2020-10-11 17:01:29 +02:00
< tr id = "i11" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#setTransactionExecutorServiceProvider-java.util.function.Supplier-" > setTransactionExecutorServiceProvider< / a > < / span > (java.util.function.Supplier< java.util.concurrent.ExecutorService> transactionExecutorServiceProvider)< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
2020-10-11 17:01:29 +02:00
< tr id = "i12" class = "altColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > abstract void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLDB.html#setupDataSource--" > setupDataSource< / a > < / span > ()< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Set up the source for connections.< / div >
< / td >
< / tr >
< / table >
< ul class = "blockList" >
2019-10-05 10:27:37 +02:00
< li class = "blockList" > < a name = "methods.inherited.from.class.com.djrapitops.plan.storage.database.AbstractDatabase" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
2019-10-05 10:27:37 +02:00
< h3 > Methods inherited from class com.djrapitops.plan.storage.database.< a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html" title = "class in com.djrapitops.plan.storage.database" > AbstractDatabase< / a > < / h3 >
2020-10-11 17:01:29 +02:00
< code > < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html#assumeNoMoreHeavyLoad--" > assumeNoMoreHeavyLoad< / a > , < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html#getHeavyLoadDelayMs--" > getHeavyLoadDelayMs< / a > , < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html#getState--" > getState< / a > , < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html#increaseHeavyLoadDelay--" > increaseHeavyLoadDelay< / a > , < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html#isUnderHeavyLoad--" > isUnderHeavyLoad< / a > , < a href = "../../../../../com/djrapitops/plan/storage/database/AbstractDatabase.html#setState-com.djrapitops.plan.storage.database.Database.State-" > setState< / a > < / code > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< ul class = "blockList" >
< li class = "blockList" > < a name = "methods.inherited.from.class.java.lang.Object" >
<!-- -->
< / a >
< h3 > Methods inherited from class java.lang.Object< / h3 >
< code > clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait< / code > < / li >
< / ul >
< ul class = "blockList" >
2019-10-05 10:27:37 +02:00
< li class = "blockList" > < a name = "methods.inherited.from.class.com.djrapitops.plan.storage.database.Database" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
2019-10-05 10:27:37 +02:00
< h3 > Methods inherited from interface com.djrapitops.plan.storage.database.< a href = "../../../../../com/djrapitops/plan/storage/database/Database.html" title = "interface in com.djrapitops.plan.storage.database" > Database< / a > < / h3 >
< code > < a href = "../../../../../com/djrapitops/plan/storage/database/Database.html#getSql--" > getSql< / a > , < a href = "../../../../../com/djrapitops/plan/storage/database/Database.html#getType--" > getType< / a > < / code > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ FIELD DETAIL =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "field.detail" >
<!-- -->
< / a >
< h3 > Field Detail< / h3 >
< a name = "locale" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > locale< / h4 >
2019-10-05 10:27:37 +02:00
< pre > protected final < a href = "../../../../../com/djrapitops/plan/settings/locale/Locale.html" title = "class in com.djrapitops.plan.settings.locale" > Locale< / a > locale< / pre >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< a name = "config" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > config< / h4 >
2019-10-05 10:27:37 +02:00
< pre > protected final < a href = "../../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > config< / pre >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< a name = "runnableFactory" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > runnableFactory< / h4 >
< pre > protected final com.djrapitops.plugin.task.RunnableFactory runnableFactory< / pre >
< / li >
< / ul >
< a name = "logger" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > logger< / h4 >
< pre > protected final com.djrapitops.plugin.logging.console.PluginLogger logger< / pre >
< / li >
< / ul >
2020-06-21 19:24:04 +02:00
< a name = "errorLogger" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
2020-06-21 19:24:04 +02:00
< h4 > errorLogger< / h4 >
< pre > protected final < a href = "../../../../../com/djrapitops/plan/utilities/logging/ErrorLogger.html" title = "class in com.djrapitops.plan.utilities.logging" > ErrorLogger< / a > errorLogger< / pre >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / li >
< / ul >
<!-- ========= CONSTRUCTOR DETAIL ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor.detail" >
<!-- -->
< / a >
< h3 > Constructor Detail< / h3 >
2020-06-21 19:24:04 +02:00
< a name = "SQLDB-java.util.function.Supplier-com.djrapitops.plan.settings.locale.Locale-com.djrapitops.plan.settings.config.PlanConfig-com.djrapitops.plugin.task.RunnableFactory-com.djrapitops.plugin.logging.console.PluginLogger-com.djrapitops.plan.utilities.logging.ErrorLogger-" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > SQLDB< / h4 >
< pre > public SQLDB(java.util.function.Supplier< java.util.UUID> serverUUIDSupplier,
2019-10-05 10:27:37 +02:00
< a href = "../../../../../com/djrapitops/plan/settings/locale/Locale.html" title = "class in com.djrapitops.plan.settings.locale" > Locale< / a > locale,
< a href = "../../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > config,
2019-08-05 11:13:19 +02:00
com.djrapitops.plugin.task.RunnableFactory runnableFactory,
com.djrapitops.plugin.logging.console.PluginLogger logger,
2020-06-21 19:24:04 +02:00
< a href = "../../../../../com/djrapitops/plan/utilities/logging/ErrorLogger.html" title = "class in com.djrapitops.plan.utilities.logging" > ErrorLogger< / a > errorLogger)< / pre >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / li >
< / ul >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "init--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > init< / h4 >
< pre > public void init()< / pre >
2019-10-05 10:27:37 +02:00
< div class = "block" > < span class = "descfrmTypeLabel" > Description copied from interface: < code > < a href = "../../../../../com/djrapitops/plan/storage/database/Database.html#init--" > Database< / a > < / code > < / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Initializes the Database.
< p >
Queries can be performed after this request has completed all required transactions for the database operations.< / div >
< / li >
< / ul >
< a name = "setupDataSource--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > setupDataSource< / h4 >
< pre > public abstract void setupDataSource()< / pre >
< div class = "block" > Set up the source for connections.< / div >
< dl >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
2019-10-05 10:27:37 +02:00
< dd > < code > < a href = "../../../../../com/djrapitops/plan/exceptions/database/DBInitException.html" title = "class in com.djrapitops.plan.exceptions.database" > DBInitException< / a > < / code > - If the DataSource fails to be initialized.< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< / li >
< / ul >
< a name = "close--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > close< / h4 >
< pre > public void close()< / pre >
< / li >
< / ul >
< a name = "getConnection--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getConnection< / h4 >
< pre > public abstract java.sql.Connection getConnection()
throws java.sql.SQLException< / pre >
< dl >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.sql.SQLException< / code > < / dd >
< / dl >
< / li >
< / ul >
< a name = "returnToPool-java.sql.Connection-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > returnToPool< / h4 >
< pre > public abstract void returnToPool(java.sql.Connection connection)< / pre >
< / li >
< / ul >
2019-10-05 10:27:37 +02:00
< a name = "query-com.djrapitops.plan.storage.database.queries.Query-" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > query< / h4 >
2019-10-05 10:27:37 +02:00
< pre > public < T> T query(< a href = "../../../../../com/djrapitops/plan/storage/database/queries/Query.html" title = "interface in com.djrapitops.plan.storage.database.queries" > Query< / a > < T> query)< / pre >
< div class = "block" > < span class = "descfrmTypeLabel" > Description copied from interface: < code > < a href = "../../../../../com/djrapitops/plan/storage/database/Database.html#query-com.djrapitops.plan.storage.database.queries.Query-" > Database< / a > < / code > < / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Execute an SQL Query statement to get a result.
< p >
This method should only be called from an asynchronous thread.< / div >
< dl >
< dt > < span class = "paramLabel" > Type Parameters:< / span > < / dt >
< dd > < code > T< / code > - Type of the object to be returned.< / dd >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > query< / code > - QueryStatement to execute.< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Result of the query.< / dd >
< / dl >
< / li >
< / ul >
2019-10-05 10:27:37 +02:00
< a name = "executeTransaction-com.djrapitops.plan.storage.database.transactions.Transaction-" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > executeTransaction< / h4 >
2019-10-05 10:27:37 +02:00
< pre > public java.util.concurrent.Future< ?> executeTransaction(< a href = "../../../../../com/djrapitops/plan/storage/database/transactions/Transaction.html" title = "class in com.djrapitops.plan.storage.database.transactions" > Transaction< / a > transaction)< / pre >
< div class = "block" > < span class = "descfrmTypeLabel" > Description copied from interface: < code > < a href = "../../../../../com/djrapitops/plan/storage/database/Database.html#executeTransaction-com.djrapitops.plan.storage.database.transactions.Transaction-" > Database< / a > < / code > < / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Execute an SQL Transaction.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > transaction< / code > - Transaction to execute.< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Future that is finished when the transaction has been executed.< / dd >
< / dl >
< / li >
< / ul >
< a name = "equals-java.lang.Object-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > equals< / h4 >
< pre > public boolean equals(java.lang.Object o)< / pre >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Overrides:< / span > < / dt >
< dd > < code > equals< / code > in class < code > java.lang.Object< / code > < / dd >
< / dl >
< / li >
< / ul >
< a name = "hashCode--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > hashCode< / h4 >
< pre > public int hashCode()< / pre >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Overrides:< / span > < / dt >
< dd > < code > hashCode< / code > in class < code > java.lang.Object< / code > < / dd >
< / dl >
< / li >
< / ul >
< a name = "getServerUUIDSupplier--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getServerUUIDSupplier< / h4 >
< pre > public java.util.function.Supplier< java.util.UUID> getServerUUIDSupplier()< / pre >
< / li >
< / ul >
< a name = "setTransactionExecutorServiceProvider-java.util.function.Supplier-" >
<!-- -->
< / a >
2020-10-11 17:01:29 +02:00
< ul class = "blockList" >
2019-08-05 11:13:19 +02:00
< li class = "blockList" >
< h4 > setTransactionExecutorServiceProvider< / h4 >
< pre > public void setTransactionExecutorServiceProvider(java.util.function.Supplier< java.util.concurrent.ExecutorService> transactionExecutorServiceProvider)< / pre >
< / li >
< / ul >
2020-10-11 17:01:29 +02:00
< a name = "getRunnableFactory--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getRunnableFactory< / h4 >
< pre > public com.djrapitops.plugin.task.RunnableFactory getRunnableFactory()< / pre >
< / li >
< / ul >
< a name = "getLogger--" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > getLogger< / h4 >
< pre > public com.djrapitops.plugin.logging.console.PluginLogger getLogger()< / pre >
< / li >
< / ul >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< div class = "bottomNav" > < a name = "navbar.bottom" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a name = "navbar.bottom.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../overview-summary.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 >
2019-10-05 10:27:37 +02:00
< 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 >
2019-08-05 11:13:19 +02:00
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/storage/database/SpongeDBSystem.html" title = "class in com.djrapitops.plan.storage.database" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../../com/djrapitops/plan/storage/database/SQLiteDB.html" title = "class in com.djrapitops.plan.storage.database" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../index.html?com/djrapitops/plan/storage/database/SQLDB.html" target = "_top" > Frames< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "SQLDB.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../allclasses-noframe.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 >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > < a href = "#field.summary" > Field< / a > | < / 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 > < a href = "#field.detail" > Field< / a > | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip.navbar.bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
