<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (17) --> <title>ReactorBukkitScheduler (SimplexSS 1.0.1 API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, class: ReactorBukkitScheduler"> <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"> <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="class-declaration-page"> <script type="text/javascript">var evenRowColor = "even-row-color"; var oddRowColor = "odd-row-color"; var tableTab = "table-tab"; var activeTableTab = "active-table-tab"; 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><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html#class">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </li> <li><a href="#nested-class-summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor-summary">Constr</a> | </li> <li><a href="#method-summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor-detail">Constr</a> | </li> <li><a href="#method-detail">Method</a></li> </ul> </div> <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"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">io.github.simplexdevelopment.scheduler</a></div> <h1 title="Class ReactorBukkitScheduler" class="title">Class ReactorBukkitScheduler</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.simplexdevelopment.scheduler.ReactorBukkitScheduler</div> </div> <section class="class-description" id="class-description"> <dl class="notes"> <dt>All Implemented Interfaces:</dt> <dd><code>reactor.core.Disposable</code>, <code>reactor.core.scheduler.Scheduler</code>, <code>reactor.core.scheduler.Scheduler.Worker</code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ReactorBukkitScheduler</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 reactor.core.scheduler.Scheduler, reactor.core.scheduler.Scheduler.Worker</span></div> <div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>. This will allow us to perform non-blocking operations on the main server thread.</div> </section> <section class="summary"> <ul class="summary-list"> <!-- ======== NESTED CLASS SUMMARY ======== --> <li> <section class="nested-class-summary" id="nested-class-summary"> <h2>Nested Class Summary</h2> <div class="inherited-list"> <h2 id="nested-classes-inherited-from-class-reactor.core.Disposable">Nested classes/interfaces inherited from interface reactor.core.Disposable</h2> <code>reactor.core.Disposable.Composite, reactor.core.Disposable.Swap</code></div> <div class="inherited-list"> <h2 id="nested-classes-inherited-from-class-reactor.core.scheduler.Scheduler">Nested classes/interfaces inherited from interface reactor.core.scheduler.Scheduler</h2> <code>reactor.core.scheduler.Scheduler.Worker</code></div> </section> </li> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <li> <section class="constructor-summary" id="constructor-summary"> <h2>Constructor Summary</h2> <div class="caption"><span>Constructors</span></div> <div class="summary-table two-column-summary"> <div class="table-header col-first">Constructor</div> <div class="table-header col-last">Description</div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ReactorBukkitScheduler</a><wbr>(org.bukkit.plugin.java.JavaPlugin plugin)</code></div> <div class="col-last even-row-color"> </div> </div> </section> </li> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method-summary"> <h2>Method Summary</h2> <div id="method-summary-table"> <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> <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-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.scheduler.Scheduler.Worker</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createWorker()" class="member-name-link">createWorker</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">A new <code>Scheduler.Worker</code>.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#dispose()" class="member-name-link">dispose</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> <div class="block"><span class="deprecated-label">Deprecated.</span></div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.Disposable</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#schedule(java.lang.Runnable)" class="member-name-link">schedule</a><wbr>(@NotNull <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> task)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Delegates to the <code>BukkitScheduler</code>.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.Disposable</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#schedule(java.lang.Runnable,long,java.util.concurrent.TimeUnit)" class="member-name-link">schedule</a><wbr>(@NotNull <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> task, long delay, @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Delegates to the <code>BukkitScheduler</code> with a delay.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.Disposable</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#schedulePeriodically(java.lang.Runnable,long,long,java.util.concurrent.TimeUnit)" class="member-name-link">schedulePeriodically</a><wbr>(@NotNull <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> task, long initialDelay, long period, @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Delegates to the <code>BukkitScheduler</code> with a delay and a period.</div> </div> </div> </div> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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-reactor.core.Disposable">Methods inherited from interface reactor.core.Disposable</h3> <code>isDisposed</code></div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-reactor.core.scheduler.Scheduler">Methods inherited from interface reactor.core.scheduler.Scheduler</h3> <code>disposeGracefully, now, start</code></div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <li> <section class="constructor-details" id="constructor-detail"> <h2>Constructor Details</h2> <ul class="member-list"> <li> <section class="detail" id="<init>(org.bukkit.plugin.java.JavaPlugin)"> <h3>ReactorBukkitScheduler</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReactorBukkitScheduler</span><wbr><span class="parameters">(org.bukkit.plugin.java.JavaPlugin plugin)</span></div> </section> </li> </ul> </section> </li> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method-detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="schedule(java.lang.Runnable)"> <h3>schedule</h3> <div class="member-signature"><span class="annotations">@NotNull </span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.Disposable</span> <span class="element-name">schedule</span><wbr><span class="parameters">(@NotNull @NotNull <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> task)</span></div> <div class="block">Delegates to the <code>BukkitScheduler</code>.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code>schedule</code> in interface <code>reactor.core.scheduler.Scheduler</code></dd> <dt>Specified by:</dt> <dd><code>schedule</code> in interface <code>reactor.core.scheduler.Scheduler.Worker</code></dd> <dt>Parameters:</dt> <dd><code>task</code> - The task to delegate.</dd> <dt>Returns:</dt> <dd>A disposable that can be used to cancel the task.</dd> </dl> </section> </li> <li> <section class="detail" id="schedule(java.lang.Runnable,long,java.util.concurrent.TimeUnit)"> <h3>schedule</h3> <div class="member-signature"><span class="annotations">@NotNull </span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.Disposable</span> <span class="element-name">schedule</span><wbr><span class="parameters">(@NotNull @NotNull <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> task, long delay, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> @Nullable @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span></div> <div class="block">Delegates to the <code>BukkitScheduler</code> with a delay.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code>schedule</code> in interface <code>reactor.core.scheduler.Scheduler</code></dd> <dt>Specified by:</dt> <dd><code>schedule</code> in interface <code>reactor.core.scheduler.Scheduler.Worker</code></dd> <dt>Parameters:</dt> <dd><code>task</code> - The task to delegate</dd> <dd><code>delay</code> - The amount of time to wait before running the task</dd> <dd><code>unit</code> - Unused parameter in this implementation. Regardless of what value you use, this parameter will never be called.</dd> <dt>Returns:</dt> <dd>A disposable that can be used to cancel the task.</dd> </dl> </section> </li> <li> <section class="detail" id="schedulePeriodically(java.lang.Runnable,long,long,java.util.concurrent.TimeUnit)"> <h3>schedulePeriodically</h3> <div class="member-signature"><span class="annotations">@NotNull </span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.Disposable</span> <span class="element-name">schedulePeriodically</span><wbr><span class="parameters">(@NotNull @NotNull <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> task, long initialDelay, long period, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> @Nullable @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span></div> <div class="block">Delegates to the <code>BukkitScheduler</code> with a delay and a period. The initial delay may be 0L, but the period must be greater than 0L.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code>schedulePeriodically</code> in interface <code>reactor.core.scheduler.Scheduler</code></dd> <dt>Specified by:</dt> <dd><code>schedulePeriodically</code> in interface <code>reactor.core.scheduler.Scheduler.Worker</code></dd> <dt>Parameters:</dt> <dd><code>task</code> - The task to delegate.</dd> <dd><code>initialDelay</code> - The amount of time to wait before running the task.</dd> <dd><code>period</code> - The amount of time to wait between each execution of the task.</dd> <dd><code>unit</code> - Unused parameter in this implementation. Regardless of what value you use, this parameter will never be called.</dd> <dt>Returns:</dt> <dd>A disposable that can be used to cancel the task.</dd> </dl> </section> </li> <li> <section class="detail" id="createWorker()"> <h3>createWorker</h3> <div class="member-signature"><span class="annotations">@NotNull </span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.scheduler.Scheduler.Worker</span> <span class="element-name">createWorker</span>()</div> <div class="block">A new <code>Scheduler.Worker</code>.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code>createWorker</code> in interface <code>reactor.core.scheduler.Scheduler</code></dd> <dt>Returns:</dt> <dd>This class instance, as it implements <code>Scheduler.Worker</code>.</dd> </dl> </section> </li> <li> <section class="detail" id="dispose()"> <h3>dispose</h3> <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">dispose</span>()</div> <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> <div class="block">This method does nothing and is unused.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code>dispose</code> in interface <code>reactor.core.Disposable</code></dd> <dt>Specified by:</dt> <dd><code>dispose</code> in interface <code>reactor.core.scheduler.Scheduler</code></dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>