SimplexDevelopment/SimplexSS
1
0
Fork 0
mirror of https://github.com/SimplexDevelopment/SimplexSS.git synced 2024-11-15 06:03:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
main
SimplexSS/docs/io/github/simplex/api/IService.html

285 lines
18 KiB
HTML
Raw Permalink Normal View History

Docs
2022-12-13 02:41:22 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
Docs
2022-12-13 02:41:22 +00:00
<title>IService</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<meta name="dc.created" content="2022-12-13">
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: IService">
Docs
2022-12-13 02:41:22 +00:00
<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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.api</a></div>
Docs
2022-12-13 02:41:22 +00:00
<h1 title="Interface IService" class="title">Interface IService</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><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>All Known Implementing Classes:</dt>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<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>
Docs
2022-12-13 02:41:22 +00:00
</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">
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></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab1"><code>static @NotNull org.bukkit.NamespacedKey</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#getDefaultNamespacedKey()" class="member-name-link">getDefaultNamespacedKey</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3">&nbsp;</div>
<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>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<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>
Docs
2022-12-13 02:41:22 +00:00
<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>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.bukkit.plugin.java.JavaPlugin</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPlugin()" class="member-name-link">getPlugin</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>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3">&nbsp;</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static @NotNull org.bukkit.NamespacedKey</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#newNamespacedKey(java.lang.String,java.lang.String)" class="member-name-link">newNamespacedKey</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;space,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
<div class="block">This is an easy static call for creating a new namespaced key for services and service pools.</div>
Docs
2022-12-13 02:41:22 +00:00
</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
Docs
2022-12-13 02:41:22 +00:00
<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>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#start()" class="member-name-link">start</a>()</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="block">The actual start method for the service.</div>
</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="#stop()" class="member-name-link">stop</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
Docs
2022-12-13 02:41:22 +00:00
<div class="block">The actual end method for the service.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getDefaultNamespacedKey()">
<h3>getDefaultNamespacedKey</h3>
<div class="member-signature"><span class="annotations">@Contract(" -&gt; new")
@NotNull
</span><span class="modifiers">static</span>&nbsp;<span class="return-type">@NotNull org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">getDefaultNamespacedKey</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getNamespacedKey()">
<h3>getNamespacedKey</h3>
<div class="member-signature"><span class="return-type">org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">getNamespacedKey</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The NamespacedKey of this service.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isPeriodic()">
<h3>isPeriodic</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isPeriodic</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>If the service should be scheduled for repeated executions or not.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPeriod()">
<h3>getPeriod</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getPeriod</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>How long the service should wait between subsequent executions.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDelay()">
<h3>getDelay</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getDelay</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>How long the service should wait before executing the first time.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="start()">
<h3>start</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">start</span>()</div>
<div class="block">The actual start method for the service. This should be overridden by subclasses,
and should include all the required code necessary to execute when the service is queued.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>An encapsulated Mono object representing the start method for the service.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="stop()">
<h3>stop</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">stop</span>()</div>
<div class="block">The actual end method for the service. This should be overridden by subclasses,
and should include all the required code necessary to execute when the service is stopped.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>An encapsulated Mono object representing the end method for the service.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPlugin()">
<h3>getPlugin</h3>
<div class="member-signature"><span class="return-type">org.bukkit.plugin.java.JavaPlugin</span>&nbsp;<span class="element-name">getPlugin</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The plugin which was defined in the constructor.
This should be an instance of your main plugin class.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getParentPool()">
<h3>getParentPool</h3>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<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>
Docs
2022-12-13 02:41:22 +00:00
<dl class="notes">
<dt>Returns:</dt>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<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>
Docs
2022-12-13 02:41:22 +00:00
</dl>
</section>
</li>
<li>
<section class="detail" id="run()">
<h3>run</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">run</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Runnable.html#run()" title="class or interface in java.lang" class="external-link">run</a></code>&nbsp;in interface&nbsp;<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>
</section>
</li>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<li>
<section class="detail" id="newNamespacedKey(java.lang.String,java.lang.String)">
<h3>newNamespacedKey</h3>
<div class="member-signature"><span class="annotations">@Contract("_, _ -&gt; new")
@NotNull
</span><span class="modifiers">static</span>&nbsp;<span class="return-type">@NotNull org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">newNamespacedKey</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;space,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key)</span></div>
<div class="block">This is an easy static call for creating a new namespaced key for services and service pools.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>space</code> - The namespace of the service.</dd>
<dd><code>key</code> - The key name of the service.</dd>
<dt>Returns:</dt>
<dd>A NamespacedKey object representing the service.</dd>
</dl>
</section>
</li>
Docs
2022-12-13 02:41:22 +00:00
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink