SimplexDevelopment/SimplexSS
1
0
Fork 0
mirror of https://github.com/SimplexDevelopment/SimplexSS.git synced 2025-07-02 15:16:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Docs

Browse Source
This commit is contained in:
Paldiu
2022-12-14 23:08:12 -06:00
parent 43070f9e2a
commit 43dee08554
85 changed files with 803 additions and 530 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/index-files/index-17.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
<title>S-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@ -69,25 +69,30 @@ loadScripts(document, 'script');</script>
<dt><a href="../io/github/simplexdevelopment/impl/Main.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">The bukkit scheduler.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
<dd>
<div class="block">The scheduler used to run the services in this pool.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a>&lt;<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin&gt; - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This class is used to manage the scheduling of <a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
and the creation of <a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#%3Cinit%3E(T)" class="member-name-link">SchedulingSystem(T)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
<dd>
<div class="block">Creates a new instance of the scheduling system.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#selectedPool" class="member-name-link">selectedPool</a> - Variable in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#service_name" class="member-name-link">service_name</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
<dd>
<div class="block">The name of the service.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServiceException</a> - Exception in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This class is used to represent a service exception.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html#%3Cinit%3E(io.github.simplexdevelopment.api.IService)" class="member-name-link">ServiceException(IService)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
<dd>
<div class="block">Constructs a new service exception which states the service is not present within any service pools.</div>
@ -103,13 +108,17 @@ loadScripts(document, 'script');</script>
<div class="block">The service manager to use for controlling service pools.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">The ServiceManager is a factory class for managing <a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#%3Cinit%3E()" class="member-name-link">ServiceManager()</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
<dd>
<div class="block">Creates a new instance of the Service Manager class.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#%3Cinit%3E(java.lang.String,boolean)" class="member-name-link">ServicePool(String, boolean)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
<dd>
<div class="block">This will create a new instance of a Service Pool with a <code>Scheduler</code> as its main scheduler.</div>
@ -118,10 +127,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">This will create a new instance of a Service Pool with the <a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> as its main scheduler.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#servicePoolCollection" class="member-name-link">servicePoolCollection</a> - Variable in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServicePoolException</a> - Exception in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This class is used to represent a service pool exception.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html#%3Cinit%3E()" class="member-name-link">ServicePoolException()</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
<dd>
<div class="block">Constructs a new generic service pool exception.</div>
@ -138,8 +147,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Cancels the execution of this service.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#setContext(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setContext(ServicePool)</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/api/Context.html#setContext(S)" class="member-name-link">setContext(S)</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/api/IService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setParentPool(ServicePool)</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
@ -154,8 +161,6 @@ loadScripts(document, 'script');</script>
</dd>
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#start()" class="member-name-link">start()</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#startServices()" class="member-name-link">startServices()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/api/IService.html#stop()" class="member-name-link">stop()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
<dd>
<div class="block">The actual end method for the service.</div>
@ -163,9 +168,13 @@ loadScripts(document, 'script');</script>
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#stop()" class="member-name-link">stop()</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#stopService(java.lang.String,reactor.core.publisher.Mono)" class="member-name-link">stopService(String, Mono&lt;Disposable&gt;)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This is the method used to stop a service.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices(Flux&lt;Disposable&gt;)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This method can be used to stop all the services registered with this pool.</div>
</dd>
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html#supplyException()" class="member-name-link">supplyException()</a> - Static method in exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html#supplyException(io.github.simplexdevelopment.api.IService)" class="member-name-link">supplyException(IService)</a> - Static method in exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>