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

153 lines
13 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>SubSystem (Plan 5.6-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.djrapitops.plan, interface: SubSystem">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan</a></div>
<h1 title="Interface SubSystem" class="title">Interface SubSystem</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<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>, <code><a href="delivery/webserver/http/WebServer.html" title="interface in com.djrapitops.plan.delivery.webserver.http">WebServer</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="delivery/webserver/auth/ActiveCookieStore.html" title="class in com.djrapitops.plan.delivery.webserver.auth">ActiveCookieStore</a></code>, <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="settings/FabricConfigSystem.html" title="class in com.djrapitops.plan.settings">FabricConfigSystem</a></code>, <code><a href="../../../net/playeranalytics/plan/storage/database/FabricDBSystem.html" title="class in net.playeranalytics.plan.storage.database">FabricDBSystem</a></code>, <code><a href="../../../net/playeranalytics/plan/gathering/listeners/FabricListenerSystem.html" title="class in net.playeranalytics.plan.gathering.listeners">FabricListenerSystem</a></code>, <code><a href="../../../net/playeranalytics/plan/version/FabricVersionChecker.html" title="class in net.playeranalytics.plan.version">FabricVersionChecker</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/http/JettyWebserver.html" title="class in com.djrapitops.plan.delivery.webserver.http">JettyWebserver</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="version/SpongeVersionChecker.html" title="class in com.djrapitops.plan.version">SpongeVersionChecker</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/WebServerSystem.html" title="class in com.djrapitops.plan.delivery.webserver">WebServerSystem</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SubSystem</span></div>
<div class="block">Represents a system that can be enabled and disabled.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#disable()" class="member-name-link">disable</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Performs disable actions for the subsystem</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#enable()" class="member-name-link">enable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Performs enable actions for the subsystem.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="enable()">
<h3>enable</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">enable</span>()</div>
<div class="block">Performs enable actions for the subsystem.</div>
<dl class="notes">
<dt>Throws:</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>
</section>
</li>
<li>
<section class="detail" id="disable()">
<h3>disable</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">disable</span>()</div>
<div class="block">Performs disable actions for the subsystem</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>