188 lines
20 KiB
HTML
188 lines
20 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
|
<title>S-Index</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-14">
|
|
<meta name="description" content="index: S">
|
|
<meta name="generator" content="javadoc/IndexWriter">
|
|
<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">
|
|
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../script.js"></script>
|
|
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="index-page">
|
|
<script type="text/javascript">var pathtoroot = "../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../index.html">Overview</a></li>
|
|
<li>Package</li>
|
|
<li>Class</li>
|
|
<li><a href="../overview-tree.html">Tree</a></li>
|
|
<li><a href="../deprecated-list.html">Deprecated</a></li>
|
|
<li class="nav-bar-cell1-rev">Index</li>
|
|
<li><a href="../help-doc.html#index">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<div class="header">
|
|
<h1>Index</h1>
|
|
</div>
|
|
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a>
|
|
<h2 class="title" id="I:S">S</h2>
|
|
<dl class="index">
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#schedule(java.lang.Runnable)" class="member-name-link">schedule(Runnable)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
|
<dd>
|
|
<div class="block">Delegates to the <code>BukkitScheduler</code>.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#schedule(java.lang.Runnable,long,java.util.concurrent.TimeUnit)" class="member-name-link">schedule(Runnable, long, TimeUnit)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
|
<dd>
|
|
<div class="block">Delegates to the <code>BukkitScheduler</code> with a delay.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#schedulePeriodically(java.lang.Runnable,long,long,java.util.concurrent.TimeUnit)" class="member-name-link">schedulePeriodically(Runnable, long, long, TimeUnit)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
|
<dd>
|
|
<div class="block">Delegates to the <code>BukkitScheduler</code> with a delay and a period.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/impl/Main.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
|
<dd>
|
|
<div class="block">The bukkit scheduler.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
|
<dd>
|
|
<div class="block">The scheduler used to run the services in this pool.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
|
<dd>
|
|
<div class="block">This class is used to manage the scheduling of <a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
|
and the creation of <a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#%3Cinit%3E(T)" class="member-name-link">SchedulingSystem(T)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
|
<dd>
|
|
<div class="block">Creates a new instance of the scheduling system.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#service_name" class="member-name-link">service_name</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
|
<dd>
|
|
<div class="block">The name of the service.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServiceException</a> - Exception in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
|
<dd>
|
|
<div class="block">This class is used to represent a service exception.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html#%3Cinit%3E(io.github.simplexdevelopment.api.IService)" class="member-name-link">ServiceException(IService)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new service exception which states the service is not present within any service pools.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">ServiceException(Throwable)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a> - Class in <a href="../io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#%3Cinit%3E(io.github.simplexdevelopment.impl.Main,io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">ServiceImpl(Main, ServicePool)</a> - Constructor for class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#serviceManager" class="member-name-link">serviceManager</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
|
<dd>
|
|
<div class="block">The service manager to use for controlling service pools.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
|
<dd>
|
|
<div class="block">The ServiceManager is a factory class for managing <a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#%3Cinit%3E()" class="member-name-link">ServiceManager()</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
|
<dd>
|
|
<div class="block">Creates a new instance of the Service Manager class.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
|
<dd>
|
|
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#%3Cinit%3E(java.lang.String,boolean)" class="member-name-link">ServicePool(String, boolean)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
|
<dd>
|
|
<div class="block">This will create a new instance of a Service Pool with a <code>Scheduler</code> as its main scheduler.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#%3Cinit%3E(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ServicePool(String, JavaPlugin)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
|
<dd>
|
|
<div class="block">This will create a new instance of a Service Pool with the <a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> as its main scheduler.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServicePoolException</a> - Exception in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
|
<dd>
|
|
<div class="block">This class is used to represent a service pool exception.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html#%3Cinit%3E()" class="member-name-link">ServicePoolException()</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new generic service pool exception.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">ServicePoolException(String)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">ServicePoolException(Throwable)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#servicePools" class="member-name-link">servicePools</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
|
<dd>
|
|
<div class="block">A set of <a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s which are currently active.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#setCancelled(boolean)" class="member-name-link">setCancelled(boolean)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
|
<dd>
|
|
<div class="block">Cancels the execution of this service.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/Context.html#setContext(S)" class="member-name-link">setContext(S)</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/IService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setParentPool(ServicePool)</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
|
<dd>
|
|
<div class="block">Sets the parent pool for this service.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setParentPool(ServicePool)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/IService.html#start()" class="member-name-link">start()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
|
<dd>
|
|
<div class="block">The actual start method for the service.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#start()" class="member-name-link">start()</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/IService.html#stop()" class="member-name-link">stop()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
|
<dd>
|
|
<div class="block">The actual end method for the service.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#stop()" class="member-name-link">stop()</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#stopService(java.lang.String,reactor.core.publisher.Mono)" class="member-name-link">stopService(String, Mono<Disposable>)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
|
<dd>
|
|
<div class="block">This is the method used to stop a service.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices(Flux<Disposable>)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
|
<dd>
|
|
<div class="block">This method can be used to stop all the services registered with this pool.</div>
|
|
</dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html#supplyException()" class="member-name-link">supplyException()</a> - Static method in exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html#supplyException(io.github.simplexdevelopment.api.IService)" class="member-name-link">supplyException(IService)</a> - Static method in exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
|
|
<dd> </dd>
|
|
</dl>
|
|
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|