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

Added Bukkit communication with BukkitScheduler

Browse Source
This commit is contained in:
Paldiu
2022-12-14 11:15:42 -06:00
parent 329726ed95
commit 262115a52e
78 changed files with 5535 additions and 711 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/io/github/simplex/api/Context.html
View File

@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-12-13">
<meta name="description" content="declaration: package: io.github.simplex.api, interface: Context">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: Context">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
@ -68,7 +68,7 @@ loadScripts(document, 'script');</script>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplex.api</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.api</a></div>
<h1 title="Interface Context" class="title">Interface Context&lt;S&gt;</h1>
</div>
<section class="class-description" id="class-description">

76
docs/io/github/simplex/api/ExecutableService.html
View File

@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-12-13">
<meta name="description" content="declaration: package: io.github.simplex.api, class: ExecutableService">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, class: ExecutableService">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
@ -68,25 +68,25 @@ loadScripts(document, 'script');</script>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplex.api</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.api</a></div>
<h1 title="Class ExecutableService" class="title">Class ExecutableService</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">io.github.simplex.api.ExecutableService</div>
<div class="inheritance">io.github.simplexdevelopment.api.ExecutableService</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="IService.html" title="interface in io.github.simplex.api">IService</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a></code></dd>
<dd><code><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../impl/ServiceImpl.html" title="class in io.github.simplex.impl">ServiceImpl</a></code></dd>
<dd><code><a href="../impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ExecutableService</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="IService.html" title="interface in io.github.simplex.api">IService</a></span></div>
implements <a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
@ -108,7 +108,7 @@ 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">&nbsp;</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-first odd-row-color"><code>private <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">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">&nbsp;</div>
<div class="col-first even-row-color"><code>private final long</code></div>
@ -135,12 +135,12 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<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>&nbsp;parentPool,
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.scheduler.ServicePool,org.bukkit.NamespacedKey)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&nbsp;parentPool,
@NotNull org.bukkit.NamespacedKey&nbsp;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>&nbsp;parentPool,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.scheduler.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.simplexdevelopment.scheduler">ServicePool</a>&nbsp;parentPool,
@NotNull org.bukkit.NamespacedKey&nbsp;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>&nbsp;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>&nbsp;period,
@ -148,13 +148,13 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<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>&nbsp;parentPool,
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.scheduler.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.simplexdevelopment.scheduler">ServicePool</a>&nbsp;parentPool,
@NotNull org.bukkit.NamespacedKey&nbsp;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>&nbsp;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>&nbsp;parentPool,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.scheduler.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.simplexdevelopment.scheduler">ServicePool</a>&nbsp;parentPool,
@NotNull org.bukkit.NamespacedKey&nbsp;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>&nbsp;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>&nbsp;period,
@ -188,7 +188,7 @@ 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">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>&gt;</code></div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono&lt;<a href="../simplexss/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="#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">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
@ -214,7 +214,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-io.github.simplex.api.IService">Methods inherited from interface&nbsp;io.github.simplex.api.<a href="IService.html" title="interface in io.github.simplex.api">IService</a></h3>
<h3 id="methods-inherited-from-class-io.github.simplexdevelopment.api.IService">Methods inherited from interface&nbsp;io.github.simplexdevelopment.api.<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></h3>
<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>
@ -266,7 +266,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<li>
<section class="detail" id="parentPool">
<h3>parentPool</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a></span>&nbsp;<span class="element-name">parentPool</span></div>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></span>&nbsp;<span class="element-name">parentPool</span></div>
</section>
</li>
</ul>
@ -284,7 +284,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
@NotNull org.bukkit.NamespacedKey&nbsp;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>
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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>
@ -292,27 +292,27 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey)">
<section class="detail" id="&lt;init&gt;(io.github.simplexdevelopment.scheduler.ServicePool,org.bukkit.NamespacedKey)">
<h3>ExecutableService</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;parentPool,
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&nbsp;parentPool,
@NotNull
@NotNull org.bukkit.NamespacedKey&nbsp;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>
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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="&lt;init&gt;(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long)">
<section class="detail" id="&lt;init&gt;(io.github.simplexdevelopment.scheduler.ServicePool,org.bukkit.NamespacedKey,java.lang.Long)">
<h3>ExecutableService</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;parentPool,
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&nbsp;parentPool,
@NotNull
@NotNull org.bukkit.NamespacedKey&nbsp;service_name,
@Nullable
@ -321,20 +321,20 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
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>
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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="&lt;init&gt;(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean)">
<section class="detail" id="&lt;init&gt;(io.github.simplexdevelopment.scheduler.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>&nbsp;<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>&nbsp;parentPool,
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&nbsp;parentPool,
@NotNull
@NotNull org.bukkit.NamespacedKey&nbsp;service_name,
@NotNull
@ -349,10 +349,10 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
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>
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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>
@ -361,10 +361,10 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)">
<section class="detail" id="&lt;init&gt;(io.github.simplexdevelopment.scheduler.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>&nbsp;<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>&nbsp;parentPool,
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&nbsp;parentPool,
@NotNull
@NotNull org.bukkit.NamespacedKey&nbsp;service_name,
@Nullable
@ -381,10 +381,10 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
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>
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><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>
@ -407,7 +407,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">getNamespacedKey</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IService.html#getNamespacedKey()">getNamespacedKey</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplex.api">IService</a></code></dd>
<dd><code><a href="IService.html#getNamespacedKey()">getNamespacedKey</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd>
<dt>Returns:</dt>
<dd>The NamespacedKey of this service.</dd>
</dl>
@ -419,7 +419,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getDelay</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IService.html#getDelay()">getDelay</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplex.api">IService</a></code></dd>
<dd><code><a href="IService.html#getDelay()">getDelay</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd>
<dt>Returns:</dt>
<dd>How long the service should wait before executing the first time.</dd>
</dl>
@ -431,7 +431,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getPeriod</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IService.html#getPeriod()">getPeriod</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplex.api">IService</a></code></dd>
<dd><code><a href="IService.html#getPeriod()">getPeriod</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd>
<dt>Returns:</dt>
<dd>How long the service should wait between subsequent executions.</dd>
</dl>
@ -443,7 +443,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isPeriodic</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IService.html#isPeriodic()">isPeriodic</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplex.api">IService</a></code></dd>
<dd><code><a href="IService.html#isPeriodic()">isPeriodic</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd>
<dt>Returns:</dt>
<dd>If the service should be scheduled for repeated executions or not.</dd>
</dl>
@ -482,12 +482,12 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
<li>
<section class="detail" id="getParentPool()">
<h3>getParentPool</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">getParentPool</span>()</div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">getParentPool</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IService.html#getParentPool()">getParentPool</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplex.api">IService</a></code></dd>
<dd><code><a href="IService.html#getParentPool()">getParentPool</a></code>&nbsp;in interface&nbsp;<code><a href="IService.html" title="interface in io.github.simplexdevelopment.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>
<dd>The <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> which this service is executing on.</dd>
</dl>
</section>
</li>

