Added Bukkit communication with BukkitScheduler

This commit is contained in:
Paldiu
2022-12-14 11:15:42 -06:00
parent 329726ed95
commit 262115a52e
78 changed files with 5535 additions and 711 deletions

View File

@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-12-13">
<meta name="description" content="declaration: package: io.github.simplex.simplexss, class: ServicePool">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, class: ServicePool">
<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">
@ -68,11 +68,11 @@ loadScripts(document, 'script');</script>
<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.simplex.simplexss</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.scheduler</a></div>
<h1 title="Class ServicePool" class="title">Class ServicePool</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.simplex.simplexss.ServicePool</div>
<div class="inheritance">io.github.simplexdevelopment.scheduler.ServicePool</div>
</div>
<section class="class-description" id="class-description">
<hr>
@ -90,7 +90,7 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final <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.simplex.api">IService</a>&gt;</code></div>
<div class="col-first even-row-color"><code>private final <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"><code><a href="#associatedServices" class="member-name-link">associatedServices</a></code></div>
<div class="col-last even-row-color">
<div class="block">A collection of services related to this service pool.</div>
@ -139,9 +139,9 @@ loadScripts(document, 'script');</script>
<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>(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="#addService(io.github.simplex.api.IService)" class="member-name-link">addService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addService(io.github.simplexdevelopment.api.IService)" class="member-name-link">addService</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">&nbsp;</div>
<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>&lt;<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>&gt;</code></div>
<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>&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="#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">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static org.bukkit.NamespacedKey</code></div>
@ -150,20 +150,20 @@ loadScripts(document, 'script');</script>
<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">&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.simplex.api">IService</a>&gt;</code></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(org.bukkit.NamespacedKey)" class="member-name-link">getService</a><wbr>(org.bukkit.NamespacedKey&nbsp;service_name)</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>(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.simplex.api.IService)" class="member-name-link">isValidService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</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>&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 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(org.bukkit.NamespacedKey)" class="member-name-link">queueService</a><wbr>(org.bukkit.NamespacedKey&nbsp;service_name)</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.simplex.simplexss">ServicePool</a>&gt;</code></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="#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">&nbsp;</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.simplex.api.IService)" class="member-name-link">removeService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</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>&nbsp;service)</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>
@ -195,7 +195,7 @@ loadScripts(document, 'script');</script>
<li>
<section class="detail" id="associatedServices">
<h3>associatedServices</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><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.simplex.api">IService</a>&gt;</span>&nbsp;<span class="element-name">associatedServices</span></div>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><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;</span>&nbsp;<span class="element-name">associatedServices</span></div>
<div class="block">A collection of services related to this service pool.</div>
</section>
</li>
@ -259,9 +259,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="addService(io.github.simplex.api.IService)">
<section class="detail" id="addService(io.github.simplexdevelopment.api.IService)">
<h3>addService</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - Add a service to the pool's service collection.</dd>
@ -269,9 +269,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="isValidService(io.github.simplex.api.IService)">
<section class="detail" id="isValidService(io.github.simplexdevelopment.api.IService)">
<h3>isValidService</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isValidService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isValidService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - The service to check against this pool.</dd>
@ -285,10 +285,10 @@ loadScripts(document, 'script');</script>
<h3>getAssociatedServices</h3>
<div class="member-signature"><span class="annotations">@Contract(pure=true)
@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@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.simplex.api">IService</a>&gt;</span>&nbsp;<span class="element-name">getAssociatedServices</span>()</div>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@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;</span>&nbsp;<span class="element-name">getAssociatedServices</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A <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"><code>Set</code></a> of <a href="../api/IService.html" title="interface in io.github.simplex.api"><code>IService</code></a> objects which are registered with this pool.</dd>
<dd>A <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"><code>Set</code></a> of <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a> objects which are registered with this pool.</dd>
</dl>
</section>
</li>
@ -354,7 +354,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getService(org.bukkit.NamespacedKey)">
<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.simplex.api">IService</a>&gt;</span>&nbsp;<span class="element-name">getService</span><wbr><span class="parameters">(org.bukkit.NamespacedKey&nbsp;service_name)</span></div>
</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">(org.bukkit.NamespacedKey&nbsp;service_name)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service_name</code> - The name of the service to get.</dd>
@ -364,9 +364,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="removeService(io.github.simplex.api.IService)">
<section class="detail" id="removeService(io.github.simplexdevelopment.api.IService)">
<h3>removeService</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">removeService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">removeService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - The service to remove from the pool's service collection.</dd>
@ -377,7 +377,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="recycle()">
<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.simplex.simplexss">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">recycle</span>()</div>
</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>
<dl class="notes">
<dt>Returns:</dt>
<dd>This service pool after being cleared of all services.