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

Update Docs

Browse Source
This commit is contained in:
Paldiu
2022-12-14 23:08:12 -06:00
parent 43070f9e2a
commit 43dee08554
85 changed files with 803 additions and 530 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
build/docs/javadoc/io/github/simplexdevelopment/api/Context.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Context (SimplexSS 1.0.0 API)</title>
<title>Context (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: Context">
@ -73,11 +73,12 @@ loadScripts(document, 'script');</script>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></code></dd>
<dt>Type Parameters:</dt>
<dd><code>S</code> - Any object type to wrap with this class.</dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Context&lt;S&gt;</span></div>
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
</section>
<section class="summary">
<ul class="summary-list">

3
build/docs/javadoc/io/github/simplexdevelopment/api/ISchedule.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ISchedule (SimplexSS 1.0.0 API)</title>
<title>ISchedule (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: ISchedule">
@ -78,6 +78,7 @@ loadScripts(document, 'script');</script>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISchedule</span></div>
<div class="block">This interface contains surface level methods for the <a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
</section>
<section class="summary">
<ul class="summary-list">

6
build/docs/javadoc/io/github/simplexdevelopment/api/IService.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>IService (SimplexSS 1.0.0 API)</title>
<title>IService (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: IService">
@ -83,6 +83,10 @@ loadScripts(document, 'script');</script>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IService</span><span class="extends-implements">
extends <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>, <a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></span></div>
<div class="block">Represents a service that can be registered to a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.
<p>
This interface provides surface level methods to be used by the <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>
associated to each service.</div>
</section>
<section class="summary">
<ul class="summary-list">

5
build/docs/javadoc/io/github/simplexdevelopment/api/Identifier.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Identifier (SimplexSS 1.0.0 API)</title>
<title>Identifier (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: Identifier">
@ -78,10 +78,11 @@ loadScripts(document, 'script');</script>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></code>, <code><a href="../impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></code></dd>
<dd><code><a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></code>, <code><a href="../impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></code>, <code><a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Identifier</span></div>
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
</section>
<section class="summary">
<ul class="summary-list">

5
build/docs/javadoc/io/github/simplexdevelopment/api/ServiceException.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ServiceException (SimplexSS 1.0.0 API)</title>
<title>ServiceException (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, class: ServiceException">
@ -88,6 +88,9 @@ loadScripts(document, 'script');</script>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ServiceException</span>
<span class="extends-implements">extends <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">RuntimeException</a></span></div>
<div class="block">This class is used to represent a service exception.
When a <a href="IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a> is called that has not been registered with a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>,
this exception will be thrown.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>

6
build/docs/javadoc/io/github/simplexdevelopment/api/ServicePoolException.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ServicePoolException (SimplexSS 1.0.0 API)</title>
<title>ServicePoolException (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, class: ServicePoolException">
@ -88,6 +88,10 @@ loadScripts(document, 'script');</script>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ServicePoolException</span>
<span class="extends-implements">extends <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">RuntimeException</a></span></div>
<div class="block">This class is used to represent a service pool exception.
This exception is thrown when a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> is not found,
when <a href="../scheduler/ServicePool.html#queueService(io.github.simplexdevelopment.api.IService)"><code>ServicePool.queueService(IService)</code></a> is called but the service is not registered with this pool,
or if the service pool is empty and <a href="../scheduler/ServicePool.html#queueServices()"><code>ServicePool.queueServices()</code></a> is called.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>

26
build/docs/javadoc/io/github/simplexdevelopment/api/package-summary.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>io.github.simplexdevelopment.api (SimplexSS 1.0.0 API)</title>
<title>io.github.simplexdevelopment.api (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api">
@ -74,17 +74,29 @@ loadScripts(document, 'script');</script>
<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.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-last even-row-color class-summary class-summary-tab1">
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
</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-last even-row-color class-summary class-summary-tab1">
<div class="block">This interface contains surface level methods for the <a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
</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 class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Represents a service that can be registered to a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">&nbsp;</div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">This class is used to represent a service exception.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">&nbsp;</div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">This class is used to represent a service pool exception.</div>
</div>
</div>
</div>
</div>

2
build/docs/javadoc/io/github/simplexdevelopment/api/package-tree.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>io.github.simplexdevelopment.api Class Hierarchy (SimplexSS 1.0.0 API)</title>
<title>io.github.simplexdevelopment.api Class Hierarchy (SimplexSS 1.0.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="tree: package: io.github.simplexdevelopment.api">