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

Finalization

Browse Source
This commit is contained in:
Paldiu
2022-12-14 12:57:45 -06:00
parent 99c78e320f
commit 1687ca32f3
74 changed files with 2382 additions and 750 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
docs/io/github/simplexdevelopment/scheduler/ServicePool.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Dec 14 11:14:32 CST 2022 -->
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
<title>ServicePool</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@ -36,6 +36,7 @@ loadScripts(document, 'script');</script>
<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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
@ -95,22 +96,19 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color">
<div class="block">A collection of services related to this service pool.</div>
</div>
<div class="col-first odd-row-color"><code>private static final org.bukkit.NamespacedKey</code></div>
<div class="col-first odd-row-color"><code>private static final <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"><code><a href="#DEFAULT" class="member-name-link">DEFAULT</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The default <code>NamespacedKey</code> used to identify unmarked services.</div>
<div class="block">The default <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"><code>String</code></a> used to identify unmarked services.</div>
</div>
<div class="col-first even-row-color"><code>private final org.bukkit.NamespacedKey</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#name" class="member-name-link">name</a></code></div>
<div class="col-last even-row-color">
<div class="block">The key used to identify this service pool.</div>
<div class="block">The name used to identify this service pool.</div>
</div>
<div class="col-first odd-row-color"><code>private final <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></code></div>
<div class="col-second odd-row-color"><code><a href="#rbScheduler" class="member-name-link">rbScheduler</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>private final reactor.core.scheduler.Scheduler</code></div>
<div class="col-second even-row-color"><code><a href="#scheduler" class="member-name-link">scheduler</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code>private final reactor.core.scheduler.Scheduler</code></div>
<div class="col-second odd-row-color"><code><a href="#scheduler" class="member-name-link">scheduler</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The scheduler used to run the services in this pool.</div>
</div>
</div>
@ -124,12 +122,12 @@ loadScripts(document, 'script');</script>
<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(org.bukkit.NamespacedKey,boolean)" class="member-name-link">ServicePool</a><wbr>(org.bukkit.NamespacedKey&nbsp;name,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,boolean)" class="member-name-link">ServicePool</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;name,
boolean&nbsp;multithreaded)</code></div>
<div class="col-last even-row-color">
<div class="block">This will create a new instance of a Service Pool with a <code>Scheduler</code> as its main scheduler.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.NamespacedKey,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ServicePool</a><wbr>(org.bukkit.NamespacedKey&nbsp;name,
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ServicePool</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;name,
org.bukkit.plugin.java.JavaPlugin&nbsp;plugin)</code></div>
<div class="col-last odd-row-color">
<div class="block">This will create a new instance of a Service Pool with the <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> as its main scheduler.</div>
@ -154,14 +152,14 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&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>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDefaultNamespacedKey()" class="member-name-link">getDefaultNamespacedKey</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&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-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(org.bukkit.NamespacedKey)" class="member-name-link">getService</a><wbr>(org.bukkit.NamespacedKey&nbsp;service_name)</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-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.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>
@ -179,7 +177,7 @@ loadScripts(document, 'script');</script>
<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(org.bukkit.NamespacedKey,reactor.core.publisher.Mono)" class="member-name-link">stopService</a><wbr>(@NotNull org.bukkit.NamespacedKey&nbsp;service_name,
<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-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>
@ -205,8 +203,16 @@ loadScripts(document, 'script');</script>
<li>
<section class="detail" id="DEFAULT">
<h3>DEFAULT</h3>
<div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type">org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">DEFAULT</span></div>
<div class="block">The default <code>NamespacedKey</code> used to identify unmarked services. This will cause errors if left unchecked.</div>
<div class="member-signature"><span class="modifiers">private static final</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">DEFAULT</span></div>
<div class="block">The default <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"><code>String</code></a> used to identify unmarked services. This will cause errors if left unchecked.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#io.github.simplexdevelopment.scheduler.ServicePool.DEFAULT">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
@ -226,14 +232,8 @@ loadScripts(document, 'script');</script>
<li>
<section class="detail" id="name">
<h3>name</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">name</span></div>
<div class="block">The key used to identify this service pool.</div>
</section>
</li>
<li>
<section class="detail" id="rbScheduler">
<h3>rbScheduler</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></span>&nbsp;<span class="element-name">rbScheduler</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">name</span></div>
<div class="block">The name used to identify this service pool.</div>
</section>
</li>
</ul>
@ -245,9 +245,9 @@ loadScripts(document, 'script');</script>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.NamespacedKey,boolean)">
<section class="detail" id="&lt;init&gt;(java.lang.String,boolean)">
<h3>ServicePool</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ServicePool</span><wbr><span class="parameters">(org.bukkit.NamespacedKey&nbsp;name,
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ServicePool</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;name,
boolean&nbsp;multithreaded)</span></div>
<div class="block">This will create a new instance of a Service Pool with a <code>Scheduler</code> as its main scheduler.
This should be used if you'd like to execute tasks without communicating on the main server thread.</div>
@ -259,9 +259,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.NamespacedKey,org.bukkit.plugin.java.JavaPlugin)">
<section class="detail" id="&lt;init&gt;(java.lang.String,org.bukkit.plugin.java.JavaPlugin)">
<h3>ServicePool</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ServicePool</span><wbr><span class="parameters">(org.bukkit.NamespacedKey&nbsp;name,
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ServicePool</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;name,
org.bukkit.plugin.java.JavaPlugin&nbsp;plugin)</span></div>
<div class="block">This will create a new instance of a Service Pool with the <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> as its main scheduler.
This should be used if you'd like to execute tasks while communicating on the main server thread.</div>
@ -282,7 +282,7 @@ loadScripts(document, 'script');</script>
<li>
<section class="detail" id="getDefaultNamespacedKey()">
<h3>getDefaultNamespacedKey</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type">org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">getDefaultNamespacedKey</span>()</div>
<div class="member-signature"><span class="modifiers">static</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">getDefaultNamespacedKey</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The default namespaced key to use if one is not assigned.</dd>
@ -331,8 +331,8 @@ loadScripts(document, 'script');</script>
<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.
If you name a service that is stored within another service pool,
this method will throw an error.</dd>
If you name a service that is stored within another service pool,
this method will throw an error.</dd>
<dt>Returns:</dt>
<dd>A <code>Mono</code> object which contains a <code>Disposable</code> element which can be used to destroy the registered service.</dd>
</dl>
@ -365,11 +365,11 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="stopService(org.bukkit.NamespacedKey,reactor.core.publisher.Mono)">
<section class="detail" id="stopService(java.lang.String,reactor.core.publisher.Mono)">
<h3>stopService</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">stopService</span><wbr><span class="parameters">(@NotNull
@NotNull org.bukkit.NamespacedKey&nbsp;service_name,
@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>
<dl class="notes">
@ -382,10 +382,10 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="getService(org.bukkit.NamespacedKey)">
<section class="detail" id="getService(java.lang.String)">
<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">(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">(<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>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service_name</code> - The name of the service to get.</dd>