SimplexDevelopment/SimplexSS
1
0
Fork 0
mirror of https://github.com/SimplexDevelopment/SimplexSS.git synced 2025-07-01 06:36:41 +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

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,