<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (17) on Wed Dec 14 11:14:32 CST 2022 --> <title>ExecutableService</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="dc.created" content="2022-12-14"> <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"> <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="../../../../index-files/index-1.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>Nested | </li> <li><a href="#field-summary">Field</a> | </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><a href="#field-detail">Field</a> | </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.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.simplexdevelopment.scheduler.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.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.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.simplexdevelopment.api">IService</a></span></div> </section> <section class="summary"> <ul class="summary-list"> <!-- =========== FIELD SUMMARY =========== --> <li> <section class="field-summary" id="field-summary"> <h2>Field Summary</h2> <div class="caption"><span>Fields</span></div> <div class="summary-table three-column-summary"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Field</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color"><code>private boolean</code></div> <div class="col-second even-row-color"><code><a href="#cancelled" class="member-name-link">cancelled</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code>private final long</code></div> <div class="col-second odd-row-color"><code><a href="#delay" class="member-name-link">delay</a></code></div> <div class="col-last odd-row-color"> </div> <div class="col-first even-row-color"><code>private final boolean</code></div> <div class="col-second even-row-color"><code><a href="#mayInterruptWhenRunning" class="member-name-link">mayInterruptWhenRunning</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code>private <a href="../scheduler/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"> </div> <div class="col-first even-row-color"><code>private final long</code></div> <div class="col-second even-row-color"><code><a href="#period" class="member-name-link">period</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code>private final boolean</code></div> <div class="col-second odd-row-color"><code><a href="#repeating" class="member-name-link">repeating</a></code></div> <div class="col-last odd-row-color"> </div> <div class="col-first even-row-color"><code>private final org.bukkit.NamespacedKey</code></div> <div class="col-second even-row-color"><code><a href="#service_name" class="member-name-link">service_name</a></code></div> <div class="col-last even-row-color"> </div> </div> </section> </li> <!-- ======== 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.NamespacedKey)" class="member-name-link">ExecutableService</a><wbr>(@NotNull org.bukkit.NamespacedKey service_name)</code></div> <div class="col-last even-row-color"> <div class="block">Creates a new instance of an executable service.</div> </div> <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.scheduler.ServicePool,org.bukkit.NamespacedKey)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool, @NotNull org.bukkit.NamespacedKey service_name)</code></div> <div class="col-last odd-row-color"> <div class="block">Creates a new instance of an executable service.</div> </div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.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="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool, @NotNull org.bukkit.NamespacedKey service_name, @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay, @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period, @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating)</code></div> <div class="col-last even-row-color"> <div class="block">Creates a new instance of an executable service.</div> </div> <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.scheduler.ServicePool,org.bukkit.NamespacedKey,java.lang.Long)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool, @NotNull org.bukkit.NamespacedKey service_name, @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay)</code></div> <div class="col-last odd-row-color"> <div class="block">Creates a new instance of an executable service.</div> </div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.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="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool, @NotNull org.bukkit.NamespacedKey service_name, @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay, @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period, @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating, @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> mayInterruptWhenRunning)</code></div> <div class="col-last even-row-color"> <div class="block">Creates a new instance of an executable service.</div> </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></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>(package private) reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#cancel()" class="member-name-link">cancel</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Actual stop call, to ensure that the service actually #isCancelled().</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDelay()" class="member-name-link">getDelay</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.bukkit.NamespacedKey</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNamespacedKey()" class="member-name-link">getNamespacedKey</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParentPool()" class="member-name-link">getParentPool</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPeriod()" class="member-name-link">getPeriod</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCancelled()" class="member-name-link">isCancelled</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Cancels the execution of this service.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPeriodic()" class="member-name-link">isPeriodic</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCancelled(boolean)" class="member-name-link">setCancelled</a><wbr>(boolean cancel)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Cancels the execution of this service.</div> </div> </div> </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-io.github.simplexdevelopment.api.IService">Methods inherited from interface 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> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ FIELD DETAIL =========== --> <li> <section class="field-details" id="field-detail"> <h2>Field Details</h2> <ul class="member-list"> <li> <section class="detail" id="service_name"> <h3>service_name</h3> <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.bukkit.NamespacedKey</span> <span class="element-name">service_name</span></div> </section> </li> <li> <section class="detail" id="delay"> <h3>delay</h3> <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">long</span> <span class="element-name">delay</span></div> </section> </li> <li> <section class="detail" id="period"> <h3>period</h3> <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">long</span> <span class="element-name">period</span></div> </section> </li> <li> <section class="detail" id="repeating"> <h3>repeating</h3> <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name">repeating</span></div> </section> </li> <li> <section class="detail" id="mayInterruptWhenRunning"> <h3>mayInterruptWhenRunning</h3> <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name">mayInterruptWhenRunning</span></div> </section> </li> <li> <section class="detail" id="cancelled"> <h3>cancelled</h3> <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">cancelled</span></div> </section> </li> <li> <section class="detail" id="parentPool"> <h3>parentPool</h3> <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></span> <span class="element-name">parentPool</span></div> </section> </li> </ul> </section> </li> <!-- ========= 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.NamespacedKey)"> <h3>ExecutableService</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@NotNull @NotNull org.bukkit.NamespacedKey service_name)</span></div> <div class="block">Creates a new instance of an executable service. Each service is registered with a <code>NamespacedKey</code>, to allow for easy identification within the associated <a href="../scheduler/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> </dl> </section> </li> <li> <section class="detail" id="<init>(io.github.simplexdevelopment.scheduler.ServicePool,org.bukkit.NamespacedKey)"> <h3>ExecutableService</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable @Nullable <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool, @NotNull @NotNull org.bukkit.NamespacedKey service_name)</span></div> <div class="block">Creates a new instance of an executable service. Each service is registered with a <code>NamespacedKey</code>, to allow for easy identification within the associated <a href="../scheduler/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="../scheduler/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="<init>(io.github.simplexdevelopment.scheduler.ServicePool,org.bukkit.NamespacedKey,java.lang.Long)"> <h3>ExecutableService</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable @Nullable <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool, @NotNull @NotNull org.bukkit.NamespacedKey service_name, @Nullable @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay)</span></div> <div class="block">Creates a new instance of an executable service. The timings are measured in ticks (20 ticks per second). You do not need to explicitly define a delay. Each service is registered with a <code>NamespacedKey</code>, to allow for easy identification within the associated <a href="../scheduler/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="../scheduler/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="<init>(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> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable @Nullable <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool, @NotNull @NotNull org.bukkit.NamespacedKey service_name, @NotNull @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay, @NotNull @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period, @NotNull @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating)</span></div> <div class="block">Creates a new instance of an executable service. The timings are measured in ticks (20 ticks per second). You do not need to explicitly define a delay or a period, however if you have flagged <a href="#repeating"><code>repeating</code></a> as true, and the period is null, then the period will automatically be set to 20 minutes. Each service is registered with a <code>NamespacedKey</code>, to allow for easy identification within the associated <a href="../scheduler/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="../scheduler/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> <dd><code>repeating</code> - If the service should be scheduled for repeated executions or not.</dd> </dl> </section> </li> <li> <section class="detail" id="<init>(io.github.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> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable @Nullable <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool, @NotNull @NotNull org.bukkit.NamespacedKey service_name, @Nullable @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay, @Nullable @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period, @NotNull @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating, @NotNull @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> mayInterruptWhenRunning)</span></div> <div class="block">Creates a new instance of an executable service. The timings are measured in ticks (20 ticks per second). You do not need to explicitly define a delay or a period, however if you have flagged <a href="#repeating"><code>repeating</code></a> as true, and the period is null, then the period will automatically be set to 20 minutes. Each service is registered with a <code>NamespacedKey</code>, to allow for easy identification within the associated <a href="../scheduler/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="../scheduler/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> <dd><code>repeating</code> - If the service should be scheduled for repeated executions or not.</dd> <dd><code>mayInterruptWhenRunning</code> - If the service can be cancelled during execution.</dd> </dl> </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="getNamespacedKey()"> <h3>getNamespacedKey</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.bukkit.NamespacedKey</span> <span class="element-name">getNamespacedKey</span>()</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="IService.html#getNamespacedKey()">getNamespacedKey</a></code> in interface <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> </section> </li> <li> <section class="detail" id="getDelay()"> <h3>getDelay</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getDelay</span>()</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="IService.html#getDelay()">getDelay</a></code> in interface <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> </section> </li> <li> <section class="detail" id="getPeriod()"> <h3>getPeriod</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getPeriod</span>()</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="IService.html#getPeriod()">getPeriod</a></code> in interface <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> </section> </li> <li> <section class="detail" id="isPeriodic()"> <h3>isPeriodic</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isPeriodic</span>()</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="IService.html#isPeriodic()">isPeriodic</a></code> in interface <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> </section> </li> <li> <section class="detail" id="isCancelled()"> <h3>isCancelled</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCancelled</span>()</div> <div class="block">Cancels the execution of this service.</div> <dl class="notes"> <dt>Returns:</dt> <dd>true if the service was cancelled, false if not.</dd> </dl> </section> </li> <li> <section class="detail" id="setCancelled(boolean)"> <h3>setCancelled</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">setCancelled</span><wbr><span class="parameters">(boolean cancel)</span></div> <div class="block">Cancels the execution of this service.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>cancel</code> - Whether the service should be cancelled or not.</dd> </dl> </section> </li> <li> <section class="detail" id="cancel()"> <h3>cancel</h3> <div class="member-signature"><span class="annotations">@Contract(pure=true) </span><span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">cancel</span>()</div> <div class="block">Actual stop call, to ensure that the service actually #isCancelled().</div> </section> </li> <li> <section class="detail" id="getParentPool()"> <h3>getParentPool</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">getParentPool</span>()</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="IService.html#getParentPool()">getParentPool</a></code> in interface <code><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd> <dt>Returns:</dt> <dd>The <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> which this service is executing on.</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>