36
docs/io/github/simplex/api/ISchedule.html
View File

@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-12-13">
<meta name="description" content="declaration: package: io.github.simplex.api, interface: ISchedule">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: ISchedule">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
@ -68,13 +68,13 @@ loadScripts(document, 'script');</script>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplex.api</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.api</a></div>
<h1 title="Interface ISchedule" class="title">Interface ISchedule</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../simplexss/SchedulingSystem.html" title="class in io.github.simplex.simplexss">SchedulingSystem</a></code></dd>
<dd><code><a href="../simplexss/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISchedule</span></div>
@ -93,19 +93,19 @@ loadScripts(document, 'script');</script>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>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-tab3"><code><a href="#forceStart(io.github.simplex.api.IService)" class="member-name-link">forceStart</a><wbr>(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#forceStart(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStart</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#forceStop(io.github.simplex.api.IService)" class="member-name-link">forceStop</a><wbr>(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#forceStop(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStop</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono&lt;<a href="../simplexss/ServiceManager.html" title="class in io.github.simplex.simplexss">ServiceManager</a>&gt;</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono&lt;<a href="../simplexss/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServiceManager()" class="member-name-link">getServiceManager</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#queue(io.github.simplex.api.IService)" class="member-name-link">queue</a><wbr>(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</code></div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono&lt;<a href="../simplexss/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-tab3"><code><a href="#queue(io.github.simplexdevelopment.api.IService)" class="member-name-link">queue</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>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-tab3"><code><a href="#runOnce(io.github.simplex.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
</div>
</div>
@ -124,7 +124,7 @@ loadScripts(document, 'script');</script>
<li>
<section class="detail" id="getServiceManager()">
<h3>getServiceManager</h3>
<div class="member-signature"><span class="return-type">reactor.core.publisher.Mono&lt;<a href="../simplexss/ServiceManager.html" title="class in io.github.simplex.simplexss">ServiceManager</a>&gt;</span>&nbsp;<span class="element-name">getServiceManager</span>()</div>
<div class="member-signature"><span class="return-type">reactor.core.publisher.Mono&lt;<a href="../simplexss/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a>&gt;</span>&nbsp;<span class="element-name">getServiceManager</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The service manager which exerts control over the service pools and their associated services.</dd>
@ -132,9 +132,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="queue(io.github.simplex.api.IService)">
<section class="detail" id="queue(io.github.simplexdevelopment.api.IService)">
<h3>queue</h3>
<div class="member-signature"><span class="return-type">reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">queue</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="return-type">reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">queue</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - The service to use to locate the associated service pool and queue the service for execution.</dd>
@ -145,9 +145,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="runOnce(io.github.simplex.api.IService)">
<section class="detail" id="runOnce(io.github.simplexdevelopment.api.IService)">
<h3>runOnce</h3>
<div class="member-signature"><span class="return-type">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">runOnce</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="return-type">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">runOnce</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - The service to run once.</dd>
@ -157,9 +157,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="forceStop(io.github.simplex.api.IService)">
<section class="detail" id="forceStop(io.github.simplexdevelopment.api.IService)">
<h3>forceStop</h3>
<div class="member-signature"><span class="return-type">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">forceStop</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="return-type">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">forceStop</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - The service to forcefully stop.</dd>
@ -169,9 +169,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="forceStart(io.github.simplex.api.IService)">
<section class="detail" id="forceStart(io.github.simplexdevelopment.api.IService)">
<h3>forceStart</h3>
<div class="member-signature"><span class="return-type">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">forceStart</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="return-type">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">forceStart</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - The service to forcefully start.</dd>

