mirror of
https://github.com/SimplexDevelopment/SimplexSS.git
synced 2025-07-01 22:56:42 +00:00
Doccing and Bugfixing
This commit is contained in:
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>Context</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.api, interface: Context">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>ExecutableService</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.api, class: ExecutableService">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
@ -108,15 +108,18 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
||||
<div class="col-first even-row-color"><code>private final boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#mayInterruptWhenRunning" class="member-name-link">mayInterruptWhenRunning</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private final long</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#period" class="member-name-link">period</a></code></div>
|
||||
<div class="col-first odd-row-color"><code>private <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#parentPool" class="member-name-link">parentPool</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private final boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#repeating" class="member-name-link">repeating</a></code></div>
|
||||
<div class="col-first even-row-color"><code>private final long</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#period" class="member-name-link">period</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private final org.bukkit.NamespacedKey</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#service_name" class="member-name-link">service_name</a></code></div>
|
||||
<div class="col-first odd-row-color"><code>private final boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#repeating" class="member-name-link">repeating</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private final org.bukkit.NamespacedKey</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#service_name" class="member-name-link">service_name</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
@ -128,7 +131,31 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
||||
<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,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)" class="member-name-link">ExecutableService</a><wbr>(@NotNull org.bukkit.NamespacedKey service_name,
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.NamespacedKey)" class="member-name-link">ExecutableService</a><wbr>(@NotNull org.bukkit.NamespacedKey service_name)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
||||
@NotNull org.bukkit.NamespacedKey service_name)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
||||
@NotNull org.bukkit.NamespacedKey service_name,
|
||||
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay,
|
||||
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period,
|
||||
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
||||
@NotNull org.bukkit.NamespacedKey service_name,
|
||||
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
||||
@NotNull org.bukkit.NamespacedKey service_name,
|
||||
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay,
|
||||
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period,
|
||||
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating,
|
||||
@ -161,20 +188,23 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.bukkit.NamespacedKey</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNamespacedKey()" class="member-name-link">getNamespacedKey</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPeriod()" class="member-name-link">getPeriod</a>()</code></div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParentPool()" class="member-name-link">getParentPool</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCancelled()" class="member-name-link">isCancelled</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPeriod()" class="member-name-link">getPeriod</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCancelled()" class="member-name-link">isCancelled</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Cancels the execution of this service.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPeriodic()" class="member-name-link">isPeriodic</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCancelled(boolean)" class="member-name-link">setCancelled</a><wbr>(boolean cancel)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPeriodic()" class="member-name-link">isPeriodic</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCancelled(boolean)" class="member-name-link">setCancelled</a><wbr>(boolean cancel)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Cancels the execution of this service.</div>
|
||||
</div>
|
||||
</div>
|
||||
@ -185,7 +215,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
||||
<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.simplex.api.IService">Methods inherited from interface io.github.simplex.api.<a href="IService.html" title="interface in io.github.simplex.api">IService</a></h3>
|
||||
<code><a href="IService.html#getParentPool()">getParentPool</a>, <a href="IService.html#getPlugin()">getPlugin</a>, <a href="IService.html#run()">run</a>, <a href="IService.html#start()">start</a>, <a href="IService.html#stop()">stop</a></code></div>
|
||||
<code><a href="IService.html#getPlugin()">getPlugin</a>, <a href="IService.html#run()">run</a>, <a href="IService.html#start()">start</a>, <a href="IService.html#stop()">stop</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@ -233,6 +263,12 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">cancelled</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="parentPool">
|
||||
<h3>parentPool</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a></span> <span class="element-name">parentPool</span></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
@ -242,9 +278,94 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)">
|
||||
<section class="detail" id="<init>(org.bukkit.NamespacedKey)">
|
||||
<h3>ExecutableService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull org.bukkit.NamespacedKey service_name)</span></div>
|
||||
<div class="block">Creates a new instance of an executable service.
|
||||
Each service is registered with a <code>NamespacedKey</code>,
|
||||
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey)">
|
||||
<h3>ExecutableService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable
|
||||
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
||||
@NotNull
|
||||
@NotNull org.bukkit.NamespacedKey service_name)</span></div>
|
||||
<div class="block">Creates a new instance of an executable service.
|
||||
Each service is registered with a <code>NamespacedKey</code>,
|
||||
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
||||
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long)">
|
||||
<h3>ExecutableService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable
|
||||
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
||||
@NotNull
|
||||
@NotNull org.bukkit.NamespacedKey service_name,
|
||||
@Nullable
|
||||
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay)</span></div>
|
||||
<div class="block">Creates a new instance of an executable service.
|
||||
The timings are measured in ticks (20 ticks per second).
|
||||
You do not need to explicitly define a delay.
|
||||
Each service is registered with a <code>NamespacedKey</code>,
|
||||
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
||||
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
||||
<dd><code>delay</code> - A specified amount of time (in ticks) to wait before the service runs.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean)">
|
||||
<h3>ExecutableService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable
|
||||
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
||||
@NotNull
|
||||
@NotNull org.bukkit.NamespacedKey service_name,
|
||||
@NotNull
|
||||
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay,
|
||||
@NotNull
|
||||
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period,
|
||||
@NotNull
|
||||
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating)</span></div>
|
||||
<div class="block">Creates a new instance of an executable service.
|
||||
The timings are measured in ticks (20 ticks per second).
|
||||
You do not need to explicitly define a delay or a period,
|
||||
however if you have flagged <a href="#repeating"><code>repeating</code></a> as true, and the period is null,
|
||||
then the period will automatically be set to 20 minutes.
|
||||
Each service is registered with a <code>NamespacedKey</code>,
|
||||
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
||||
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
||||
<dd><code>delay</code> - A specified amount of time (in ticks) to wait before the service runs.</dd>
|
||||
<dd><code>period</code> - How long the service should wait between service executions (in ticks).</dd>
|
||||
<dd><code>repeating</code> - If the service should be scheduled for repeated executions or not.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)">
|
||||
<h3>ExecutableService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable
|
||||
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
||||
@NotNull
|
||||
@NotNull org.bukkit.NamespacedKey service_name,
|
||||
@Nullable
|
||||
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay,
|
||||
@ -263,6 +384,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
||||
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
||||
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
||||
<dd><code>delay</code> - A specified amount of time (in ticks) to wait before the service runs.</dd>
|
||||
<dd><code>period</code> - How long the service should wait between service executions (in ticks).</dd>
|
||||
@ -357,6 +479,18 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
||||
<div class="block">Actual stop call, to ensure that the service actually #isCancelled().</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getParentPool()">
|
||||
<h3>getParentPool</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></span> <span class="element-name">getParentPool</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="IService.html#getParentPool()">getParentPool</a></code> in interface <code><a href="IService.html" title="interface in io.github.simplex.api">IService</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>ISchedule</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.api, interface: ISchedule">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>IService</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.api, interface: IService">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
@ -118,17 +118,23 @@ extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/ja
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isPeriodic()" class="member-name-link">isPeriodic</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#start()" class="member-name-link">start</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static @NotNull org.bukkit.NamespacedKey</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#newNamespacedKey(java.lang.String,java.lang.String)" class="member-name-link">newNamespacedKey</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> space,
|
||||
<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> key)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
|
||||
<div class="block">This is an easy static call for creating a new namespaced key for services and service pools.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#start()" class="member-name-link">start</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">The actual start method for the service.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#stop()" class="member-name-link">stop</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#stop()" class="member-name-link">stop</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">The actual end method for the service.</div>
|
||||
</div>
|
||||
</div>
|
||||
@ -248,6 +254,23 @@ extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/ja
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="newNamespacedKey(java.lang.String,java.lang.String)">
|
||||
<h3>newNamespacedKey</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract("_, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">static</span> <span class="return-type">@NotNull org.bukkit.NamespacedKey</span> <span class="element-name">newNamespacedKey</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> space,
|
||||
<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> key)</span></div>
|
||||
<div class="block">This is an easy static call for creating a new namespaced key for services and service pools.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>space</code> - The namespace of the service.</dd>
|
||||
<dd><code>key</code> - The key name of the service.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A NamespacedKey object representing the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>InvalidServiceException</title>
|
||||
<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-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.api, class: InvalidServiceException">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>InvalidServicePoolException</title>
|
||||
<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-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.api, class: InvalidServicePoolException">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>io.github.simplex.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="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.api">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>io.github.simplex.api Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="tree: package: io.github.simplex.api">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>Main</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.impl, class: Main">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
@ -101,9 +101,12 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color"><code>private reactor.core.publisher.Flux<reactor.core.Disposable></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#disposables" class="member-name-link">disposables</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private <a href="../simplexss/SchedulingSystem.html" title="class in io.github.simplex.simplexss">SchedulingSystem</a><<a href="Main.html" title="class in io.github.simplex.impl">Main</a>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#scheduler" class="member-name-link">scheduler</a></code></div>
|
||||
<div class="col-first odd-row-color"><code><a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#pool" class="member-name-link">pool</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private <a href="../simplexss/SchedulingSystem.html" title="class in io.github.simplex.simplexss">SchedulingSystem</a><<a href="Main.html" title="class in io.github.simplex.impl">Main</a>></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>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
@ -167,6 +170,12 @@ loadScripts(document, 'script');</script>
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="pool">
|
||||
<h3>pool</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a></span> <span class="element-name">pool</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="scheduler">
|
||||
<h3>scheduler</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../simplexss/SchedulingSystem.html" title="class in io.github.simplex.simplexss">SchedulingSystem</a><<a href="Main.html" title="class in io.github.simplex.impl">Main</a>></span> <span class="element-name">scheduler</span></div>
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>ServiceImpl</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.impl, class: ServiceImpl">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
@ -235,6 +235,10 @@ loadScripts(document, 'script');</script>
|
||||
<h3>getParentPool</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></span> <span class="element-name">getParentPool</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/IService.html#getParentPool()">getParentPool</a></code> in interface <code><a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a></code></dd>
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="../api/ExecutableService.html#getParentPool()">getParentPool</a></code> in class <code><a href="../api/ExecutableService.html" title="class in io.github.simplex.api">ExecutableService</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
||||
</dl>
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>io.github.simplex.impl</title>
|
||||
<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-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.impl">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>io.github.simplex.impl Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="tree: package: io.github.simplex.impl">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>SchedulingSystem</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.simplexss, class: SchedulingSystem">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
@ -120,7 +120,9 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServiceManager,T)" class="member-name-link">SchedulingSystem</a><wbr>(@NotNull <a href="ServiceManager.html" title="class in io.github.simplex.simplexss">ServiceManager</a> serviceManager,
|
||||
<a href="SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> plugin)</code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new instance of the scheduling system.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
@ -214,6 +216,12 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SchedulingSystem</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <a href="ServiceManager.html" title="class in io.github.simplex.simplexss">ServiceManager</a> serviceManager,
|
||||
<a href="SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> plugin)</span></div>
|
||||
<div class="block">Creates a new instance of the scheduling system. This is used to manage the scheduling of services.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>serviceManager</code> - The service manager to use for this scheduling system.</dd>
|
||||
<dd><code>plugin</code> - The plugin to use for this scheduling system. This should be an instance of your plugin.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>ServiceManager</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.simplexss, class: ServiceManager">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
@ -105,7 +105,9 @@ loadScripts(document, 'script');</script>
|
||||
<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()" class="member-name-link">ServiceManager</a>()</code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new instance of the Service Manager class.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
@ -184,6 +186,11 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>ServiceManager</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServiceManager</span>()</div>
|
||||
<div class="block">Creates a new instance of the Service Manager class.
|
||||
This class acts as a Service Pool factory, and can be used to create
|
||||
both single and multithreaded Service Pools, empty service pools, as well as
|
||||
retrieve existing Service Pools. It also provides methods for you to add and remove
|
||||
<a href="../api/IService.html" title="interface in io.github.simplex.api"><code>IService</code></a>s from the {ServicePool} parameter.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 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">
|
||||
<meta name="dc.created" content="2022-12-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.simplexss, class: ServicePool">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
@ -92,16 +92,24 @@ loadScripts(document, 'script');</script>
|
||||
<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><<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>></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>
|
||||
<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-second odd-row-color"><code><a href="#DEFAULT" class="member-name-link">DEFAULT</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The default <code>NamespacedKey</code> 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-second even-row-color"><code><a href="#name" class="member-name-link">name</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The key used to identify this service pool.</div>
|
||||
</div>
|
||||
<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>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The scheduler used to run the services in this pool.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
@ -142,29 +150,30 @@ 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"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>></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<<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getService(org.bukkit.NamespacedKey)" class="member-name-link">getService</a><wbr>(org.bukkit.NamespacedKey service_name)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-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> service)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recycle()" class="member-name-link">recycle</a>()</code></div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<reactor.core.Disposable></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueService(org.bukkit.NamespacedKey)" class="member-name-link">queueService</a><wbr>(org.bukkit.NamespacedKey service_name)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeService(io.github.simplex.api.IService)" class="member-name-link">removeService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a> service)</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<<a href="ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recycle()" class="member-name-link">recycle</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<reactor.core.Disposable></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startService(org.bukkit.NamespacedKey)" class="member-name-link">startService</a><wbr>(org.bukkit.NamespacedKey service_name)</code></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> service)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Flux<reactor.core.Disposable></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.Flux<reactor.core.Disposable></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startServices()" class="member-name-link">startServices</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopService(org.bukkit.NamespacedKey)" class="member-name-link">stopService</a><wbr>(org.bukkit.NamespacedKey service_name)</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<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopService(org.bukkit.NamespacedKey,reactor.core.publisher.Mono)" class="member-name-link">stopService</a><wbr>(@NotNull org.bukkit.NamespacedKey service_name,
|
||||
@Nullable reactor.core.publisher.Mono<reactor.core.Disposable> disposable)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices</a><wbr>(reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)</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<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices</a><wbr>(@NotNull reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
</div>
|
||||
</div>
|
||||
@ -187,24 +196,28 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="associatedServices">
|
||||
<h3>associatedServices</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <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><<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>></span> <span class="element-name">associatedServices</span></div>
|
||||
<div class="block">A collection of services related to this service pool.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="scheduler">
|
||||
<h3>scheduler</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">reactor.core.scheduler.Scheduler</span> <span class="element-name">scheduler</span></div>
|
||||
<div class="block">The scheduler used to run the services in this pool.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="name">
|
||||
<h3>name</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.bukkit.NamespacedKey</span> <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="DEFAULT">
|
||||
<h3>DEFAULT</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.bukkit.NamespacedKey</span> <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>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@ -220,6 +233,11 @@ loadScripts(document, 'script');</script>
|
||||
<h3>ServicePool</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServicePool</span><wbr><span class="parameters">(org.bukkit.NamespacedKey name,
|
||||
boolean multithreaded)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>name</code> - The name of this service pool.</dd>
|
||||
<dd><code>multithreaded</code> - Whether this service pool should be multithreaded, or operate upon a single thread.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@ -234,73 +252,148 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getDefaultNamespacedKey()">
|
||||
<h3>getDefaultNamespacedKey</h3>
|
||||
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type">org.bukkit.NamespacedKey</span> <span class="element-name">getDefaultNamespacedKey</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The default namespaced key to use if one is not assigned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="addService(io.github.simplex.api.IService)">
|
||||
<h3>addService</h3>
|
||||
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">addService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - Add a service to the pool's service collection.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="isValidService(io.github.simplex.api.IService)">
|
||||
<h3>isValidService</h3>
|
||||
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isValidService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to check against this pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>Whether the service is registered with this pool.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getAssociatedServices()">
|
||||
<h3>getAssociatedServices</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true)
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <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><<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>></span> <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>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="startService(org.bukkit.NamespacedKey)">
|
||||
<h3>startService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<reactor.core.Disposable></span> <span class="element-name">startService</span><wbr><span class="parameters">(org.bukkit.NamespacedKey service_name)</span></div>
|
||||
<section class="detail" id="queueService(org.bukkit.NamespacedKey)">
|
||||
<h3>queueService</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<reactor.core.Disposable></span> <span class="element-name">queueService</span><wbr><span class="parameters">(org.bukkit.NamespacedKey service_name)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service_name</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>
|
||||
<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>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="startServices()">
|
||||
<h3>startServices</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Flux<reactor.core.Disposable></span> <span class="element-name">startServices</span>()</div>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Flux<reactor.core.Disposable></span> <span class="element-name">startServices</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Flux</code> object which contains a collection of <code>Disposable</code> elements,
|
||||
which can be used to destroy the registered services using <a href="#stopServices(reactor.core.publisher.Flux)"><code>stopServices(Flux<Disposable>)</code></a>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="stopServices(reactor.core.publisher.Flux)">
|
||||
<h3>stopServices</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">stopServices</span><wbr><span class="parameters">(reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)</span></div>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">stopServices</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>disposableThread</code> - A <code>reactor.core.publisher.Flux<reactor.core.Disposable></code> which contains all the services that should be disposed..</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code> object which can be used to stop the services.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="stopService(org.bukkit.NamespacedKey)">
|
||||
<section class="detail" id="stopService(org.bukkit.NamespacedKey,reactor.core.publisher.Mono)">
|
||||
<h3>stopService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">stopService</span><wbr><span class="parameters">(org.bukkit.NamespacedKey service_name)</span></div>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">stopService</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull org.bukkit.NamespacedKey service_name,
|
||||
@Nullable
|
||||
@Nullable reactor.core.publisher.Mono<reactor.core.Disposable> disposable)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service_name</code> - The name of the service to stop.</dd>
|
||||
<dd><code>disposable</code> - A <code>Disposable</code> object which contains the service that should be disposed.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code> object which can be used to stop the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getService(org.bukkit.NamespacedKey)">
|
||||
<h3>getService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>></span> <span class="element-name">getService</span><wbr><span class="parameters">(org.bukkit.NamespacedKey service_name)</span></div>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a>></span> <span class="element-name">getService</span><wbr><span class="parameters">(org.bukkit.NamespacedKey service_name)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service_name</code> - The name of the service to get.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="removeService(io.github.simplex.api.IService)">
|
||||
<h3>removeService</h3>
|
||||
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplex.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to remove from the pool's service collection.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="recycle()">
|
||||
<h3>recycle</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></span> <span class="element-name">recycle</span>()</div>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></span> <span class="element-name">recycle</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>This service pool after being cleared of all services.
|
||||
You will need to register services with this pool again before using it.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getScheduler()">
|
||||
<h3>getScheduler</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.scheduler.Scheduler</span> <span class="element-name">getScheduler</span>()</div>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true)
|
||||
</span><span class="modifiers">public</span> <span class="return-type">reactor.core.scheduler.Scheduler</span> <span class="element-name">getScheduler</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The <code>Scheduler</code> which hosts the threads for the service pool.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>io.github.simplex.simplexss</title>
|
||||
<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-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="declaration: package: io.github.simplex.simplexss">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
||||
<title>io.github.simplex.simplexss Class Hierarchy</title>
|
||||
<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-12">
|
||||
<meta name="dc.created" content="2022-12-13">
|
||||
<meta name="description" content="tree: package: io.github.simplex.simplexss">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||||
|
Reference in New Issue
Block a user