Plan/all/com/djrapitops/plan/SubSystem.html

281 lines
14 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SubSystem (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="SubSystem (Plan 5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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</a></div>
<h2 title="Interface SubSystem" class="title">Interface SubSystem</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="delivery/webserver/cache/JSONStorage.html" title="interface in com.djrapitops.plan.delivery.webserver.cache">JSONStorage</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="settings/BukkitConfigSystem.html" title="class in com.djrapitops.plan.settings">BukkitConfigSystem</a></code>, <code><a href="storage/database/BukkitDBSystem.html" title="class in com.djrapitops.plan.storage.database">BukkitDBSystem</a></code>, <code><a href="gathering/listeners/BukkitListenerSystem.html" title="class in com.djrapitops.plan.gathering.listeners">BukkitListenerSystem</a></code>, <code><a href="gathering/listeners/BungeeListenerSystem.html" title="class in com.djrapitops.plan.gathering.listeners">BungeeListenerSystem</a></code>, <code><a href="identification/BungeeServerInfo.html" title="class in com.djrapitops.plan.identification">BungeeServerInfo</a></code>, <code><a href="gathering/cache/CacheSystem.html" title="class in com.djrapitops.plan.gathering.cache">CacheSystem</a></code>, <code><a href="settings/ConfigSystem.html" title="class in com.djrapitops.plan.settings">ConfigSystem</a></code>, <code><a href="storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a></code>, <code><a href="delivery/export/ExportSystem.html" title="class in com.djrapitops.plan.delivery.export">ExportSystem</a></code>, <code><a href="gathering/geolocation/GeolocationCache.html" title="class in com.djrapitops.plan.gathering.geolocation">GeolocationCache</a></code>, <code><a href="gathering/importing/ImportSystem.html" title="class in com.djrapitops.plan.gathering.importing">ImportSystem</a></code>, <code><a href="delivery/webserver/cache/JSONFileStorage.html" title="class in com.djrapitops.plan.delivery.webserver.cache">JSONFileStorage</a></code>, <code><a href="delivery/webserver/cache/JSONMemoryStorageShim.html" title="class in com.djrapitops.plan.delivery.webserver.cache">JSONMemoryStorageShim</a></code>, <code><a href="gathering/listeners/ListenerSystem.html" title="class in com.djrapitops.plan.gathering.listeners">ListenerSystem</a></code>, <code><a href="settings/locale/LocaleSystem.html" title="class in com.djrapitops.plan.settings.locale">LocaleSystem</a></code>, <code><a href="settings/network/NetworkSettingManager.html" title="class in com.djrapitops.plan.settings.network">NetworkSettingManager</a></code>, <code><a href="gathering/cache/NicknameCache.html" title="class in com.djrapitops.plan.gathering.cache">NicknameCache</a></code>, <code><a href="settings/NukkitConfigSystem.html" title="class in com.djrapitops.plan.settings">NukkitConfigSystem</a></code>, <code><a href="storage/database/NukkitDBSystem.html" title="class in com.djrapitops.plan.storage.database">NukkitDBSystem</a></code>, <code><a href="gathering/listeners/NukkitListenerSystem.html" title="class in com.djrapitops.plan.gathering.listeners">NukkitListenerSystem</a></code>, <code><a href="storage/file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a></code>, <code><a href="PlanSystem.html" title="class in com.djrapitops.plan">PlanSystem</a></code>, <code><a href="processing/Processing.html" title="class in com.djrapitops.plan.processing">Processing</a></code>, <code><a href="settings/ProxyConfigSystem.html" title="class in com.djrapitops.plan.settings">ProxyConfigSystem</a></code>, <code><a href="storage/database/ProxyDBSystem.html" title="class in com.djrapitops.plan.storage.database">ProxyDBSystem</a></code>, <code><a href="identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a></code>, <code><a href="identification/ServerServerInfo.html" title="class in com.djrapitops.plan.identification">ServerServerInfo</a></code>, <code><a href="settings/network/ServerSettingsManager.html" title="class in com.djrapitops.plan.settings.network">ServerSettingsManager</a></code>, <code><a href="settings/SpongeConfigSystem.html" title="class in com.djrapitops.plan.settings">SpongeConfigSystem</a></code>, <code><a href="storage/database/SpongeDBSystem.html" title="class in com.djrapitops.plan.storage.database">SpongeDBSystem</a></code>, <code><a href="gathering/listeners/SpongeListenerSystem.html" title="class in com.djrapitops.plan.gathering.listeners">SpongeListenerSystem</a></code>, <code><a href="storage/file/SpongePlanFiles.html" title="class in com.djrapitops.plan.storage.file">SpongePlanFiles</a></code>, <code><a href="commands/TabCompleteCache.html" title="class in com.djrapitops.plan.commands">TabCompleteCache</a></code>, <code><a href="TaskSystem.html" title="class in com.djrapitops.plan">TaskSystem</a></code>, <code><a href="settings/theme/Theme.html" title="class in com.djrapitops.plan.settings.theme">Theme</a></code>, <code><a href="gathering/listeners/VelocityListenerSystem.html" title="class in com.djrapitops.plan.gathering.listeners">VelocityListenerSystem</a></code>, <code><a href="identification/VelocityServerInfo.html" title="class in com.djrapitops.plan.identification">VelocityServerInfo</a></code>, <code><a href="version/VersionChecker.html" title="class in com.djrapitops.plan.version">VersionChecker</a></code>, <code><a href="delivery/webserver/WebServer.html" title="class in com.djrapitops.plan.delivery.webserver">WebServer</a></code>, <code><a href="delivery/webserver/WebServerSystem.html" title="class in com.djrapitops.plan.delivery.webserver">WebServerSystem</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">SubSystem</span></pre>
<div class="block">Represents a system that can be enabled and disabled.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="enable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enable</h4>
<pre class="methodSignature">void&nbsp;enable()</pre>
<div class="block">Performs enable actions for the subsystem.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/EnableException.html" title="class in com.djrapitops.plan.exceptions">EnableException</a></code> - If an error occurred during enable and it is fatal to the subsystem.</dd>
</dl>
</li>
</ul>
<a id="disable()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>disable</h4>
<pre class="methodSignature">void&nbsp;disable()</pre>
<div class="block">Performs disable actions for the subsystem</div>
</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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>