Plan/all/com/djrapitops/plan/storage/database/DBSystem.html

533 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DBSystem (Plan 5.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DBSystem (Plan 5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.storage.database</a></div>
<h2 title="Class DBSystem" class="title">Class DBSystem</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.storage.database.DBSystem</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="BukkitDBSystem.html" title="class in com.djrapitops.plan.storage.database">BukkitDBSystem</a></code>, <code><a href="NukkitDBSystem.html" title="class in com.djrapitops.plan.storage.database">NukkitDBSystem</a></code>, <code><a href="ProxyDBSystem.html" title="class in com.djrapitops.plan.storage.database">ProxyDBSystem</a></code>, <code><a href="SpongeDBSystem.html" title="class in com.djrapitops.plan.storage.database">SpongeDBSystem</a></code></dd>
</dl>
<hr>
<pre>@Singleton
public class <span class="typeNameLabel">DBSystem</span>
extends java.lang.Object
implements <a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></pre>
<div class="block">System that holds the active databases.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Set&lt;<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#databases">databases</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#db">db</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#locale">locale</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected net.playeranalytics.plugin.server.PluginLogger</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logger">logger</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.djrapitops.plan.settings.locale.Locale,com.djrapitops.plan.storage.database.SQLiteDB.Factory,com.djrapitops.plan.storage.database.H2DB.Factory,net.playeranalytics.plugin.server.PluginLogger)">DBSystem</a></span>&#8203;(<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a>&nbsp;locale,
<a href="SQLiteDB.Factory.html" title="class in com.djrapitops.plan.storage.database">SQLiteDB.Factory</a>&nbsp;sqLiteDB,
<a href="H2DB.Factory.html" title="class in com.djrapitops.plan.storage.database">H2DB.Factory</a>&nbsp;h2Factory,
net.playeranalytics.plugin.server.PluginLogger&nbsp;logger)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disable()">disable</a></span>()</code></th>
<td class="colLast">
<div class="block">Performs disable actions for the subsystem</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enable()">enable</a></span>()</code></th>
<td class="colLast">
<div class="block">Performs enable actions for the subsystem.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActiveDatabaseByName(java.lang.String)">getActiveDatabaseByName</a></span>&#8203;(java.lang.String&nbsp;dbName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActiveDatabaseByType(com.djrapitops.plan.storage.database.DBType)">getActiveDatabaseByType</a></span>&#8203;(<a href="DBType.html" title="enum in com.djrapitops.plan.storage.database">DBType</a>&nbsp;type)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDatabase()">getDatabase</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDatabases()">getDatabases</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="H2DB.Factory.html" title="class in com.djrapitops.plan.storage.database">H2DB.Factory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getH2Factory()">getH2Factory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="SQLiteDB.Factory.html" title="class in com.djrapitops.plan.storage.database">SQLiteDB.Factory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSqLiteFactory()">getSqLiteFactory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setActiveDatabase(com.djrapitops.plan.storage.database.Database)">setActiveDatabase</a></span>&#8203;(<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&nbsp;db)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="locale">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locale</h4>
<pre>protected final&nbsp;<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a> locale</pre>
</li>
</ul>
<a id="logger">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logger</h4>
<pre>protected final&nbsp;net.playeranalytics.plugin.server.PluginLogger logger</pre>
</li>
</ul>
<a id="db">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>db</h4>
<pre>protected&nbsp;<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a> db</pre>
</li>
</ul>
<a id="databases">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>databases</h4>
<pre>protected final&nbsp;java.util.Set&lt;<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&gt; databases</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(com.djrapitops.plan.settings.locale.Locale,com.djrapitops.plan.storage.database.SQLiteDB.Factory,com.djrapitops.plan.storage.database.H2DB.Factory,net.playeranalytics.plugin.server.PluginLogger)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DBSystem</h4>
<pre>public&nbsp;DBSystem&#8203;(<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a>&nbsp;locale,
<a href="SQLiteDB.Factory.html" title="class in com.djrapitops.plan.storage.database">SQLiteDB.Factory</a>&nbsp;sqLiteDB,
<a href="H2DB.Factory.html" title="class in com.djrapitops.plan.storage.database">H2DB.Factory</a>&nbsp;h2Factory,
net.playeranalytics.plugin.server.PluginLogger&nbsp;logger)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getActiveDatabaseByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveDatabaseByName</h4>
<pre class="methodSignature">public&nbsp;<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&nbsp;getActiveDatabaseByName&#8203;(java.lang.String&nbsp;dbName)</pre>
</li>
</ul>
<a id="getActiveDatabaseByType(com.djrapitops.plan.storage.database.DBType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveDatabaseByType</h4>
<pre class="methodSignature">public&nbsp;<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&nbsp;getActiveDatabaseByType&#8203;(<a href="DBType.html" title="enum in com.djrapitops.plan.storage.database">DBType</a>&nbsp;type)</pre>
</li>
</ul>
<a id="getDatabases()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabases</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&gt;&nbsp;getDatabases()</pre>
</li>
</ul>
<a id="disable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disable</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;disable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../SubSystem.html#disable()">SubSystem</a></code></span></div>
<div class="block">Performs disable actions for the subsystem</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../SubSystem.html#disable()">disable</a></code>&nbsp;in interface&nbsp;<code><a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd>
</dl>
</li>
</ul>
<a id="getDatabase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabase</h4>
<pre class="methodSignature">public&nbsp;<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&nbsp;getDatabase()</pre>
</li>
</ul>
<a id="enable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enable</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;enable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../SubSystem.html#enable()">SubSystem</a></code></span></div>
<div class="block">Performs enable actions for the subsystem.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../SubSystem.html#enable()">enable</a></code>&nbsp;in interface&nbsp;<code><a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd>
</dl>
</li>
</ul>
<a id="setActiveDatabase(com.djrapitops.plan.storage.database.Database)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActiveDatabase</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setActiveDatabase&#8203;(<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a>&nbsp;db)</pre>
</li>
</ul>
<a id="getSqLiteFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSqLiteFactory</h4>
<pre class="methodSignature">public&nbsp;<a href="SQLiteDB.Factory.html" title="class in com.djrapitops.plan.storage.database">SQLiteDB.Factory</a>&nbsp;getSqLiteFactory()</pre>
</li>
</ul>
<a id="getH2Factory()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getH2Factory</h4>
<pre class="methodSignature">public&nbsp;<a href="H2DB.Factory.html" title="class in com.djrapitops.plan.storage.database">H2DB.Factory</a>&nbsp;getH2Factory()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>