SimplexDevelopment/SimplexSS
1
0
Fork 0
mirror of https://github.com/SimplexDevelopment/SimplexSS.git synced 2025-07-01 14:46:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Docs

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

7
build/docs/javadoc/io/github/simplexdevelopment/api/Context.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Context (SimplexSS 1.0.0 API)</title>
<title>Context (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: Context">
@ -73,11 +73,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&lt;S&gt;</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">

3
build/docs/javadoc/io/github/simplexdevelopment/api/ISchedule.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ISchedule (SimplexSS 1.0.0 API)</title>
<title>ISchedule (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: ISchedule">
@ -78,6 +78,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">

6
build/docs/javadoc/io/github/simplexdevelopment/api/IService.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>IService (SimplexSS 1.0.0 API)</title>
<title>IService (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: IService">
@ -83,6 +83,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">

5
build/docs/javadoc/io/github/simplexdevelopment/api/Identifier.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Identifier (SimplexSS 1.0.0 API)</title>
<title>Identifier (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: Identifier">
@ -78,10 +78,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">

5
build/docs/javadoc/io/github/simplexdevelopment/api/ServiceException.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ServiceException (SimplexSS 1.0.0 API)</title>
<title>ServiceException (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, class: ServiceException">
@ -88,6 +88,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>

6
build/docs/javadoc/io/github/simplexdevelopment/api/ServicePoolException.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ServicePoolException (SimplexSS 1.0.0 API)</title>
<title>ServicePoolException (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, class: ServicePoolException">
@ -88,6 +88,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>

26
build/docs/javadoc/io/github/simplexdevelopment/api/package-summary.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>io.github.simplexdevelopment.api (SimplexSS 1.0.0 API)</title>
<title>io.github.simplexdevelopment.api (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api">
@ -74,17 +74,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>&lt;S&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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>

2
build/docs/javadoc/io/github/simplexdevelopment/api/package-tree.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>io.github.simplexdevelopment.api Class Hierarchy (SimplexSS 1.0.0 API)</title>
<title>io.github.simplexdevelopment.api Class Hierarchy (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="tree: package: io.github.simplexdevelopment.api">

9
build/docs/javadoc/io/github/simplexdevelopment/impl/Main.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Main (SimplexSS 1.0.0 API)</title>
<title>Main (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.impl, class: Main">
@ -123,7 +123,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">&nbsp;</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>&nbsp;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>&nbsp;poolName)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
@ -190,10 +190,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>&nbsp;<span class="return-type">void</span>&nbsp;<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>&nbsp;poolHolder)</span></div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<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>&nbsp;poolName)</span></div>
</section>
</li>
<li>

206
build/docs/javadoc/io/github/simplexdevelopment/impl/PoolHolder.html
View File

@ -1,206 +0,0 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>PoolHolder (SimplexSS 1.0.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.impl, class: PoolHolder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.impl</a></div>
<h1 title="Class PoolHolder" class="title">Class PoolHolder</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
<div class="inheritance">io.github.simplexdevelopment.impl.PoolHolder</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PoolHolder</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/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.impl.Main)" class="member-name-link">PoolHolder</a><wbr>(<a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a>&nbsp;plugin)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-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>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contextCollection()" class="member-name-link">contextCollection</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;<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>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setContext(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setContext</a><wbr>(<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&nbsp;context)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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.Context">Methods inherited from interface&nbsp;io.github.simplexdevelopment.api.<a href="../api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></h3>
<code><a href="../api/Context.html#fluxFromCollection()">fluxFromCollection</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(io.github.simplexdevelopment.impl.Main)">
<h3>PoolHolder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PoolHolder</span><wbr><span class="parameters">(<a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a>&nbsp;plugin)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getContext()">
<h3>getContext</h3>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">getContext</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../api/Context.html#getContext()">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="../api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd>A Mono object which contains a single element represented by the definer of this Context class.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setContext(io.github.simplexdevelopment.scheduler.ServicePool)">
<h3>setContext</h3>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<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>&gt;</span>&nbsp;<span class="element-name">setContext</span><wbr><span class="parameters">(<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&nbsp;context)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../api/Context.html#setContext(S)">setContext</a></code>&nbsp;in interface&nbsp;<code><a href="../api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</code></dd>
<dt>Parameters:</dt>
<dd><code>context</code> - A separate (or identical) object identified by the definer of this Context class.</dd>
<dt>Returns:</dt>
<dd>A Mono object which can be used to set the element of this Context class in a non-blocking manner.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="contextCollection()">
<h3>contextCollection</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">contextCollection</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../api/Context.html#contextCollection()">contextCollection</a></code>&nbsp;in interface&nbsp;<code><a href="../api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd>A collection of objects related to the definer of this Context class.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>

2
build/docs/javadoc/io/github/simplexdevelopment/impl/ServiceImpl.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ServiceImpl (SimplexSS 1.0.0 API)</title>
<title>ServiceImpl (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.impl, class: ServiceImpl">

6
build/docs/javadoc/io/github/simplexdevelopment/impl/package-summary.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>io.github.simplexdevelopment.impl (SimplexSS 1.0.0 API)</title>
<title>io.github.simplexdevelopment.impl (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.impl">
@ -70,10 +70,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">&nbsp;</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">&nbsp;</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">&nbsp;</div>
</div>
</div>
</li>

3
build/docs/javadoc/io/github/simplexdevelopment/impl/package-tree.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>io.github.simplexdevelopment.impl Class Hierarchy (SimplexSS 1.0.0 API)</title>
<title>io.github.simplexdevelopment.impl Class Hierarchy (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="tree: package: io.github.simplexdevelopment.impl">
@ -73,7 +73,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>&lt;S&gt;)</li>
</ul>
</li>
</ul>

3
build/docs/javadoc/io/github/simplexdevelopment/scheduler/BukkitDisposable.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>BukkitDisposable (SimplexSS 1.0.0 API)</title>
<title>BukkitDisposable (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, record: BukkitDisposable">
@ -85,6 +85,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&nbsp;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">

3
build/docs/javadoc/io/github/simplexdevelopment/scheduler/ExecutableService.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ExecutableService (SimplexSS 1.0.0 API)</title>
<title>ExecutableService (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, class: ExecutableService">
@ -87,6 +87,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">

4
build/docs/javadoc/io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ReactorBukkitScheduler (SimplexSS 1.0.0 API)</title>
<title>ReactorBukkitScheduler (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, class: ReactorBukkitScheduler">
@ -83,6 +83,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">

37
build/docs/javadoc/io/github/simplexdevelopment/scheduler/SchedulingSystem.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>SchedulingSystem (SimplexSS 1.0.0 API)</title>
<title>SchedulingSystem (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, class: SchedulingSystem">
@ -76,6 +76,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>
@ -83,6 +87,24 @@ loadScripts(document, 'script');</script>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">SchedulingSystem&lt;T extends org.bukkit.plugin.java.JavaPlugin&gt;</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">
@ -132,9 +154,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&lt;<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>&gt;</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>&nbsp;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&lt;reactor.core.Disposable&gt;</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">&nbsp;</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&lt;<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>&gt;</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>&nbsp;service)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
@ -203,6 +228,12 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
</section>
</li>
<li>
<section class="detail" id="queueAll()">
<h3>queueAll</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;</span>&nbsp;<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

56
build/docs/javadoc/io/github/simplexdevelopment/scheduler/ServiceManager.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ServiceManager (SimplexSS 1.0.0 API)</title>
<title>ServiceManager (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, class: ServiceManager">
@ -78,6 +78,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">
@ -112,10 +117,19 @@ loadScripts(document, 'script');</script>
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>...&nbsp;services)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</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>&nbsp;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>&nbsp;poolName,
org.bukkit.plugin.java.JavaPlugin&nbsp;plugin,
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>...&nbsp;services)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</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>&nbsp;poolName,
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>...&nbsp;services)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</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>&nbsp;poolName,
org.bukkit.plugin.java.JavaPlugin&nbsp;plugin)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</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>&nbsp;poolName,
boolean&nbsp;multithreaded)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
@ -191,6 +205,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="_, _ -&gt; new")
@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<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>&nbsp;poolName,
org.bukkit.plugin.java.JavaPlugin&nbsp;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="_, _, _ -&gt; new")
@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<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>&nbsp;poolName,
org.bukkit.plugin.java.JavaPlugin&nbsp;plugin,
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>...&nbsp;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,

106
build/docs/javadoc/io/github/simplexdevelopment/scheduler/ServicePool.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ServicePool (SimplexSS 1.0.0 API)</title>
<title>ServicePool (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, class: ServicePool">
@ -75,9 +75,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">
@ -116,34 +134,52 @@ loadScripts(document, 'script');</script>
<div class="col-first even-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>&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</code></div>
<div class="col-second even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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-first odd-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 odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</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>&nbsp;service_name)</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.scheduler.Scheduler</code></div>
<div class="col-second even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;reactor.core.Disposable&gt;</code></div>
<div class="col-second odd-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>&nbsp;service)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</code></div>
<div class="col-second odd-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>&nbsp;service_name)</code></div>
<div class="col-last odd-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono&lt;reactor.core.Disposable&gt;</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>&nbsp;service)</code></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&lt;reactor.core.Disposable&gt;</code></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&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</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">&nbsp;</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&lt;reactor.core.Disposable&gt;</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">&nbsp;</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&lt;<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>&gt;</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>&nbsp;service_name,
@Nullable reactor.core.publisher.Mono&lt;reactor.core.Disposable&gt;&nbsp;disposable)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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>@NotNull reactor.core.publisher.Mono&lt;<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>&gt;</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&lt;reactor.core.Disposable&gt;&nbsp;disposableThread)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-second odd-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>&nbsp;service_name,
@Nullable reactor.core.publisher.Mono&lt;reactor.core.Disposable&gt;&nbsp;disposable)</code></div>
<div class="col-last odd-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono&lt;<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>&gt;</code></div>
<div class="col-second even-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&lt;reactor.core.Disposable&gt;&nbsp;disposableThread)</code></div>
<div class="col-last even-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&nbsp;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&nbsp;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>
@ -207,6 +243,10 @@ loadScripts(document, 'script');</script>
<h3>queueService</h3>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;reactor.core.Disposable&gt;</span>&nbsp;<span class="element-name">queueService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;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.
@ -218,10 +258,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>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;</span>&nbsp;<span class="element-name">startServices</span>()</div>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;</span>&nbsp;<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,
@ -235,6 +277,8 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<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>&gt;</span>&nbsp;<span class="element-name">stopServices</span><wbr><span class="parameters">(@NotNull
@NotNull reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;&nbsp;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&lt;reactor.core.Disposable&gt;</code> which contains all the services that should be disposed..</dd>
@ -251,6 +295,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>&nbsp;service_name,
@Nullable
@Nullable reactor.core.publisher.Mono&lt;reactor.core.Disposable&gt;&nbsp;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>
@ -265,6 +312,8 @@ loadScripts(document, 'script');</script>
<h3>getService</h3>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</span>&nbsp;<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>&nbsp;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>
@ -278,6 +327,7 @@ loadScripts(document, 'script');</script>
<h3>recycle</h3>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<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.
@ -296,6 +346,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>&nbsp;<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>&nbsp;<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>&nbsp;in interface&nbsp;<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>

27
build/docs/javadoc/io/github/simplexdevelopment/scheduler/package-summary.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>io.github.simplexdevelopment.scheduler (SimplexSS 1.0.0 API)</title>
<title>io.github.simplexdevelopment.scheduler (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler">
@ -74,17 +74,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">&nbsp;</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">&nbsp;</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">&nbsp;</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>&lt;T extends org.bukkit.plugin.java.JavaPlugin&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</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">&nbsp;</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">&nbsp;</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>

4
build/docs/javadoc/io/github/simplexdevelopment/scheduler/package-tree.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>io.github.simplexdevelopment.scheduler Class Hierarchy (SimplexSS 1.0.0 API)</title>
<title>io.github.simplexdevelopment.scheduler Class Hierarchy (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="tree: package: io.github.simplexdevelopment.scheduler">
@ -68,7 +68,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>&lt;T&gt; (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>