12
docs/io/github/simplex/api/IService.html
View File

@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-12-13">
<meta name="description" content="declaration: package: io.github.simplex.api, interface: IService">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: IService">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
@ -68,7 +68,7 @@ loadScripts(document, 'script');</script>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplex.api</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.api</a></div>
<h1 title="Interface IService" class="title">Interface IService</h1>
</div>
<section class="class-description" id="class-description">
@ -78,7 +78,7 @@ loadScripts(document, 'script');</script>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="ExecutableService.html" title="class in io.github.simplex.api">ExecutableService</a></code>, <code><a href="../impl/ServiceImpl.html" title="class in io.github.simplex.impl">ServiceImpl</a></code></dd>
<dd><code><a href="ExecutableService.html" title="class in io.github.simplexdevelopment.api">ExecutableService</a></code>, <code><a href="../impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IService</span><span class="extends-implements">
@ -106,7 +106,7 @@ 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>org.bukkit.NamespacedKey</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>&gt;</code></div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono&lt;<a href="../simplexss/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-tab3"><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-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div>
@ -237,10 +237,10 @@ extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/ja
<li>
<section class="detail" id="getParentPool()">
<h3>getParentPool</h3>
<div class="member-signature"><span class="return-type">reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">getParentPool</span>()</div>
<div class="member-signature"><span class="return-type">reactor.core.publisher.Mono&lt;<a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">getParentPool</span>()</div>
<dl class="notes">
<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>
<dd>The <a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> which this service is executing on.</dd>
</dl>
</section>
</li>

22
docs/io/github/simplex/api/InvalidServiceException.html
View File

