SimplexDevelopment/SimplexSS
1
0
Fork 0
mirror of https://github.com/SimplexDevelopment/SimplexSS.git synced 2024-11-15 14:13:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
0805d44dc5
SimplexSS/docs/io/github/simplex/impl/ServiceImpl.html

258 lines
18 KiB
HTML
Raw 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>ServiceImpl</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.impl, class: ServiceImpl">
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><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&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.impl</a></div>
Docs
2022-12-13 02:41:22 +00:00
<h1 title="Class ServiceImpl" class="title">Class ServiceImpl</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>
Finalization
2022-12-14 18:57:45 +00:00
<div class="inheritance"><a href="../api/ExecutableService.html" title="class in io.github.simplexdevelopment.api">io.github.simplexdevelopment.scheduler.ExecutableService</a>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="inheritance">io.github.simplexdevelopment.impl.ServiceImpl</div>
Docs
2022-12-13 02:41:22 +00:00
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<dd><code><a href="../api/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>
Docs
2022-12-13 02:41:22 +00:00
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ServiceImpl</span>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<span class="extends-implements">extends <a href="../api/ExecutableService.html" title="class in io.github.simplexdevelopment.api">ExecutableService</a></span></div>
Docs
2022-12-13 02:41:22 +00:00
</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>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="col-first even-row-color"><code>private final <a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-second even-row-color"><code><a href="#plugin" class="member-name-link">plugin</a></code></div>
<div class="col-last even-row-color">&nbsp;</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>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplexdevelopment.impl.Main)" class="member-name-link">ServiceImpl</a><wbr>(<a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a>&nbsp;plugin)</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last even-row-color">&nbsp;</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>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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 even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&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-tab4"><code><a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></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-tab4"><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-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><code><a href="#start()" class="member-name-link">start</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The actual start method for the service.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop()" class="member-name-link">stop</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The actual end method for the service.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
Finalization
2022-12-14 18:57:45 +00:00
<h3 id="methods-inherited-from-class-io.github.simplexdevelopment.scheduler.ExecutableService">Methods inherited from class&nbsp;io.github.simplexdevelopment.api.<a href="../api/ExecutableService.html" title="class in io.github.simplexdevelopment.api">ExecutableService</a></h3>
Docs
2022-12-13 02:41:22 +00:00
<code><a href="../api/ExecutableService.html#getDelay()">getDelay</a>, <a href="../api/ExecutableService.html#getNamespacedKey()">getNamespacedKey</a>, <a href="../api/ExecutableService.html#getPeriod()">getPeriod</a>, <a href="../api/ExecutableService.html#isCancelled()">isCancelled</a>, <a href="../api/ExecutableService.html#isPeriodic()">isPeriodic</a>, <a href="../api/ExecutableService.html#setCancelled(boolean)">setCancelled</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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">
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<h3 id="methods-inherited-from-class-io.github.simplexdevelopment.api.IService">Methods inherited from interface&nbsp;io.github.simplexdevelopment.api.<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></h3>
Docs
2022-12-13 02:41:22 +00:00
<code><a href="../api/IService.html#run()">run</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="plugin">
<h3>plugin</h3>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></span>&nbsp;<span class="element-name">plugin</span></div>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<section class="detail" id="&lt;init&gt;(io.github.simplexdevelopment.impl.Main)">
Docs
2022-12-13 02:41:22 +00:00
<h3>ServiceImpl</h3>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ServiceImpl</span><wbr><span class="parameters">(<a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a>&nbsp;plugin)</span></div>
Docs
2022-12-13 02:41:22 +00:00
</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="start()">
<h3>start</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../api/IService.html#start()">IService</a></code></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="modifiers">public</span>&nbsp;<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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../api/IService.html#stop()">IService</a></code></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>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></span>&nbsp;<span class="element-name">getPlugin</span>()</div>
Docs
2022-12-13 02:41:22 +00:00
<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="modifiers">public</span>&nbsp;<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">
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dt>Specified by:</dt>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<dd><code><a href="../api/IService.html#getParentPool()">getParentPool</a></code>&nbsp;in interface&nbsp;<code><a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dt>Overrides:</dt>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<dd><code><a href="../api/ExecutableService.html#getParentPool()">getParentPool</a></code>&nbsp;in class&nbsp;<code><a href="../api/ExecutableService.html" title="class in io.github.simplexdevelopment.api">ExecutableService</a></code></dd>
Docs
2022-12-13 02:41:22 +00:00
<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>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink