Update Docs

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

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>All Classes and Interfaces</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@ -62,35 +62,58 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;<a href="io/github/simplexdevelopment/api/Context.html" title="type parameter in Context">S</a>&gt;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">This interface contains surface level methods for the <a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Represents a service that can be registered to a <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" 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;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<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>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">This class is used to represent a service exception.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" 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;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<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>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">This class is used to represent a service pool exception.</div>
</div>
</div>
</div>
</div>