@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-12-13">
<meta name="description" content="declaration: package: io.github.simplex.api, class: InvalidServiceException">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, class: InvalidServiceException">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
@ -68,14 +68,14 @@ loadScripts(document, 'script');</script>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplex.api</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.api</a></div>
<h1 title="Class InvalidServiceException" class="title">Class InvalidServiceException</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a>
<div class="inheritance">io.github.simplex.api.InvalidServiceException</div>
<div class="inheritance">io.github.simplexdevelopment.api.InvalidServiceException</div>
</div>
</div>
</div>
@ -92,7 +92,7 @@ loadScripts(document, 'script');</script>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../serialized-form.html#io.github.simplex.api.InvalidServiceException">Serialized Form</a></li>
<li><a href="../../../../serialized-form.html#io.github.simplexdevelopment.api.InvalidServiceException">Serialized Form</a></li>
</ul>
</dd>
</dl>
@ -107,7 +107,7 @@ 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(io.github.simplex.api.IService)" class="member-name-link">InvalidServiceException</a><wbr>(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.api.IService)" class="member-name-link">InvalidServiceException</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">InvalidServiceException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;th)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
@ -125,8 +125,8 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="InvalidServiceException.html" title="class in io.github.simplex.api">InvalidServiceException</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#supplyException(io.github.simplex.api.IService)" class="member-name-link">supplyException</a><wbr>(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="InvalidServiceException.html" title="class in io.github.simplexdevelopment.api">InvalidServiceException</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#supplyException(io.github.simplexdevelopment.api.IService)" class="member-name-link">supplyException</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
@ -149,9 +149,9 @@ loadScripts(document, 'script');</script>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(io.github.simplex.api.IService)">
<section class="detail" id="&lt;init&gt;(io.github.simplexdevelopment.api.IService)">
<h3>InvalidServiceException</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">InvalidServiceException</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">InvalidServiceException</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
</section>
</li>
<li>
@ -169,9 +169,9 @@ loadScripts(document, 'script');</script>
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="supplyException(io.github.simplex.api.IService)">
<section class="detail" id="supplyException(io.github.simplexdevelopment.api.IService)">
<h3>supplyException</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="InvalidServiceException.html" title="class in io.github.simplex.api">InvalidServiceException</a>&gt;</span>&nbsp;<span class="element-name">supplyException</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplex.api">IService</a>&nbsp;service)</span></div>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="InvalidServiceException.html" title="class in io.github.simplexdevelopment.api">InvalidServiceException</a>&gt;</span>&nbsp;<span class="element-name">supplyException</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
</section>
</li>
</ul>

12
docs/io/github/simplex/api/InvalidServicePoolException.html
View File

@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-12-13">
<meta name="description" content="declaration: package: io.github.simplex.api, class: InvalidServicePoolException">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, class: InvalidServicePoolException">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
@ -68,14 +68,14 @@ loadScripts(document, 'script');</script>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplex.api</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.api</a></div>
<h1 title="Class InvalidServicePoolException" class="title">Class InvalidServicePoolException</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a>
<div class="inheritance">io.github.simplex.api.InvalidServicePoolException</div>
<div class="inheritance">io.github.simplexdevelopment.api.InvalidServicePoolException</div>
</div>
</div>
</div>
@ -92,7 +92,7 @@ loadScripts(document, 'script');</script>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../serialized-form.html#io.github.simplex.api.InvalidServicePoolException">Serialized Form</a></li>
<li><a href="../../../../serialized-form.html#io.github.simplexdevelopment.api.InvalidServicePoolException">Serialized Form</a></li>
</ul>
</dd>
</dl>
@ -125,7 +125,7 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="InvalidServicePoolException.html" title="class in io.github.simplex.api">InvalidServicePoolException</a>&gt;</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="InvalidServicePoolException.html" title="class in io.github.simplexdevelopment.api">InvalidServicePoolException</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#supplyException()" class="member-name-link">supplyException</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
</div>
@ -173,7 +173,7 @@ loadScripts(document, 'script');</script>
<h3>supplyException</h3>
<div class="member-signature"><span class="annotations">@Contract(pure=true)
@NotNull
</span><span class="modifiers">public static</span>&nbsp;<span class="return-type">@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="InvalidServicePoolException.html" title="class in io.github.simplex.api">InvalidServicePoolException</a>&gt;</span>&nbsp;<span class="element-name">supplyException</span>()</div>
</span><span class="modifiers">public static</span>&nbsp;<span class="return-type">@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="InvalidServicePoolException.html" title="class in io.github.simplexdevelopment.api">InvalidServicePoolException</a>&gt;</span>&nbsp;<span class="element-name">supplyException</span>()</div>
</section>
</li>
</ul>

20
docs/io/github/simplex/api/package-summary.html
View File

