mirror of
https://github.com/SimplexDevelopment/SimplexSS.git
synced 2025-07-01 06:36:41 +00:00
Update Docs
This commit is contained in:
Paldiu
@ -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"> </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><<a href="io/github/simplexdevelopment/api/Context.html" title="type parameter in Context">S</a>></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </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"> </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"> </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"> </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"> </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"> </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"> </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><<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin></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"> </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><<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </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"> </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"> </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"> </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"> </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"> </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>
|
||||
|
||||
@ -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 Packages</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>Constant Field Values</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>Deprecated List</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>API Help</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>A-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>L-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>M-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>N-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>O-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>P-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -65,15 +65,13 @@ loadScripts(document, 'script');</script>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#plugin" class="member-name-link">plugin</a> - Variable 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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#plugin" class="member-name-link">plugin</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> </dd>
|
||||
<dd>
|
||||
<div class="block">The plugin instance.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#plugin" class="member-name-link">plugin</a> - Variable in 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">The plugin to use for registering tasks.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">PoolHolder</a> - Class in <a href="../io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#%3Cinit%3E(io.github.simplexdevelopment.impl.Main)" class="member-name-link">PoolHolder(Main)</a> - Constructor for class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
|
||||
@ -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>Q-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -60,8 +60,16 @@ loadScripts(document, 'script');</script>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#queue(io.github.simplexdevelopment.api.IService)" class="member-name-link">queue(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#queueService(io.github.simplexdevelopment.api.IService)" class="member-name-link">queueService(IService)</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>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#queueAll()" class="member-name-link">queueAll()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#queueService(io.github.simplexdevelopment.api.IService)" class="member-name-link">queueService(IService)</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>
|
||||
<div class="block">This method is the actual method used to schedule a service.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#queueServices()" class="member-name-link">queueServices()</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>
|
||||
<div class="block">This method can be used to start all the services registered with this pool.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
|
||||
@ -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>R-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -55,15 +55,21 @@ loadScripts(document, 'script');</script>
|
||||
<h2 class="title" id="I:R">R</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#%3Cinit%3E(org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ReactorBukkitScheduler(JavaPlugin)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#recycle()" class="member-name-link">recycle()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/Main.html#registerServices(io.github.simplexdevelopment.impl.PoolHolder)" class="member-name-link">registerServices(PoolHolder)</a> - Method 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>
|
||||
<div class="block">This will clear the ServicePool of all services and return an empty pool.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/Main.html#registerServices(java.lang.String)" class="member-name-link">registerServices(String)</a> - Method 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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#removeService(io.github.simplexdevelopment.api.IService)" class="member-name-link">removeService(IService)</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> </dd>
|
||||
<dd>
|
||||
<div class="block">This method removes a service from the service pool set.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#repeating" class="member-name-link">repeating</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">If the service should be executed once or continuously.</div>
|
||||
|
||||
@ -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> </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> </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><<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </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> </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> </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> </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> </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> </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> </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> </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> </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> </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> </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> </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<Disposable>)</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> </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<Disposable>)</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> </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> </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>
|
||||
|
||||
@ -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>T-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>B-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -55,11 +55,15 @@ loadScripts(document, 'script');</script>
|
||||
<h2 class="title" id="I:B">B</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a> - Record Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html#%3Cinit%3E(org.bukkit.scheduler.BukkitTask)" class="member-name-link">BukkitDisposable(BukkitTask)</a> - Constructor for record class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates an instance of a <code>BukkitDisposable</code> record class.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#bukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin,io.github.simplexdevelopment.api.IService...)" class="member-name-link">bukkitServicePool(String, JavaPlugin, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
|
||||
@ -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>C-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -63,11 +63,11 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Whether the service has been cancelled or not.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Context.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Context</a><<a href="../io/github/simplexdevelopment/api/Context.html" title="type parameter in Context">S</a>> - Interface in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Context.html#contextCollection()" class="member-name-link">contextCollection()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#contextCollection()" class="member-name-link">contextCollection()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)" class="member-name-link">createServicePool(String, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#createWorker()" class="member-name-link">createWorker()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
|
||||
@ -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>D-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>E-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -54,6 +54,8 @@ loadScripts(document, 'script');</script>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a>
|
||||
<h2 class="title" id="I:E">E</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#emptyBukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">emptyBukkitServicePool(String, JavaPlugin)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#emptyServicePool(java.lang.String,boolean)" class="member-name-link">emptyServicePool(String, boolean)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
@ -61,7 +63,9 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Indicates whether some other object is "equal to" this one.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#%3Cinit%3E(java.lang.String)" class="member-name-link">ExecutableService(String)</a> - Constructor for 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">Creates a new instance of an executable service.</div>
|
||||
|
||||
@ -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>F-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>G-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -60,10 +60,6 @@ loadScripts(document, 'script');</script>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Context.html#getContext()" class="member-name-link">getContext()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#getContext()" class="member-name-link">getContext()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#getDefaultNamespacedKey()" class="member-name-link">getDefaultNamespacedKey()</a> - Static 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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html#getDelay()" class="member-name-link">getDelay()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#getDelay()" class="member-name-link">getDelay()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
@ -74,6 +70,8 @@ loadScripts(document, 'script');</script>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#getName()" class="member-name-link">getName()</a> - Method 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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#getName()" class="member-name-link">getName()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Identifier.html#getNumericalId()" class="member-name-link">getNumericalId()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html#getParentPool()" class="member-name-link">getParentPool()</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>
|
||||
@ -95,7 +93,9 @@ loadScripts(document, 'script');</script>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#getScheduler()" class="member-name-link">getScheduler()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#getService(java.lang.String)" class="member-name-link">getService(String)</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> </dd>
|
||||
<dd>
|
||||
<div class="block">Gets a service based on the name of the service defined by <a href="../io/github/simplexdevelopment/api/Identifier.html#getName()"><code>Identifier.getName()</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ISchedule.html#getServiceManager()" class="member-name-link">getServiceManager()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#getServiceManager()" class="member-name-link">getServiceManager()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
|
||||
@ -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>H-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>I-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -55,7 +55,9 @@ loadScripts(document, 'script');</script>
|
||||
<h2 class="title" id="I:I">I</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Identifier.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Identifier</a> - Interface in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a> - package io.github.simplexdevelopment.api</dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a> - package io.github.simplexdevelopment.impl</dt>
|
||||
@ -67,19 +69,25 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Cancels the execution of this service.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ISchedule.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">ISchedule</a> - Interface in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<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>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html#isDisposed()" class="member-name-link">isDisposed()</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Checks if the task is cancelled.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">IService</a> - Interface in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<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>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html#isPeriodic()" class="member-name-link">isPeriodic()</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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#isPeriodic()" class="member-name-link">isPeriodic()</a> - Method 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> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#isValidService(io.github.simplexdevelopment.api.IService)" class="member-name-link">isValidService(IService)</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> </dd>
|
||||
<dd>
|
||||
<div class="block">Checks to see if the defined service is present within this pool.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
|
||||
@ -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>Overview</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>Context</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -74,11 +74,12 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Known Implementing Classes:</dt>
|
||||
<dd><code><a href="../impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></code></dd>
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>S</code> - Any object type to wrap with this class.</dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Context<S></span></div>
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
|
||||
@ -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>ISchedule</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -79,6 +79,7 @@ loadScripts(document, 'script');</script>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISchedule</span></div>
|
||||
<div class="block">This interface contains surface level methods for the <a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
@ -145,7 +146,7 @@ loadScripts(document, 'script');</script>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to use to locate the associated service pool and queue the service for execution.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Disposable> that can be used to cancel the service.</dd>
|
||||
<dd>A Mono object that can be used to cancel the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@ -157,7 +158,7 @@ loadScripts(document, 'script');</script>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to run once.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@ -169,7 +170,7 @@ loadScripts(document, 'script');</script>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully stop.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@ -181,7 +182,7 @@ loadScripts(document, 'script');</script>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully start.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@ -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>IService</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -84,6 +84,10 @@ loadScripts(document, 'script');</script>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IService</span><span class="extends-implements">
|
||||
extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>, <a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></span></div>
|
||||
<div class="block">Represents a service that can be registered to a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.
|
||||
<p>
|
||||
This interface provides surface level methods to be used by the <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>
|
||||
associated to each service.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
|
||||
@ -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>Identifier</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -79,10 +79,11 @@ loadScripts(document, 'script');</script>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>All Known Implementing Classes:</dt>
|
||||
<dd><code><a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></code>, <code><a href="../impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></code></dd>
|
||||
<dd><code><a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></code>, <code><a href="../impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></code>, <code><a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Identifier</span></div>
|
||||
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
|
||||
@ -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>ServiceException</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -89,6 +89,9 @@ loadScripts(document, 'script');</script>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ServiceException</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></span></div>
|
||||
<div class="block">This class is used to represent a service exception.
|
||||
When a <a href="IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a> is called that has not been registered with a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>,
|
||||
this exception will be thrown.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
|
||||
@ -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>ServicePoolException</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -89,6 +89,10 @@ loadScripts(document, 'script');</script>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ServicePoolException</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></span></div>
|
||||
<div class="block">This class is used to represent a service pool exception.
|
||||
This exception is thrown when a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> is not found,
|
||||
when <a href="../scheduler/ServicePool.html#queueService(io.github.simplexdevelopment.api.IService)"><code>ServicePool.queueService(IService)</code></a> is called but the service is not registered with this pool,
|
||||
or if the service pool is empty and <a href="../scheduler/ServicePool.html#queueServices()"><code>ServicePool.queueServices()</code></a> is called.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
|
||||
@ -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>io.github.simplexdevelopment.api</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -75,17 +75,29 @@ 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 class-summary class-summary-tab1"><a href="Context.html" title="interface in io.github.simplexdevelopment.api">Context</a><S></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab1"> </div>
|
||||
<div class="col-last even-row-color class-summary class-summary-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 odd-row-color class-summary class-summary-tab1"><a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab1"> </div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-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 class-summary class-summary-tab1"><a href="ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab1"> </div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab1">
|
||||
<div class="block">This interface contains surface level methods for the <a href="../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 class-summary class-summary-tab1"><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab1"> </div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab1">
|
||||
<div class="block">Represents a service that can be registered to a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab5"> </div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab5">
|
||||
<div class="block">This class is used to represent a service exception.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab5"> </div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab5">
|
||||
<div class="block">This class is used to represent a service pool exception.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -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>io.github.simplexdevelopment.api Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>Main</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -142,7 +142,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onEnable()" class="member-name-link">onEnable</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerServices(io.github.simplexdevelopment.impl.PoolHolder)" class="member-name-link">registerServices</a><wbr>(@NotNull <a href="PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a> poolHolder)</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerServices(java.lang.String)" class="member-name-link">registerServices</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
</div>
|
||||
</div>
|
||||
@ -229,10 +229,9 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="registerServices(io.github.simplexdevelopment.impl.PoolHolder)">
|
||||
<section class="detail" id="registerServices(java.lang.String)">
|
||||
<h3>registerServices</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerServices</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <a href="PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a> poolHolder)</span></div>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerServices</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
|
||||
@ -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>ServiceImpl</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>io.github.simplexdevelopment.impl</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -71,10 +71,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2"> </div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2"> </div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2"> </div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@ -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>io.github.simplexdevelopment.impl Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -74,7 +74,6 @@ loadScripts(document, 'script');</script>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.impl.<a href="PoolHolder.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">PoolHolder</a> (implements io.github.simplexdevelopment.api.<a href="../api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a><S>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -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>BukkitDisposable</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -86,6 +86,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="type-signature"><span class="modifiers">public record </span><span class="element-name type-name-label">BukkitDisposable</span>(org.bukkit.scheduler.BukkitTask task)
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" title="class or interface in java.lang" class="external-link">Record</a>
|
||||
implements reactor.core.Disposable</span></div>
|
||||
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
|
||||
@ -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>ExecutableService</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -88,6 +88,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ExecutableService</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
||||
implements <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></span></div>
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
|
||||
@ -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>ReactorBukkitScheduler</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -84,6 +84,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ReactorBukkitScheduler</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
||||
implements reactor.core.scheduler.Scheduler, reactor.core.scheduler.Scheduler.Worker</span></div>
|
||||
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.
|
||||
This will allow us to perform non-blocking operations on the main server thread.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
@ -110,10 +112,14 @@ implements reactor.core.scheduler.Scheduler, reactor.core.scheduler.Scheduler.Wo
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>private final org.bukkit.plugin.java.JavaPlugin</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#plugin" class="member-name-link">plugin</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The plugin instance.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final org.bukkit.scheduler.BukkitScheduler</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#scheduler" class="member-name-link">scheduler</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The bukkit scheduler.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
@ -182,7 +188,7 @@ implements reactor.core.scheduler.Scheduler, reactor.core.scheduler.Scheduler.Wo
|
||||
<code>isDisposed</code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-reactor.core.scheduler.Scheduler">Methods inherited from interface reactor.core.scheduler.Scheduler</h3>
|
||||
<code>now, start</code></div>
|
||||
<code>disposeGracefully, now, start</code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@ -198,12 +204,14 @@ implements reactor.core.scheduler.Scheduler, reactor.core.scheduler.Scheduler.Wo
|
||||
<section class="detail" id="plugin">
|
||||
<h3>plugin</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.bukkit.plugin.java.JavaPlugin</span> <span class="element-name">plugin</span></div>
|
||||
<div class="block">The plugin instance.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="scheduler">
|
||||
<h3>scheduler</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.bukkit.scheduler.BukkitScheduler</span> <span class="element-name">scheduler</span></div>
|
||||
<div class="block">The bukkit scheduler.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -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>SchedulingSystem</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -77,6 +77,10 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>T</code> - Your plugin class, which extends <code>JavaPlugin</code>.</dd>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></code></dd>
|
||||
</dl>
|
||||
@ -84,6 +88,24 @@ loadScripts(document, 'script');</script>
|
||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">SchedulingSystem<T extends org.bukkit.plugin.java.JavaPlugin></span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
||||
implements <a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></span></div>
|
||||
<div class="block">This class is used to manage the scheduling of <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
||||
and the creation of <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.
|
||||
The <a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a> should be used to create new <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s on
|
||||
initialization of your plugin, and your <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s should be registered in the
|
||||
<code>JavaPlugin.onEnable()</code> method. You can then use the <a href="#queue(io.github.simplexdevelopment.api.IService)"><code>queue(IService)</code></a> method
|
||||
to then queue up your services, or call <a href="#queueAll()"><code>queueAll()</code></a> to queue up all services in every pool.
|
||||
<a href="#forceStart(io.github.simplexdevelopment.api.IService)"><code>forceStart(IService)</code></a> and <a href="#forceStop(io.github.simplexdevelopment.api.IService)"><code>forceStop(IService)</code></a> will forcefully start and stop the services, respectively.
|
||||
<a href="#getMainScheduler()"><code>getMainScheduler()</code></a> gets the main scheduler for the scheduling system, which is a <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> object.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a></li>
|
||||
<li><a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a></li>
|
||||
<li><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
@ -165,9 +187,12 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Queues a service to be executed in a service pool.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Flux<reactor.core.Disposable></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueAll()" class="member-name-link">queueAll</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@ -268,11 +293,17 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to use to locate the associated service pool and queue the service for execution.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Disposable> that can be used to cancel the service.</dd>
|
||||
<dd>A Mono object that can be used to cancel the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="queueAll()">
|
||||
<h3>queueAll</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Flux<reactor.core.Disposable></span> <span class="element-name">queueAll</span>()</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="runOnce(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>runOnce</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
@ -283,7 +314,7 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to run once.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@ -297,7 +328,7 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully stop.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@ -311,7 +342,7 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully start.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@ -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>ServiceManager</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -79,6 +79,11 @@ loadScripts(document, 'script');</script>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ServiceManager</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">The ServiceManager is a factory class for managing <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.
|
||||
You can use this class for easy creation of <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s,
|
||||
as well as adding and removing <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s from the pool. You can create an
|
||||
<a href="#emptyServicePool(java.lang.String,boolean)"><code>emptyServicePool(String, boolean)</code></a>, <a href="#createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)"><code>createServicePool(String, IService...)</code></a>,
|
||||
and even create a <a href="#multithreadedServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)"><code>multithreadedServicePool(String, IService...)</code></a>.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
@ -130,10 +135,19 @@ loadScripts(document, 'script');</script>
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)" class="member-name-link">createServicePool</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName,
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#bukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin,io.github.simplexdevelopment.api.IService...)" class="member-name-link">bukkitServicePool</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)" class="member-name-link">createServicePool</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#emptyBukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">emptyBukkitServicePool</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#emptyServicePool(java.lang.String,boolean)" class="member-name-link">emptyServicePool</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName,
|
||||
boolean multithreaded)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
@ -224,6 +238,44 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="emptyBukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin)">
|
||||
<h3>emptyBukkitServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true,
|
||||
value="_, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">emptyBukkitServicePool</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>poolName</code> - The name of the service pool.</dd>
|
||||
<dd><code>plugin</code> - The plugin which will be used to register the service pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element.
|
||||
This Service Pool will execute each service within the main server thread.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="bukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin,io.github.simplexdevelopment.api.IService...)">
|
||||
<h3>bukkitServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true,
|
||||
value="_, _, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">bukkitServicePool</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> poolName,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>poolName</code> - The name of the service pool.</dd>
|
||||
<dd><code>plugin</code> - The plugin which will be used to register the service pool.</dd>
|
||||
<dd><code>services</code> - The services to register within the service pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element.
|
||||
This Service Pool will execute each service within the main server thread.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="multithreadedServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)">
|
||||
<h3>multithreadedServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true,
|
||||
|
||||
@ -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>ServicePool</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -76,9 +76,27 @@ loadScripts(document, 'script');</script>
|
||||
<div class="inheritance">io.github.simplexdevelopment.scheduler.ServicePool</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ServicePool</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
||||
implements <a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></span></div>
|
||||
<div class="block">A service pool is a collection of services which are managed by a single scheduler.
|
||||
The scheduler can either be an instance of <code>Scheduler</code> or <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a>.
|
||||
Using <code>Scheduler</code> allows for more flexibility, but doesn't communicate with the Main thread.
|
||||
Using <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> allows for communication with the Main thread, but is less flexible.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a></li>
|
||||
<li><code>Scheduler</code></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
@ -140,7 +158,7 @@ loadScripts(document, 'script');</script>
|
||||
<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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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>
|
||||
@ -152,43 +170,62 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAssociatedServices()" class="member-name-link">getAssociatedServices</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDefaultNamespacedKey()" class="member-name-link">getDefaultNamespacedKey</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.scheduler.Scheduler</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheduler()" class="member-name-link">getScheduler</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getService(java.lang.String)" class="member-name-link">getService</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> service_name)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets a service based on the name of the service defined by <a href="../api/Identifier.html#getName()"><code>Identifier.getName()</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) boolean</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isValidService(io.github.simplexdevelopment.api.IService)" class="member-name-link">isValidService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Checks to see if the defined service is present within this pool.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<reactor.core.Disposable></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueService(io.github.simplexdevelopment.api.IService)" class="member-name-link">queueService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recycle()" class="member-name-link">recycle</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeService(io.github.simplexdevelopment.api.IService)" class="member-name-link">removeService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This method is the actual method used to schedule a service.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Flux<reactor.core.Disposable></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startServices()" class="member-name-link">startServices</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueServices()" class="member-name-link">queueServices</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This method can be used to start all the services registered with this pool.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recycle()" class="member-name-link">recycle</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This will clear the ServicePool of all services and return an empty pool.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeService(io.github.simplexdevelopment.api.IService)" class="member-name-link">removeService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This method removes a service from the service pool set.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopService(java.lang.String,reactor.core.publisher.Mono)" class="member-name-link">stopService</a><wbr>(@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> service_name,
|
||||
@Nullable reactor.core.publisher.Mono<reactor.core.Disposable> disposable)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This is the method used to stop a service.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices</a><wbr>(@NotNull reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This method can be used to stop all the services registered with this pool.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-io.github.simplexdevelopment.api.Identifier">Methods inherited from interface io.github.simplexdevelopment.api.<a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></h3>
|
||||
<code><a href="../api/Identifier.html#getNumericalId()">getNumericalId</a>, <a href="../api/Identifier.html#getUniqueId()">getUniqueId</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@ -280,16 +317,6 @@ loadScripts(document, 'script');</script>
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="getDefaultNamespacedKey()">
|
||||
<h3>getDefaultNamespacedKey</h3>
|
||||
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDefaultNamespacedKey</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The default namespaced key to use if one is not assigned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="addService(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>addService</h3>
|
||||
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">addService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
@ -303,6 +330,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="isValidService(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>isValidService</h3>
|
||||
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isValidService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<div class="block">Checks to see if the defined service is present within this pool.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to check against this pool.</dd>
|
||||
@ -328,6 +356,10 @@ loadScripts(document, 'script');</script>
|
||||
<h3>queueService</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<reactor.core.Disposable></span> <span class="element-name">queueService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<div class="block">This method is the actual method used to schedule a service.
|
||||
This will register the service with the scheduler, and then return a <code>Disposable</code> object
|
||||
encapsulated within a <code>Mono</code>. If <a href="../api/IService.html#isPeriodic()"><code>IService.isPeriodic()</code></a> returns true, then the service
|
||||
will be scheduled to run periodically. Otherwise, it will be scheduled to run once.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The name of the service to queue. This should be a service that is located within this service pool.
|
||||
@ -339,10 +371,12 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="startServices()">
|
||||
<h3>startServices</h3>
|
||||
<section class="detail" id="queueServices()">
|
||||
<h3>queueServices</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Flux<reactor.core.Disposable></span> <span class="element-name">startServices</span>()</div>
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Flux<reactor.core.Disposable></span> <span class="element-name">queueServices</span>()</div>
|
||||
<div class="block">This method can be used to start all the services registered with this pool.
|
||||
If there are no services, this will do nothing.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Flux</code> object which contains a collection of <code>Disposable</code> elements,
|
||||
@ -356,6 +390,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">stopServices</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)</span></div>
|
||||
<div class="block">This method can be used to stop all the services registered with this pool.
|
||||
If there are no services, this will do nothing.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>disposableThread</code> - A <code>reactor.core.publisher.Flux<reactor.core.Disposable></code> which contains all the services that should be disposed..</dd>
|
||||
@ -372,6 +408,9 @@ loadScripts(document, 'script');</script>
|
||||
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> service_name,
|
||||
@Nullable
|
||||
@Nullable reactor.core.publisher.Mono<reactor.core.Disposable> disposable)</span></div>
|
||||
<div class="block">This is the method used to stop a service. This will call the relative <code>Disposable.dispose()</code> method
|
||||
to the <code>Scheduler</code> supplied for this pool. If you are using the <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a>,
|
||||
this will cancel the task upstream on the <code>BukkitScheduler</code>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service_name</code> - The name of the service to stop.</dd>
|
||||
@ -386,6 +425,8 @@ loadScripts(document, 'script');</script>
|
||||
<h3>getService</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>></span> <span class="element-name">getService</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> service_name)</span></div>
|
||||
<div class="block">Gets a service based on the name of the service defined by <a href="../api/Identifier.html#getName()"><code>Identifier.getName()</code></a>.
|
||||
This will search the service pool for a service with the same name, and return it.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service_name</code> - The name of the service to get.</dd>
|
||||
@ -398,6 +439,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="removeService(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>removeService</h3>
|
||||
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<div class="block">This method removes a service from the service pool set.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to remove from the pool's service collection.</dd>
|
||||
@ -409,6 +451,7 @@ loadScripts(document, 'script');</script>
|
||||
<h3>recycle</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">recycle</span>()</div>
|
||||
<div class="block">This will clear the ServicePool of all services and return an empty pool.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>This service pool after being cleared of all services.
|
||||
@ -427,6 +470,18 @@ loadScripts(document, 'script');</script>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getName()">
|
||||
<h3>getName</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getName</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/Identifier.html#getName()">getName</a></code> in interface <code><a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The name of the identifiable object in a readable format.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@ -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>io.github.simplexdevelopment.scheduler</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -75,17 +75,30 @@ 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 class-summary class-summary-tab4"><a href="BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab4"> </div>
|
||||
<div class="col-last even-row-color class-summary class-summary-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 class-summary class-summary-tab2"><a href="ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2"> </div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2"> </div>
|
||||
<div class="col-last even-row-color class-summary class-summary-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 odd-row-color class-summary class-summary-tab2"><a href="SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><T extends org.bukkit.plugin.java.JavaPlugin></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2"> </div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">This class is used to manage the scheduling of <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
||||
and the creation of <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2"> </div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">The ServiceManager is a factory class for managing <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2"> </div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -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>io.github.simplexdevelopment.scheduler Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -69,7 +69,7 @@ loadScripts(document, 'script');</script>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="SchedulingSystem.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><T> (implements io.github.simplexdevelopment.api.<a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a>)</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="ServiceManager.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> (implements io.github.simplexdevelopment.api.<a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -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>Generated Documentation (Untitled)</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -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>Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -76,7 +76,6 @@ loadScripts(document, 'script');</script>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/PoolHolder.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">PoolHolder</a> (implements io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a><S>)</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a> (implements reactor.core.scheduler.Scheduler, reactor.core.scheduler.Scheduler.Worker)</li>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" class="type-name-link external-link" title="class or interface in java.lang">Record</a>
|
||||
<ul>
|
||||
@ -85,7 +84,7 @@ loadScripts(document, 'script');</script>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><T> (implements io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a>)</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> (implements io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a>)</li>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" class="type-name-link external-link" title="class or interface in java.lang">Throwable</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" class="type-name-link external-link" title="class or interface in java.lang">Exception</a>
|
||||
|
||||
@ -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>Serialized Form</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1 +1 @@
|
||||
typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"io.github.simplexdevelopment.scheduler","l":"BukkitDisposable"},{"p":"io.github.simplexdevelopment.api","l":"Context"},{"p":"io.github.simplexdevelopment.scheduler","l":"ExecutableService"},{"p":"io.github.simplexdevelopment.api","l":"Identifier"},{"p":"io.github.simplexdevelopment.api","l":"ISchedule"},{"p":"io.github.simplexdevelopment.api","l":"IService"},{"p":"io.github.simplexdevelopment.impl","l":"Main"},{"p":"io.github.simplexdevelopment.impl","l":"PoolHolder"},{"p":"io.github.simplexdevelopment.scheduler","l":"ReactorBukkitScheduler"},{"p":"io.github.simplexdevelopment.scheduler","l":"SchedulingSystem"},{"p":"io.github.simplexdevelopment.api","l":"ServiceException"},{"p":"io.github.simplexdevelopment.impl","l":"ServiceImpl"},{"p":"io.github.simplexdevelopment.scheduler","l":"ServiceManager"},{"p":"io.github.simplexdevelopment.scheduler","l":"ServicePool"},{"p":"io.github.simplexdevelopment.api","l":"ServicePoolException"}];updateSearchResults();
|
||||
typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"io.github.simplexdevelopment.scheduler","l":"BukkitDisposable"},{"p":"io.github.simplexdevelopment.api","l":"Context"},{"p":"io.github.simplexdevelopment.scheduler","l":"ExecutableService"},{"p":"io.github.simplexdevelopment.api","l":"Identifier"},{"p":"io.github.simplexdevelopment.api","l":"ISchedule"},{"p":"io.github.simplexdevelopment.api","l":"IService"},{"p":"io.github.simplexdevelopment.impl","l":"Main"},{"p":"io.github.simplexdevelopment.scheduler","l":"ReactorBukkitScheduler"},{"p":"io.github.simplexdevelopment.scheduler","l":"SchedulingSystem"},{"p":"io.github.simplexdevelopment.api","l":"ServiceException"},{"p":"io.github.simplexdevelopment.impl","l":"ServiceImpl"},{"p":"io.github.simplexdevelopment.scheduler","l":"ServiceManager"},{"p":"io.github.simplexdevelopment.scheduler","l":"ServicePool"},{"p":"io.github.simplexdevelopment.api","l":"ServicePoolException"}];updateSearchResults();
|
||||
Reference in New Issue
Block a user