@ -2,11 +2,11 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
<title>io.github.simplex.api</title>
<title>io.github.simplexdevelopment.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-13">
<meta name="description" content="declaration: package: io.github.simplex.api">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
@ -60,10 +60,10 @@ loadScripts(document, 'script');</script>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Package io.github.simplex.api" class="title">Package io.github.simplex.api</h1>
<h1 title="Package io.github.simplexdevelopment.api" class="title">Package io.github.simplexdevelopment.api</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">io.github.simplex.api</span></div>
<div class="package-signature">package <span class="element-name">io.github.simplexdevelopment.api</span></div>
<section class="summary">
<ul class="summary-list">
<li>
@ -73,17 +73,17 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Context.html" title="interface in io.github.simplex.api">Context</a>&lt;S&gt;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Context.html" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;S&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExecutableService.html" title="class in io.github.simplex.api">ExecutableService</a></div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExecutableService.html" title="class in io.github.simplexdevelopment.api">ExecutableService</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="InvalidServiceException.html" title="class in io.github.simplex.api">InvalidServiceException</a></div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="InvalidServiceException.html" title="class in io.github.simplexdevelopment.api">InvalidServiceException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="InvalidServicePoolException.html" title="class in io.github.simplex.api">InvalidServicePoolException</a></div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="InvalidServicePoolException.html" title="class in io.github.simplexdevelopment.api">InvalidServicePoolException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ISchedule.html" title="interface in io.github.simplex.api">ISchedule</a></div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IService.html" title="interface in io.github.simplex.api">IService</a></div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
</div>
</div>

18
docs/io/github/simplex/api/package-tree.html
View File

@ -2,11 +2,11 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
<title>io.github.simplex.api Class Hierarchy</title>
<title>io.github.simplexdevelopment.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-13">
<meta name="description" content="tree: package: io.github.simplex.api">
<meta name="description" content="tree: package: io.github.simplexdevelopment.api">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
@ -48,7 +48,7 @@ loadScripts(document, 'script');</script>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 class="title">Hierarchy For Package io.github.simplex.api</h1>
<h1 class="title">Hierarchy For Package io.github.simplexdevelopment.api</h1>
<span class="package-hierarchy-label">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../overview-tree.html">All Packages</a></li>
@ -59,15 +59,15 @@ loadScripts(document, 'script');</script>
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
<ul>
<li class="circle">io.github.simplex.api.<a href="ExecutableService.html" class="type-name-link" title="class in io.github.simplex.api">ExecutableService</a> (implements io.github.simplex.api.<a href="IService.html" title="interface in io.github.simplex.api">IService</a>)</li>
<li class="circle">io.github.simplexdevelopment.api.<a href="ExecutableService.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ExecutableService</a> (implements io.github.simplexdevelopment.api.<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>)</li>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" class="type-name-link external-link" title="class or interface in java.lang">Throwable</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" class="type-name-link external-link" title="class or interface in java.lang">Exception</a>
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" class="type-name-link external-link" title="class or interface in java.lang">RuntimeException</a>
<ul>
<li class="circle">io.github.simplex.api.<a href="InvalidServiceException.html" class="type-name-link" title="class in io.github.simplex.api">InvalidServiceException</a></li>
<li class="circle">io.github.simplex.api.<a href="InvalidServicePoolException.html" class="type-name-link" title="class in io.github.simplex.api">InvalidServicePoolException</a></li>
<li class="circle">io.github.simplexdevelopment.api.<a href="InvalidServiceException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">InvalidServiceException</a></li>
<li class="circle">io.github.simplexdevelopment.api.<a href="InvalidServicePoolException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">InvalidServicePoolException</a></li>
</ul>
</li>
</ul>
@ -81,11 +81,11 @@ loadScripts(document, 'script');</script>
<section class="hierarchy">
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
<ul>
<li class="circle">io.github.simplex.api.<a href="Context.html" class="type-name-link" title="interface in io.github.simplex.api">Context</a>&lt;S&gt;</li>
<li class="circle">io.github.simplex.api.<a href="ISchedule.html" class="type-name-link" title="interface in io.github.simplex.api">ISchedule</a></li>
<li class="circle">io.github.simplexdevelopment.api.<a href="Context.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;S&gt;</li>
<li class="circle">io.github.simplexdevelopment.api.<a href="ISchedule.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">ISchedule</a></li>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Runnable.html" class="type-name-link external-link" title="class or interface in java.lang">Runnable</a>
<ul>
<li class="circle">io.github.simplex.api.<a href="IService.html" class="type-name-link" title="interface in io.github.simplex.api">IService</a></li>
<li class="circle">io.github.simplexdevelopment.api.<a href="IService.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">IService</a></li>
</ul>
</li>
</ul>