mirror of
https://github.com/SimplexDevelopment/SimplexSS.git
synced 2025-04-02 20:33:15 +00:00
Compare commits
23 Commits
1.0.0-SNAP
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
25ea207677 | ||
|
|
a4f1e01c87 | ||
|
|
ec92490ffd | ||
|
|
cccd441432 | ||
|
|
0d91f86054 | ||
|
|
116fbe5847 | ||
|
|
c9fa0c1ca0 | ||
|
|
695b1f9549 | ||
|
|
9d726cc1e3 | ||
|
|
5d66ea6582 | ||
|
|
7e29987e7f | ||
|
|
5b2961fff1 | ||
|
|
8f6b327d20 | ||
|
|
42aef3b955 | ||
|
|
6c0229e910 | ||
|
|
0805d44dc5 | ||
|
|
8442753964 | ||
|
|
43dee08554 | ||
|
|
43070f9e2a | ||
|
|
e3773b24f0 | ||
|
|
bf6de10e13 | ||
|
|
3fd93e101f | ||
|
|
e801b6700f |
76
.github/workflows/codeql.yml
vendored
Normal file
76
.github/workflows/codeql.yml
vendored
Normal file
@ -0,0 +1,76 @@
|
||||
# For most projects, this workflow file will not need changing; you simply need
|
||||
# to commit it to your repository.
|
||||
#
|
||||
# You may wish to alter this file to override the set of languages analyzed,
|
||||
# or to provide custom queries or build logic.
|
||||
#
|
||||
# ******** NOTE ********
|
||||
# We have attempted to detect the languages in your repository. Please check
|
||||
# the `language` matrix defined below to confirm you have the correct set of
|
||||
# supported CodeQL languages.
|
||||
#
|
||||
name: "CodeQL"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
# The branches below must be a subset of the branches above
|
||||
branches: [ "main" ]
|
||||
schedule:
|
||||
- cron: '21 13 * * 0'
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
actions: read
|
||||
contents: read
|
||||
security-events: write
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
language: [ 'java' ]
|
||||
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
|
||||
# Use only 'java' to analyze code written in Java, Kotlin or both
|
||||
# Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
|
||||
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v3
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v2
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||
# By default, queries listed here will override any specified in a config file.
|
||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||
|
||||
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
||||
# queries: security-extended,security-and-quality
|
||||
|
||||
|
||||
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
|
||||
# If this step fails, then you should remove it and run the build manually (see below)
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@v2
|
||||
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
||||
|
||||
# If the Autobuild fails above, remove it and uncomment the following three lines.
|
||||
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
|
||||
|
||||
# - run: |
|
||||
# echo "Run, Build Application using script"
|
||||
# ./location_of_script_within_repo/buildscript.sh
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v2
|
||||
with:
|
||||
category: "/language:${{matrix.language}}"
|
||||
34
.github/workflows/gradle.yml
vendored
Normal file
34
.github/workflows/gradle.yml
vendored
Normal file
@ -0,0 +1,34 @@
|
||||
# This workflow uses actions that are not certified by GitHub.
|
||||
# They are provided by a third-party and are governed by
|
||||
# separate terms of service, privacy policy, and support
|
||||
# documentation.
|
||||
# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
|
||||
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
|
||||
|
||||
name: Java CI with Gradle
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: Set up JDK 17
|
||||
uses: actions/setup-java@v3
|
||||
with:
|
||||
java-version: '17'
|
||||
distribution: 'temurin'
|
||||
- name: Build with Gradle
|
||||
uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1
|
||||
with:
|
||||
arguments: build
|
||||
5
.gitignore
vendored
5
.gitignore
vendored
@ -11,7 +11,6 @@
|
||||
.mtj.tmp/
|
||||
|
||||
# Package Files #
|
||||
*.jar
|
||||
*.war
|
||||
*.nar
|
||||
*.ear
|
||||
@ -25,7 +24,7 @@ replay_pid*
|
||||
|
||||
# IDE
|
||||
.idea/
|
||||
.gradle/
|
||||
gradle/
|
||||
.m2
|
||||
*.iml
|
||||
build/
|
||||
.gradle/
|
||||
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2022 Paldiu
|
||||
Copyright (c) 2022 SimplexDevelopment
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
133
README.md
133
README.md
@ -1,2 +1,135 @@
|
||||
[here]: https://simplexdevelopment.github.io/SimplexSS "SimplexSS JavaDocs"
|
||||
|
||||
# SimplexSS
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
A reactive non blocking api for scheduling runnable tasks (called services)
|
||||
|
||||
JavaDocs can be found [here].
|
||||
|
||||
# Adding SimplexSS to your project
|
||||
|
||||
In order to use SimplexSS in your project, you need to add the jitpack repository to your build.gradle or pom.xml file.
|
||||
|
||||
Here's an example, in Gradle:
|
||||
|
||||
```gradle
|
||||
repositories {
|
||||
maven {
|
||||
id 'jitpack'
|
||||
url 'https://jitpack.io'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then, you can add the dependency.
|
||||
|
||||
The `groupId` is `com.github.SimplexDevelopment`
|
||||
|
||||
The `artifactId` is `SimplexSS`
|
||||
|
||||
The `version` is `1.0.1-SNAPSHOT`
|
||||
|
||||
It is recommended you use either the Maven Shade Plugin,
|
||||
|
||||
```maven
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-jar-plugin</artifactId>
|
||||
...
|
||||
<configuration>
|
||||
<archive>
|
||||
<manifest>
|
||||
<addClasspath>true</addClasspath>
|
||||
<mainClass>path.to.MainClass</mainClass>
|
||||
</manifest>
|
||||
</archive>
|
||||
</configuration>
|
||||
...
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
```
|
||||
|
||||
or the Gradle Shadow Plugin (com.github.johnrengelman.shadow).
|
||||
|
||||
```gradle
|
||||
plugins {
|
||||
id 'com.github.johnrengelman.shadow' version '7.1.2'
|
||||
}
|
||||
```
|
||||
|
||||
Here is an example of the dependency, in Gradle:
|
||||
|
||||
```gradle
|
||||
dependencies {
|
||||
shadow 'com.github.SimplexDevelopment:SimplexSS:1.0.1-SNAPSHOT'
|
||||
}
|
||||
```
|
||||
|
||||
# Using SimplexSS
|
||||
|
||||
To use Simplex Scheduling System, the first thing you need to do is initialize a new instance of the Scheduling System.
|
||||
|
||||
```Java
|
||||
private SchedulingSystem<YourPlugin> scheduler;
|
||||
|
||||
@Override
|
||||
public void onEnable() {
|
||||
this.scheduler = new SchedulingSystem<>(this);
|
||||
}
|
||||
```
|
||||
|
||||
Then, you should use the Service Manager to create some new service pools. You can use `ServicePool#emptyBukkitServicePool(String, JavaPlugin)` for a service pool which will operate on the main server thread, or you can use `ServicePool#emptyServicePool(String, boolean)` for a completely separate, non-blocking scheduler which can be either singular or multithreaded. You should also use the service manager stream to register your services, and assign a Flux<Disposable> object so we can cancel the services later on in `JavaPlugin#onDisable()`.
|
||||
|
||||
```Java
|
||||
private SchedulingSystem<YourPlugin> scheduler;
|
||||
private Flux<Disposable> disposables;
|
||||
|
||||
@Override
|
||||
public void onEnable() {
|
||||
this.scheduler = new SchedulingSystem<>(this);
|
||||
|
||||
YourFirstService firstService;
|
||||
YourSecondService secondService;
|
||||
YourThirdService thirdService;
|
||||
|
||||
scheduler.getServiceManager().subscribe(manager -> {
|
||||
manager.emptyBukkitServicePool("pool_name", this).subscribe(pool -> {
|
||||
Set<Disposable> dispos = new HashSet<>();
|
||||
|
||||
firstService = new YourFirstService(pool, "first_service_name");
|
||||
secondService = new YourSecondService(pool, "second_service_name", 20 * 60L);
|
||||
thirdService = new YourThirdService(pool, "third_service_name", 20 * 60L, 20 * 60 * 10L, true, false);
|
||||
|
||||
scheduler.queue(firstService).subscribe(dispos::add);
|
||||
scheduler.queue(secondService).subscribe(dispos::add);
|
||||
scheduler.queue(thirdService).subscribe(dispos::add);
|
||||
|
||||
disposables = Flux.fromIterable(dispos);
|
||||
});
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
You can then stop, cancel, and/or dispose of the tasks in your `JavaPlugin#onDisable()` method by calling:
|
||||
```Java
|
||||
@Override
|
||||
public void onDisable() {
|
||||
scheduler.getServiceManager().subscribe(manager -> {
|
||||
manager.getServicePools().doOnEach(signal -> Objects.requireNonNull(signal.get())
|
||||
.stopServices(disposables)
|
||||
.subscribe());
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
23
build.gradle
23
build.gradle
@ -1,10 +1,11 @@
|
||||
plugins {
|
||||
id 'java'
|
||||
id 'com.github.johnrengelman.shadow' version '7.1.2'
|
||||
id 'maven-publish'
|
||||
}
|
||||
|
||||
group = 'io.github.simplex'
|
||||
version = '1.0.0'
|
||||
version = '1.0.1'
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
@ -20,11 +21,12 @@ repositories {
|
||||
|
||||
dependencies {
|
||||
compileOnly 'io.papermc.paper:paper-api:1.19-R0.1-SNAPSHOT'
|
||||
shadow 'io.projectreactor:reactor-core:3.4.19'
|
||||
shadow 'io.projectreactor:reactor-core:3.4.24'
|
||||
}
|
||||
|
||||
shadowJar {
|
||||
relocate ('reactor', "io.github.simplex.reactor")
|
||||
relocate('reactor', "io.github.simplexdevelopment.reactor")
|
||||
exclude('io.github.simplexdevelopment.impl')
|
||||
}
|
||||
|
||||
def targetJavaVersion = 17
|
||||
@ -35,6 +37,8 @@ java {
|
||||
if (JavaVersion.current() < javaVersion) {
|
||||
toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion)
|
||||
}
|
||||
withSourcesJar()
|
||||
withJavadocJar()
|
||||
}
|
||||
|
||||
tasks.withType(JavaCompile).configureEach {
|
||||
@ -51,3 +55,16 @@ processResources {
|
||||
expand props
|
||||
}
|
||||
}
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
mavenJava(MavenPublication) {
|
||||
from components.java
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
wrapper {
|
||||
gradleVersion = '7.5.1'
|
||||
distributionType = Wrapper.DistributionType.ALL
|
||||
}
|
||||
123
build/docs/javadoc/allclasses-index.html
Normal file
123
build/docs/javadoc/allclasses-index.html
Normal file
@ -0,0 +1,123 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>All Classes and Interfaces (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="class index">
|
||||
<meta name="generator" content="javadoc/AllClassesIndexWriter">
|
||||
<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="all-classes-index-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>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-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#all-classes">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
|
||||
</div>
|
||||
<div id="all-classes-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab4" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab4', 2)" class="table-tab">Record Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</button></div>
|
||||
<div id="all-classes-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||||
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a><<a href="io/github/simplexdevelopment/api/Context.html" title="type parameter in Context">S</a>></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
||||
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
|
||||
<div class="block">This interface contains surface level methods for the <a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
||||
<div class="block">Represents a service that can be registered to a <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">This class is used to manage the scheduling of <a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
||||
and the creation of <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
|
||||
<div class="block">This class is used to represent a service exception.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">The ServiceManager is a factory class for managing <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
|
||||
<div class="block">This class is used to represent a service pool exception.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
68
build/docs/javadoc/allpackages-index.html
Normal file
68
build/docs/javadoc/allpackages-index.html
Normal file
@ -0,0 +1,68 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>All Packages (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="package index">
|
||||
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
|
||||
<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="all-packages-index-page">
|
||||
<script type="text/javascript">var pathtoroot = "./";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="deprecated-list.html">Deprecated</a></li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="help-doc.html#all-packages">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 title="All&nbsp;Packages" class="title">All Packages</h1>
|
||||
</div>
|
||||
<div class="caption"><span>Package Summary</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><a href="io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
74
build/docs/javadoc/deprecated-list.html
Normal file
74
build/docs/javadoc/deprecated-list.html
Normal file
@ -0,0 +1,74 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Deprecated List (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="deprecated elements">
|
||||
<meta name="generator" content="javadoc/DeprecatedListWriter">
|
||||
<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="deprecated-list-page">
|
||||
<script type="text/javascript">var pathtoroot = "./";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Deprecated</li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="help-doc.html#deprecated">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 title="Deprecated API" class="title">Deprecated API</h1>
|
||||
<h2 title="Contents">Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#method">Methods</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<ul class="block-list">
|
||||
<li>
|
||||
<div id="method">
|
||||
<div class="caption"><span>Deprecated Methods</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-summary-item-name even-row-color"><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#dispose()">io.github.simplexdevelopment.scheduler.ReactorBukkitScheduler.dispose()</a></div>
|
||||
<div class="col-last even-row-color"></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
3
build/docs/javadoc/element-list
Normal file
3
build/docs/javadoc/element-list
Normal file
@ -0,0 +1,3 @@
|
||||
io.github.simplexdevelopment.api
|
||||
io.github.simplexdevelopment.impl
|
||||
io.github.simplexdevelopment.scheduler
|
||||
186
build/docs/javadoc/help-doc.html
Normal file
186
build/docs/javadoc/help-doc.html
Normal file
@ -0,0 +1,186 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>API Help (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="help">
|
||||
<meta name="generator" content="javadoc/HelpWriter">
|
||||
<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="help-page">
|
||||
<script type="text/javascript">var pathtoroot = "./";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="deprecated-list.html">Deprecated</a></li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li class="nav-bar-cell1-rev">Help</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Help: </li>
|
||||
<li><a href="#help-navigation">Navigation</a> | </li>
|
||||
<li><a href="#help-pages">Pages</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">
|
||||
<h1 class="title">JavaDoc Help</h1>
|
||||
<ul class="help-toc">
|
||||
<li><a href="#help-navigation">Navigation</a>:
|
||||
<ul class="help-subtoc">
|
||||
<li><a href="#help-search">Search</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#help-pages">Kinds of Pages</a>:
|
||||
<ul class="help-subtoc">
|
||||
<li><a href="#overview">Overview</a></li>
|
||||
<li><a href="#package">Package</a></li>
|
||||
<li><a href="#class">Class or Interface</a></li>
|
||||
<li><a href="#doc-file">Other Files</a></li>
|
||||
<li><a href="#tree">Tree (Class Hierarchy)</a></li>
|
||||
<li><a href="#deprecated">Deprecated API</a></li>
|
||||
<li><a href="#serialized-form">Serialized Form</a></li>
|
||||
<li><a href="#all-packages">All Packages</a></li>
|
||||
<li><a href="#all-classes">All Classes and Interfaces</a></li>
|
||||
<li><a href="#index">Index</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<hr>
|
||||
<div class="sub-title">
|
||||
<h2 id="help-navigation">Navigation</h2>
|
||||
Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-all.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>
|
||||
<section class="help-section" id="help-search">
|
||||
<h3>Search</h3>
|
||||
<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p>
|
||||
<ul class="help-section-list">
|
||||
<li><code>j.l.obj</code> will match "java.lang.Object"</li>
|
||||
<li><code>InpStr</code> will match "java.io.InputStream"</li>
|
||||
<li><code>HM.cK</code> will match "java.util.HashMap.containsKey(Object)"</li>
|
||||
</ul>
|
||||
<p>Refer to the <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/javadoc-search-spec.html">Javadoc Search Specification</a> for a full description of search features.</p>
|
||||
</section>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="sub-title">
|
||||
<h2 id="help-pages">Kinds of Pages</h2>
|
||||
The following sections describe the different kinds of pages in this collection.
|
||||
<section class="help-section" id="overview">
|
||||
<h3>Overview</h3>
|
||||
<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
|
||||
</section>
|
||||
<section class="help-section" id="package">
|
||||
<h3>Package</h3>
|
||||
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:</p>
|
||||
<ul class="help-section-list">
|
||||
<li>Interfaces</li>
|
||||
<li>Classes</li>
|
||||
<li>Enum Classes</li>
|
||||
<li>Exceptions</li>
|
||||
<li>Errors</li>
|
||||
<li>Annotation Interfaces</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="help-section" id="class">
|
||||
<h3>Class or Interface</h3>
|
||||
<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.</p>
|
||||
<ul class="help-section-list">
|
||||
<li>Class Inheritance Diagram</li>
|
||||
<li>Direct Subclasses</li>
|
||||
<li>All Known Subinterfaces</li>
|
||||
<li>All Known Implementing Classes</li>
|
||||
<li>Class or Interface Declaration</li>
|
||||
<li>Class or Interface Description</li>
|
||||
</ul>
|
||||
<br>
|
||||
<ul class="help-section-list">
|
||||
<li>Nested Class Summary</li>
|
||||
<li>Enum Constant Summary</li>
|
||||
<li>Field Summary</li>
|
||||
<li>Property Summary</li>
|
||||
<li>Constructor Summary</li>
|
||||
<li>Method Summary</li>
|
||||
<li>Required Element Summary</li>
|
||||
<li>Optional Element Summary</li>
|
||||
</ul>
|
||||
<br>
|
||||
<ul class="help-section-list">
|
||||
<li>Enum Constant Details</li>
|
||||
<li>Field Details</li>
|
||||
<li>Property Details</li>
|
||||
<li>Constructor Details</li>
|
||||
<li>Method Details</li>
|
||||
<li>Element Details</li>
|
||||
</ul>
|
||||
<p><span class="help-note">Note:</span> Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.</p>
|
||||
<p>The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p>
|
||||
</section>
|
||||
<section class="help-section" id="doc-file">
|
||||
<h3>Other Files</h3>
|
||||
<p>Packages and modules may contain pages with additional information related to the declarations nearby.</p>
|
||||
</section>
|
||||
<section class="help-section" id="tree">
|
||||
<h3>Tree (Class Hierarchy)</h3>
|
||||
<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with <code>java.lang.Object</code>. Interfaces do not inherit from <code>java.lang.Object</code>.</p>
|
||||
<ul class="help-section-list">
|
||||
<li>When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.</li>
|
||||
<li>When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="help-section" id="deprecated">
|
||||
<h3>Deprecated API</h3>
|
||||
<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p>
|
||||
</section>
|
||||
<section class="help-section" id="serialized-form">
|
||||
<h3>Serialized Form</h3>
|
||||
<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.</p>
|
||||
</section>
|
||||
<section class="help-section" id="all-packages">
|
||||
<h3>All Packages</h3>
|
||||
<p>The <a href="allpackages-index.html">All Packages</a> page contains an alphabetic index of all packages contained in the documentation.</p>
|
||||
</section>
|
||||
<section class="help-section" id="all-classes">
|
||||
<h3>All Classes and Interfaces</h3>
|
||||
<p>The <a href="allclasses-index.html">All Classes and Interfaces</a> page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.</p>
|
||||
</section>
|
||||
<section class="help-section" id="index">
|
||||
<h3>Index</h3>
|
||||
<p>The <a href="index-all.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>.</p>
|
||||
</section>
|
||||
</div>
|
||||
<hr>
|
||||
<span class="help-footnote">This help file applies to API documentation generated by the standard doclet.</span></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
423
build/docs/javadoc/index-all.html
Normal file
423
build/docs/javadoc/index-all.html
Normal file
@ -0,0 +1,423 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Index (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="index">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="script.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "./";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="deprecated-list.html">Deprecated</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:O">O</a> <a href="#I:Q">Q</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized Form</a>
|
||||
<h2 class="title" id="I:A">A</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#addToExistingPool(io.github.simplexdevelopment.scheduler.ServicePool,io.github.simplexdevelopment.api.IService...)" class="member-name-link">addToExistingPool(ServicePool, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:B">B</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a> - Record Class in <a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html#%3Cinit%3E(org.bukkit.scheduler.BukkitTask)" class="member-name-link">BukkitDisposable(BukkitTask)</a> - Constructor for record class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates an instance of a <code>BukkitDisposable</code> record class.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#bukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin,io.github.simplexdevelopment.api.IService...)" class="member-name-link">bukkitServicePool(String, JavaPlugin, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:C">C</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/api/Context.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Context</a><<a href="io/github/simplexdevelopment/api/Context.html" title="type parameter in Context">S</a>> - Interface in <a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd>
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/Context.html#contextCollection()" class="member-name-link">contextCollection()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)" class="member-name-link">createServicePool(String, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#createWorker()" class="member-name-link">createWorker()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">A new <code>Scheduler.Worker</code>.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:D">D</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html#dispose()" class="member-name-link">dispose()</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Disposes of the task upstream on the Bukkit scheduler.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#dispose()" class="member-name-link">dispose()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd>
|
||||
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:E">E</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#emptyBukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">emptyBukkitServicePool(String, JavaPlugin)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#emptyServicePool(java.lang.String,boolean)" class="member-name-link">emptyServicePool(String, boolean)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Indicates whether some other object is "equal to" this one.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a> - Class in <a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#%3Cinit%3E(java.lang.String)" class="member-name-link">ExecutableService(String)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#%3Cinit%3E(io.github.simplexdevelopment.scheduler.ServicePool,java.lang.String)" class="member-name-link">ExecutableService(ServicePool, String)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#%3Cinit%3E(io.github.simplexdevelopment.scheduler.ServicePool,java.lang.String,java.lang.Long,java.lang.Long,java.lang.Boolean)" class="member-name-link">ExecutableService(ServicePool, String, Long, Long, Boolean)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#%3Cinit%3E(io.github.simplexdevelopment.scheduler.ServicePool,java.lang.String,java.lang.Long)" class="member-name-link">ExecutableService(ServicePool, String, Long)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#%3Cinit%3E(io.github.simplexdevelopment.scheduler.ServicePool,java.lang.String,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)" class="member-name-link">ExecutableService(ServicePool, String, Long, Long, Boolean, Boolean)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:F">F</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/api/Context.html#fluxFromCollection()" class="member-name-link">fluxFromCollection()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ISchedule.html#forceStart(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStart(IService)</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#forceStart(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStart(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ISchedule.html#forceStop(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStop(IService)</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#forceStop(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStop(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:G">G</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#getAssociatedServicePool(io.github.simplexdevelopment.api.IService)" class="member-name-link">getAssociatedServicePool(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#getAssociatedServices()" class="member-name-link">getAssociatedServices()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/Context.html#getContext()" class="member-name-link">getContext()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#getDelay()" class="member-name-link">getDelay()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#getDelay()" class="member-name-link">getDelay()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#getMainScheduler()" class="member-name-link">getMainScheduler()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/Identifier.html#getName()" class="member-name-link">getName()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#getName()" class="member-name-link">getName()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#getName()" class="member-name-link">getName()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/Identifier.html#getNumericalId()" class="member-name-link">getNumericalId()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#getParentPool()" class="member-name-link">getParentPool()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#getParentPool()" class="member-name-link">getParentPool()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#getPeriod()" class="member-name-link">getPeriod()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#getPeriod()" class="member-name-link">getPeriod()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#getPlugin()" class="member-name-link">getPlugin()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/ServiceImpl.html#getPlugin()" class="member-name-link">getPlugin()</a> - Method in class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#getProvidingPlugin()" class="member-name-link">getProvidingPlugin()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/Main.html#getScheduler()" class="member-name-link">getScheduler()</a> - Method in class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#getScheduler()" class="member-name-link">getScheduler()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#getService(java.lang.String)" class="member-name-link">getService(String)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets a service based on the name of the service defined by <a href="io/github/simplexdevelopment/api/Identifier.html#getName()"><code>Identifier.getName()</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ISchedule.html#getServiceManager()" class="member-name-link">getServiceManager()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#getServiceManager()" class="member-name-link">getServiceManager()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#getServicePools()" class="member-name-link">getServicePools()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/Identifier.html#getUniqueId()" class="member-name-link">getUniqueId()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:H">H</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html#hashCode()" class="member-name-link">hashCode()</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns a hash code value for this object.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:I">I</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/api/Identifier.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Identifier</a> - Interface in <a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd>
|
||||
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a> - package io.github.simplexdevelopment.api</dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a> - package io.github.simplexdevelopment.impl</dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a> - package io.github.simplexdevelopment.scheduler</dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#isCancelled()" class="member-name-link">isCancelled()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Cancels the execution of this service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ISchedule.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">ISchedule</a> - Interface in <a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd>
|
||||
<div class="block">This interface contains surface level methods for the <a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html#isDisposed()" class="member-name-link">isDisposed()</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Checks if the task is cancelled.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">IService</a> - Interface in <a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd>
|
||||
<div class="block">Represents a service that can be registered to a <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#isPeriodic()" class="member-name-link">isPeriodic()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#isPeriodic()" class="member-name-link">isPeriodic()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:L">L</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#locateServiceWithinPools(io.github.simplexdevelopment.api.IService)" class="member-name-link">locateServiceWithinPools(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:M">M</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/impl/Main.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">Main</a> - Class in <a href="io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/Main.html#%3Cinit%3E()" class="member-name-link">Main()</a> - Constructor for class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#multithreadedServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)" class="member-name-link">multithreadedServicePool(String, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:O">O</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/impl/Main.html#onDisable()" class="member-name-link">onDisable()</a> - Method in class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/Main.html#onEnable()" class="member-name-link">onEnable()</a> - Method in class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:Q">Q</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/api/ISchedule.html#queue(io.github.simplexdevelopment.api.IService)" class="member-name-link">queue(IService)</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Queues a service to be executed in a service pool.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#queue(io.github.simplexdevelopment.api.IService)" class="member-name-link">queue(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#queueAll()" class="member-name-link">queueAll()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#queueService(io.github.simplexdevelopment.api.IService)" class="member-name-link">queueService(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This method is the actual method used to schedule a service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#queueServices()" class="member-name-link">queueServices()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This method can be used to start all the services registered with this pool.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:R">R</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a> - Class in <a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#%3Cinit%3E(org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ReactorBukkitScheduler(JavaPlugin)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#recycle()" class="member-name-link">recycle()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This will clear the ServicePool of all services and return an empty pool.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/Main.html#registerServices(java.lang.String)" class="member-name-link">registerServices(String)</a> - Method in class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#run()" class="member-name-link">run()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ISchedule.html#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce(IService)</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:S">S</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#schedule(java.lang.Runnable)" class="member-name-link">schedule(Runnable)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">Delegates to the <code>BukkitScheduler</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#schedule(java.lang.Runnable,long,java.util.concurrent.TimeUnit)" class="member-name-link">schedule(Runnable, long, TimeUnit)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">Delegates to the <code>BukkitScheduler</code> with a delay.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#schedulePeriodically(java.lang.Runnable,long,long,java.util.concurrent.TimeUnit)" class="member-name-link">schedulePeriodically(Runnable, long, long, TimeUnit)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">Delegates to the <code>BukkitScheduler</code> with a delay and a period.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin> - Class in <a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">This class is used to manage the scheduling of <a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
||||
and the creation of <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html#%3Cinit%3E(T)" class="member-name-link">SchedulingSystem(T)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of the scheduling system.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServiceException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServiceException</a> - Exception in <a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd>
|
||||
<div class="block">This class is used to represent a service exception.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServiceException.html#%3Cinit%3E(io.github.simplexdevelopment.api.IService)" class="member-name-link">ServiceException(IService)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a new service exception which states the service is not present within any service pools.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServiceException.html#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">ServiceException(Throwable)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/ServiceImpl.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a> - Class in <a href="io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/ServiceImpl.html#%3Cinit%3E(io.github.simplexdevelopment.impl.Main,io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">ServiceImpl(Main, ServicePool)</a> - Constructor for class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a> - Class in <a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">The ServiceManager is a factory class for managing <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#%3Cinit%3E()" class="member-name-link">ServiceManager()</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of the Service Manager class.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> - Class in <a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd>
|
||||
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#%3Cinit%3E(java.lang.String,boolean)" class="member-name-link">ServicePool(String, boolean)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This will create a new instance of a Service Pool with a <code>Scheduler</code> as its main scheduler.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#%3Cinit%3E(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ServicePool(String, JavaPlugin)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This will create a new instance of a Service Pool with the <a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> as its main scheduler.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServicePoolException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServicePoolException</a> - Exception in <a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd>
|
||||
<div class="block">This class is used to represent a service pool exception.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServicePoolException.html#%3Cinit%3E()" class="member-name-link">ServicePoolException()</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a new generic service pool exception.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServicePoolException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">ServicePoolException(String)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServicePoolException.html#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">ServicePoolException(Throwable)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#setCancelled(boolean)" class="member-name-link">setCancelled(boolean)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Cancels the execution of this service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/Context.html#setContext(S)" class="member-name-link">setContext(S)</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setParentPool(ServicePool)</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Sets the parent pool for this service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setParentPool(ServicePool)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#start()" class="member-name-link">start()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd>
|
||||
<div class="block">The actual start method for the service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/ServiceImpl.html#start()" class="member-name-link">start()</a> - Method in class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/IService.html#stop()" class="member-name-link">stop()</a> - Method in interface io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd>
|
||||
<div class="block">The actual end method for the service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/impl/ServiceImpl.html#stop()" class="member-name-link">stop()</a> - Method in class io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#stopService(java.lang.String,reactor.core.publisher.Mono)" class="member-name-link">stopService(String, Mono<Disposable>)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This is the method used to stop a service.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServicePool.html#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices(Flux<Disposable>)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This method can be used to stop all the services registered with this pool.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServicePoolException.html#supplyException()" class="member-name-link">supplyException()</a> - Static method in exception io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/api/ServiceException.html#supplyException(io.github.simplexdevelopment.api.IService)" class="member-name-link">supplyException(IService)</a> - Static method in exception io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:T">T</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html#takeFromExistingPool(io.github.simplexdevelopment.scheduler.ServicePool,io.github.simplexdevelopment.api.IService...)" class="member-name-link">takeFromExistingPool(ServicePool, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html#task()" class="member-name-link">task()</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns the value of the <code>task</code> record component.</div>
|
||||
</dd>
|
||||
<dt><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html#toString()" class="member-name-link">toString()</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns a string representation of this record class.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:O">O</a> <a href="#I:Q">Q</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
70
build/docs/javadoc/index.html
Normal file
70
build/docs/javadoc/index.html
Normal file
@ -0,0 +1,70 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Overview (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="package index">
|
||||
<meta name="generator" content="javadoc/PackageIndexWriter">
|
||||
<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="package-index-page">
|
||||
<script type="text/javascript">var pathtoroot = "./";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li class="nav-bar-cell1-rev">Overview</li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="deprecated-list.html">Deprecated</a></li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="help-doc.html#overview">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 class="title">SimplexSS 1.0.1 API</h1>
|
||||
</div>
|
||||
<div id="all-packages-table">
|
||||
<div class="caption"><span>Packages</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></div>
|
||||
<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> </div>
|
||||
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a></div>
|
||||
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> </div>
|
||||
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></div>
|
||||
<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> </div>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
178
build/docs/javadoc/io/github/simplexdevelopment/api/Context.html
Normal file
178
build/docs/javadoc/io/github/simplexdevelopment/api/Context.html
Normal file
@ -0,0 +1,178 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Context (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.api, interface: Context">
|
||||
<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>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </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="Interface Context" class="title">Interface Context<S></h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>S</code> - Any object type to wrap with this class.</dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Context<S></span></div>
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</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-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-tab2 method-summary-table-tab3"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="Context.html" title="type parameter in Context">S</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#contextCollection()" class="member-name-link">contextCollection</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default @Nullable reactor.core.publisher.Flux<<a href="Context.html" title="type parameter in Context">S</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#fluxFromCollection()" class="member-name-link">fluxFromCollection</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NotNull reactor.core.publisher.Mono<<a href="Context.html" title="type parameter in Context">S</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NotNull 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-tab3"><code><a href="#setContext(S)" class="member-name-link">setContext</a><wbr>(<a href="Context.html" title="type parameter in Context">S</a> context)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="getContext()">
|
||||
<h3>getContext</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="Context.html" title="type parameter in Context">S</a>></span> <span class="element-name">getContext</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object which contains a single element represented by the definer of this Context class.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="setContext(S)">
|
||||
<h3 id="setContext(java.lang.Object)">setContext</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="return-type">@NotNull 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">setContext</span><wbr><span class="parameters">(<a href="Context.html" title="type parameter in Context">S</a> context)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>context</code> - A separate (or identical) object identified by the definer of this Context class.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object which can be used to set the element of this Context class in a non-blocking manner.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="contextCollection()">
|
||||
<h3>contextCollection</h3>
|
||||
<div class="member-signature"><span class="annotations">@Nullable
|
||||
</span><span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="Context.html" title="type parameter in Context">S</a>></span> <span class="element-name">contextCollection</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A collection of objects related to the definer of this Context class.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="fluxFromCollection()">
|
||||
<h3>fluxFromCollection</h3>
|
||||
<div class="member-signature"><span class="annotations">@Nullable
|
||||
</span><span class="modifiers">default</span> <span class="return-type">@Nullable reactor.core.publisher.Flux<<a href="Context.html" title="type parameter in Context">S</a>></span> <span class="element-name">fluxFromCollection</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Flux object which contains the values of the <a href="#contextCollection()"><code>contextCollection()</code></a>, for non-blocking interpretation.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,198 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ISchedule (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.api, interface: ISchedule">
|
||||
<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>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </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="Interface ISchedule" class="title">Interface ISchedule</h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Known Implementing Classes:</dt>
|
||||
<dd><code><a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISchedule</span></div>
|
||||
<div class="block">This interface contains surface level methods for the <a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</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-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></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-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#forceStart(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStart</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><code><a href="#forceStop(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStop</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="../scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServiceManager()" class="member-name-link">getServiceManager</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NotNull reactor.core.publisher.Mono<reactor.core.Disposable></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#queue(io.github.simplexdevelopment.api.IService)" class="member-name-link">queue</a><wbr>(@NotNull <a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">Queues a service to be executed in a service pool.</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<<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-tab3"><code><a href="#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="getServiceManager()">
|
||||
<h3>getServiceManager</h3>
|
||||
<div class="member-signature"><span class="return-type">reactor.core.publisher.Mono<<a href="../scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a>></span> <span class="element-name">getServiceManager</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The service manager which exerts control over the service pools and their associated services.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="queue(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>queue</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="return-type">@NotNull reactor.core.publisher.Mono<reactor.core.Disposable></span> <span class="element-name">queue</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<div class="block">Queues a service to be executed in a service pool.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to use to locate the associated service pool and queue the service for execution.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object that can be used to cancel the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="runOnce(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>runOnce</h3>
|
||||
<div class="member-signature"><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">runOnce</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to run once.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="forceStop(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>forceStop</h3>
|
||||
<div class="member-signature"><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">forceStop</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully stop.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="forceStart(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>forceStart</h3>
|
||||
<div class="member-signature"><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">forceStart</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully start.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,262 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>IService (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.api, interface: IService">
|
||||
<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>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </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="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="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</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>All Known Implementing Classes:</dt>
|
||||
<dd><code><a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></code>, <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 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>, <a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></span></div>
|
||||
<div class="block">Represents a service that can be registered to a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.
|
||||
<p>
|
||||
This interface provides surface level methods to be used by the <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>
|
||||
associated to each service.</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-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-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="#getDelay()" class="member-name-link">getDelay</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-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"> </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"> </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"> </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"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
|
||||
<div class="col-second odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setParentPool</a><wbr>(<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> servicePool)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">Sets the parent pool for this service.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><code><a href="#start()" class="member-name-link">start</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<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<<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-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">
|
||||
<div class="block">The actual end method for the service.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-io.github.simplexdevelopment.api.Identifier">Methods inherited from interface io.github.simplexdevelopment.api.<a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></h3>
|
||||
<code><a href="Identifier.html#getName()">getName</a>, <a href="Identifier.html#getNumericalId()">getNumericalId</a>, <a href="Identifier.html#getUniqueId()">getUniqueId</a></code></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="isPeriodic()">
|
||||
<h3>isPeriodic</h3>
|
||||
<div class="member-signature"><span class="return-type">boolean</span> <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> <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> <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<<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">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<<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">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> <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>
|
||||
<div class="member-signature"><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>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>
|
||||
<li>
|
||||
<section class="detail" id="setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)">
|
||||
<h3>setParentPool</h3>
|
||||
<div class="member-signature"><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">setParentPool</span><wbr><span class="parameters">(<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> servicePool)</span></div>
|
||||
<div class="block">Sets the parent pool for this service.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>servicePool</code> - The service pool to attach this service to.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>An encapsulated Mono object representing the set operation.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="run()">
|
||||
<h3>run</h3>
|
||||
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <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> in interface <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>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,165 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Identifier (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.api, interface: Identifier">
|
||||
<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>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </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="Interface Identifier" class="title">Interface Identifier</h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Known Subinterfaces:</dt>
|
||||
<dd><code><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>All Known Implementing Classes:</dt>
|
||||
<dd><code><a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></code>, <code><a href="../impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></code>, <code><a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Identifier</span></div>
|
||||
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</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-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-tab2 method-summary-table-tab3"><code><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></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getNumericalId()" class="member-name-link">getNumericalId</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getUniqueId()" class="member-name-link">getUniqueId</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </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="getName()">
|
||||
<h3>getName</h3>
|
||||
<div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getName</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The name of the identifiable object in a readable format.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getUniqueId()">
|
||||
<h3>getUniqueId</h3>
|
||||
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a></span> <span class="element-name">getUniqueId</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The UUID of the identifiable object, based on the <a href="#getName()"><code>getName()</code></a> value.
|
||||
This is calculated using <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html#nameUUIDFromBytes(byte%5B%5D)" title="class or interface in java.util" class="external-link"><code>UUID.nameUUIDFromBytes(byte[])</code></a>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getNumericalId()">
|
||||
<h3>getNumericalId</h3>
|
||||
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">getNumericalId</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The numerical id of the identifiable object, based on the <a href="#getUniqueId()"><code>getUniqueId()</code></a> value.
|
||||
This is calculated using <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html#hashCode()" title="class or interface in java.util" class="external-link"><code>UUID.hashCode()</code></a>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,207 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ServiceException (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.api, class: ServiceException">
|
||||
<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>Nested | </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.api</a></div>
|
||||
<h1 title="Class ServiceException" class="title">Class ServiceException</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"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a>
|
||||
<div class="inheritance">io.github.simplexdevelopment.api.ServiceException</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ServiceException</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></span></div>
|
||||
<div class="block">This class is used to represent a service exception.
|
||||
When a <a href="IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a> is called that has not been registered with a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>,
|
||||
this exception will be thrown.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../../../serialized-form.html#io.github.simplexdevelopment.api.ServiceException">Serialized Form</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== 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(io.github.simplexdevelopment.api.IService)" class="member-name-link">ServiceException</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new service exception which states the service is not present within any service pools.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">ServiceException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> th)</code></div>
|
||||
<div class="col-last odd-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-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-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-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#supplyException(io.github.simplexdevelopment.api.IService)" class="member-name-link">supplyException</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Throwable">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">addSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#fillInStackTrace()" title="class or interface in java.lang" class="external-link">fillInStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getCause()" title="class or interface in java.lang" class="external-link">getCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getLocalizedMessage()" title="class or interface in java.lang" class="external-link">getLocalizedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getMessage()" title="class or interface in java.lang" class="external-link">getMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getStackTrace()" title="class or interface in java.lang" class="external-link">getStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getSuppressed()" title="class or interface in java.lang" class="external-link">getSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">initCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace()" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement%5B%5D)" title="class or interface in java.lang" class="external-link">setStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code></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#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>
|
||||
</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>(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>ServiceException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServiceException</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<div class="block">Constructs a new service exception which states the service is not present within any service pools.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service that threw the exception.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.Throwable)">
|
||||
<h3>ServiceException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServiceException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> th)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>th</code> - The throwable that was thrown.</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="supplyException(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>supplyException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a>></span> <span class="element-name">supplyException</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service that threw the exception.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A supplier that can be used in conjunction with Reactor.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,218 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ServicePoolException (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.api, class: ServicePoolException">
|
||||
<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>Nested | </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.api</a></div>
|
||||
<h1 title="Class ServicePoolException" class="title">Class ServicePoolException</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"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a>
|
||||
<div class="inheritance">io.github.simplexdevelopment.api.ServicePoolException</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ServicePoolException</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></span></div>
|
||||
<div class="block">This class is used to represent a service pool exception.
|
||||
This exception is thrown when a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> is not found,
|
||||
when <a href="../scheduler/ServicePool.html#queueService(io.github.simplexdevelopment.api.IService)"><code>ServicePool.queueService(IService)</code></a> is called but the service is not registered with this pool,
|
||||
or if the service pool is empty and <a href="../scheduler/ServicePool.html#queueServices()"><code>ServicePool.queueServices()</code></a> is called.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../../../serialized-form.html#io.github.simplexdevelopment.api.ServicePoolException">Serialized Form</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== 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()" class="member-name-link">ServicePoolException</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new generic service pool exception.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">ServicePoolException</a><wbr>(@NotNull <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> string)</code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">ServicePoolException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> ex)</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-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-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-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#supplyException()" class="member-name-link">supplyException</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Throwable">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">addSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#fillInStackTrace()" title="class or interface in java.lang" class="external-link">fillInStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getCause()" title="class or interface in java.lang" class="external-link">getCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getLocalizedMessage()" title="class or interface in java.lang" class="external-link">getLocalizedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getMessage()" title="class or interface in java.lang" class="external-link">getMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getStackTrace()" title="class or interface in java.lang" class="external-link">getStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getSuppressed()" title="class or interface in java.lang" class="external-link">getSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">initCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace()" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement%5B%5D)" title="class or interface in java.lang" class="external-link">setStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code></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#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>
|
||||
</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>()">
|
||||
<h3>ServicePoolException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServicePoolException</span>()</div>
|
||||
<div class="block">Constructs a new generic service pool exception.
|
||||
This will be thrown when a service attempts to execute without an associated service pool.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String)">
|
||||
<h3>ServicePoolException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServicePoolException</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <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> string)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The message to be displayed when the exception is thrown.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.Throwable)">
|
||||
<h3>ServicePoolException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServicePoolException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> ex)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>ex</code> - The exception to be thrown.</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="supplyException()">
|
||||
<h3>supplyException</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true)
|
||||
@NotNull
|
||||
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a>></span> <span class="element-name">supplyException</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A supplier which can be used in conjunction with Reactor.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,110 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>io.github.simplexdevelopment.api (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.api">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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="package-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 class="nav-bar-cell1-rev">Package</li>
|
||||
<li>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#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li>Related Packages | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</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">
|
||||
<div class="header">
|
||||
<h1 title="Package io.github.simplexdevelopment.api" class="title">Package io.github.simplexdevelopment.api</h1>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">io.github.simplexdevelopment.api</span></div>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
<div id="class-summary">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button></div>
|
||||
<div id="class-summary.tabpanel" role="tabpanel">
|
||||
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Context.html" title="interface in io.github.simplexdevelopment.api">Context</a><S></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab1">
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab1">
|
||||
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab1">
|
||||
<div class="block">This interface contains surface level methods for the <a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab1">
|
||||
<div class="block">Represents a service that can be registered to a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab5">
|
||||
<div class="block">This class is used to represent a service exception.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab5">
|
||||
<div class="block">This class is used to represent a service pool exception.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,101 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>io.github.simplexdevelopment.api Class Hierarchy (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="tree: package: io.github.simplexdevelopment.api">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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="package-tree-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../../../../index.html">Overview</a></li>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 class="title">Hierarchy For Package io.github.simplexdevelopment.api</h1>
|
||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
||||
<ul class="horizontal">
|
||||
<li><a href="../../../../overview-tree.html">All Packages</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" class="type-name-link external-link" title="class or interface in java.lang">Throwable</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" class="type-name-link external-link" title="class or interface in java.lang">Exception</a>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" class="type-name-link external-link" title="class or interface in java.lang">RuntimeException</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="ServiceException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServiceException</a></li>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="ServicePoolException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="Context.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Context</a><S></li>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="Identifier.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Identifier</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="IService.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">IService</a> (also extends java.lang.<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>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="ISchedule.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">ISchedule</a></li>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Runnable.html" class="type-name-link external-link" title="class or interface in java.lang">Runnable</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="IService.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">IService</a> (also extends io.github.simplexdevelopment.api.<a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
214
build/docs/javadoc/io/github/simplexdevelopment/impl/Main.html
Normal file
214
build/docs/javadoc/io/github/simplexdevelopment/impl/Main.html
Normal file
@ -0,0 +1,214 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Main (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.impl, class: Main">
|
||||
<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>Nested | </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.impl</a></div>
|
||||
<h1 title="Class Main" class="title">Class Main</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">org.bukkit.plugin.PluginBase
|
||||
<div class="inheritance">org.bukkit.plugin.java.JavaPlugin
|
||||
<div class="inheritance">io.github.simplexdevelopment.impl.Main</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code>org.bukkit.command.CommandExecutor</code>, <code>org.bukkit.command.TabCompleter</code>, <code>org.bukkit.command.TabExecutor</code>, <code>org.bukkit.plugin.Plugin</code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Main</span>
|
||||
<span class="extends-implements">extends org.bukkit.plugin.java.JavaPlugin</span></div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== 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()" class="member-name-link">Main</a>()</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></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><a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><<a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheduler()" class="member-name-link">getScheduler</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>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onDisable()" class="member-name-link">onDisable</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>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onEnable()" class="member-name-link">onEnable</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>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerServices(java.lang.String)" class="member-name-link">registerServices</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> poolName)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-org.bukkit.plugin.java.JavaPlugin">Methods inherited from class org.bukkit.plugin.java.JavaPlugin</h3>
|
||||
<code>getClassLoader, getCommand, getConfig, getDataFolder, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onLoad, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString</code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-org.bukkit.plugin.PluginBase">Methods inherited from class org.bukkit.plugin.PluginBase</h3>
|
||||
<code>equals, getName, hashCode</code></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#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#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#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-org.bukkit.plugin.Plugin">Methods inherited from interface org.bukkit.plugin.Plugin</h3>
|
||||
<code>getComponentLogger, getLog4JLogger, getSLF4JLogger</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>()">
|
||||
<h3>Main</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Main</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="onEnable()">
|
||||
<h3>onEnable</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onEnable</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code>onEnable</code> in interface <code>org.bukkit.plugin.Plugin</code></dd>
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code>onEnable</code> in class <code>org.bukkit.plugin.java.JavaPlugin</code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="onDisable()">
|
||||
<h3>onDisable</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onDisable</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code>onDisable</code> in interface <code>org.bukkit.plugin.Plugin</code></dd>
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code>onDisable</code> in class <code>org.bukkit.plugin.java.JavaPlugin</code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="registerServices(java.lang.String)">
|
||||
<h3>registerServices</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerServices</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> poolName)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getScheduler()">
|
||||
<h3>getScheduler</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><<a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a>></span> <span class="element-name">getScheduler</span>()</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,216 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ServiceImpl (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.impl, class: ServiceImpl">
|
||||
<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>Nested | </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.impl</a></div>
|
||||
<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>
|
||||
<div class="inheritance"><a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">io.github.simplexdevelopment.scheduler.ExecutableService</a>
|
||||
<div class="inheritance">io.github.simplexdevelopment.impl.ServiceImpl</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></code>, <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>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ServiceImpl</span>
|
||||
<span class="extends-implements">extends <a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></span></div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== 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(io.github.simplexdevelopment.impl.Main,io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">ServiceImpl</a><wbr>(<a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a> plugin,
|
||||
<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> pool)</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></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><a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></code></div>
|
||||
<div class="col-second even-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 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="#start()" class="member-name-link">start</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 start method for the service.</div>
|
||||
</div>
|
||||
<div class="col-first even-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 even-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 even-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">
|
||||
<h3 id="methods-inherited-from-class-io.github.simplexdevelopment.scheduler.ExecutableService">Methods inherited from class io.github.simplexdevelopment.scheduler.<a href="../scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></h3>
|
||||
<code><a href="../scheduler/ExecutableService.html#getDelay()">getDelay</a>, <a href="../scheduler/ExecutableService.html#getName()">getName</a>, <a href="../scheduler/ExecutableService.html#getParentPool()">getParentPool</a>, <a href="../scheduler/ExecutableService.html#getPeriod()">getPeriod</a>, <a href="../scheduler/ExecutableService.html#isCancelled()">isCancelled</a>, <a href="../scheduler/ExecutableService.html#isPeriodic()">isPeriodic</a>, <a href="../scheduler/ExecutableService.html#setCancelled(boolean)">setCancelled</a>, <a href="../scheduler/ExecutableService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)">setParentPool</a></code></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.Identifier">Methods inherited from interface io.github.simplexdevelopment.api.<a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></h3>
|
||||
<code><a href="../api/Identifier.html#getNumericalId()">getNumericalId</a>, <a href="../api/Identifier.html#getUniqueId()">getUniqueId</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="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></h3>
|
||||
<code><a href="../api/IService.html#run()">run</a></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>(io.github.simplexdevelopment.impl.Main,io.github.simplexdevelopment.scheduler.ServicePool)">
|
||||
<h3>ServiceImpl</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServiceImpl</span><wbr><span class="parameters">(<a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a> plugin,
|
||||
<a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> pool)</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="start()">
|
||||
<h3>start</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">start</span>()</div>
|
||||
<div class="block"><span class="descfrm-type-label">Description copied from interface: <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> <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">stop</span>()</div>
|
||||
<div class="block"><span class="descfrm-type-label">Description copied from interface: <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>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></span> <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>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,84 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>io.github.simplexdevelopment.impl (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.impl">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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="package-declaration-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../../../../index.html">Overview</a></li>
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>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#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li>Related Packages | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</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">
|
||||
<div class="header">
|
||||
<h1 title="Package io.github.simplexdevelopment.impl" class="title">Package io.github.simplexdevelopment.impl</h1>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">io.github.simplexdevelopment.impl</span></div>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
<div id="class-summary">
|
||||
<div class="caption"><span>Classes</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2"> </div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2"> </div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,84 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>io.github.simplexdevelopment.impl Class Hierarchy (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="tree: package: io.github.simplexdevelopment.impl">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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="package-tree-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../../../../index.html">Overview</a></li>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 class="title">Hierarchy For Package io.github.simplexdevelopment.impl</h1>
|
||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
||||
<ul class="horizontal">
|
||||
<li><a href="../../../../overview-tree.html">All Packages</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="../scheduler/ExecutableService.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a> (implements io.github.simplexdevelopment.api.<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>)
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.impl.<a href="ServiceImpl.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">org.bukkit.plugin.PluginBase (implements org.bukkit.plugin.Plugin)
|
||||
<ul>
|
||||
<li class="circle">org.bukkit.plugin.java.JavaPlugin
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.impl.<a href="Main.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">Main</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,279 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>BukkitDisposable (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, record: BukkitDisposable">
|
||||
<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="Record Class BukkitDisposable" class="title">Record Class BukkitDisposable</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"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" title="class or interface in java.lang" class="external-link">java.lang.Record</a>
|
||||
<div class="inheritance">io.github.simplexdevelopment.scheduler.BukkitDisposable</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code>reactor.core.Disposable</code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public record </span><span class="element-name type-name-label">BukkitDisposable</span>(org.bukkit.scheduler.BukkitTask task)
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" title="class or interface in java.lang" class="external-link">Record</a>
|
||||
implements reactor.core.Disposable</span></div>
|
||||
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</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>
|
||||
</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.scheduler.BukkitTask)" class="member-name-link">BukkitDisposable</a><wbr>(org.bukkit.scheduler.BukkitTask task)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates an instance of a <code>BukkitDisposable</code> record class.</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>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dispose()" class="member-name-link">dispose</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Disposes of the task upstream on the Bukkit scheduler.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<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> o)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Indicates whether some other object is "equal to" this one.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns a hash code value for this object.</div>
|
||||
</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="#isDisposed()" class="member-name-link">isDisposed</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Checks if the task is cancelled.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.bukkit.scheduler.BukkitTask</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#task()" class="member-name-link">task</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns the value of the <code>task</code> record component.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <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></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns a string representation of this record class.</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#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#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#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>
|
||||
</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.scheduler.BukkitTask)">
|
||||
<h3>BukkitDisposable</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BukkitDisposable</span><wbr><span class="parameters">(org.bukkit.scheduler.BukkitTask task)</span></div>
|
||||
<div class="block">Creates an instance of a <code>BukkitDisposable</code> record class.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>task</code> - the value for the <code>task</code> record component</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="dispose()">
|
||||
<h3>dispose</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">dispose</span>()</div>
|
||||
<div class="block">Disposes of the task upstream on the Bukkit scheduler.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code>dispose</code> in interface <code>reactor.core.Disposable</code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="isDisposed()">
|
||||
<h3>isDisposed</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isDisposed</span>()</div>
|
||||
<div class="block">Checks if the task is cancelled.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code>isDisposed</code> in interface <code>reactor.core.Disposable</code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>true if the task is cancelled, false otherwise.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString()">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><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></span> <span class="element-name">toString</span>()</div>
|
||||
<div class="block">Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.</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/Record.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" title="class or interface in java.lang" class="external-link">Record</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>a string representation of this object</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="hashCode()">
|
||||
<h3>hashCode</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div>
|
||||
<div class="block">Returns a hash code value for this object. The value is derived from the hash code of each of the record components.</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/Record.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" title="class or interface in java.lang" class="external-link">Record</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>a hash code value for this object</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="equals(java.lang.Object)">
|
||||
<h3>equals</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<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> o)</span></div>
|
||||
<div class="block">Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Objects.html#equals(java.lang.Object,java.lang.Object)" title="class or interface in java.util" class="external-link"><code>Objects::equals(Object,Object)</code></a>.</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/Record.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" title="class or interface in java.lang" class="external-link">Record</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>o</code> - the object with which to compare</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>true</code> if this object is the same as the <code>o</code> argument; <code>false</code> otherwise.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="task()">
|
||||
<h3>task</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.bukkit.scheduler.BukkitTask</span> <span class="element-name">task</span>()</div>
|
||||
<div class="block">Returns the value of the <code>task</code> record component.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the value of the <code>task</code> record component</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,433 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ExecutableService (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: 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="../../../../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>Nested | </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 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="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></code>, <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>
|
||||
</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="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></span></div>
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== 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(java.lang.String)" class="member-name-link">ExecutableService</a><wbr>(@NotNull <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> 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,java.lang.String)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool,
|
||||
@NotNull <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> 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,java.lang.String,java.lang.Long,java.lang.Long,java.lang.Boolean)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool,
|
||||
@NotNull <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> 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,java.lang.String,java.lang.Long)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool,
|
||||
@NotNull <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> 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,java.lang.String,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool,
|
||||
@NotNull <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> 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>long</code></div>
|
||||
<div class="col-second even-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 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><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></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</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>reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<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"> </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="#getPeriod()" class="member-name-link">getPeriod</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>boolean</code></div>
|
||||
<div class="col-second even-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 even-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 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="#isPeriodic()" class="member-name-link">isPeriodic</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>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="#setCancelled(boolean)" class="member-name-link">setCancelled</a><wbr>(boolean cancel)</code></div>
|
||||
<div class="col-last even-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 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="#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setParentPool</a><wbr>(<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> servicePool)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Sets the parent pool for 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.Identifier">Methods inherited from interface io.github.simplexdevelopment.api.<a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></h3>
|
||||
<code><a href="../api/Identifier.html#getNumericalId()">getNumericalId</a>, <a href="../api/Identifier.html#getUniqueId()">getUniqueId</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="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></h3>
|
||||
<code><a href="../api/IService.html#getPlugin()">getPlugin</a>, <a href="../api/IService.html#run()">run</a>, <a href="../api/IService.html#start()">start</a>, <a href="../api/IService.html#stop()">stop</a></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>(java.lang.String)">
|
||||
<h3>ExecutableService</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <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> service_name)</span></div>
|
||||
<div class="block">Creates a new instance of an executable service.
|
||||
Each service is registered with a <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"><code>String</code></a>,
|
||||
to allow for easy identification within the associated <a href="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,java.lang.String)">
|
||||
<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="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool,
|
||||
@NotNull
|
||||
@NotNull <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> service_name)</span></div>
|
||||
<div class="block">Creates a new instance of an executable service.
|
||||
Each service is registered with a <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"><code>String</code></a>,
|
||||
to allow for easy identification within the associated <a href="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="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,java.lang.String,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="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool,
|
||||
@NotNull
|
||||
@NotNull <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> 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 <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"><code>String</code></a>,
|
||||
to allow for easy identification within the associated <a href="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="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,java.lang.String,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="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool,
|
||||
@NotNull
|
||||
@NotNull <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> 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 <code>repeating</code> as true, and the period is null,
|
||||
then the period will automatically be set to 20 minutes.
|
||||
Each service is registered with a <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"><code>String</code></a>,
|
||||
to allow for easy identification within the associated <a href="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="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,java.lang.String,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="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> parentPool,
|
||||
@NotNull
|
||||
@NotNull <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> 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 <code>repeating</code> as true, and the period is null,
|
||||
then the period will automatically be set to 20 minutes.
|
||||
Each service is registered with a <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"><code>String</code></a>,
|
||||
to allow for easy identification within the associated <a href="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="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="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="../api/IService.html#getDelay()">getDelay</a></code> in interface <code><a href="../api/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="../api/IService.html#getPeriod()">getPeriod</a></code> in interface <code><a href="../api/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="../api/IService.html#isPeriodic()">isPeriodic</a></code> in interface <code><a href="../api/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="getParentPool()">
|
||||
<h3>getParentPool</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="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="../api/IService.html#getParentPool()">getParentPool</a></code> in interface <code><a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> which this service is executing on.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getName()">
|
||||
<h3>getName</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getName</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/Identifier.html#getName()">getName</a></code> in interface <code><a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The name of the identifiable object in a readable format.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)">
|
||||
<h3>setParentPool</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">setParentPool</span><wbr><span class="parameters">(<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> servicePool)</span></div>
|
||||
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../api/IService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)">IService</a></code></span></div>
|
||||
<div class="block">Sets the parent pool for this service.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/IService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)">setParentPool</a></code> in interface <code><a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>servicePool</code> - The service pool to attach this service to.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>An encapsulated Mono object representing the set operation.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,305 @@
|
||||
<!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>
|
||||
@ -0,0 +1,311 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SchedulingSystem (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: SchedulingSystem">
|
||||
<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>Nested | </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 SchedulingSystem" class="title">Class SchedulingSystem<T extends org.bukkit.plugin.java.JavaPlugin></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.SchedulingSystem<T></div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>T</code> - Your plugin class, which extends <code>JavaPlugin</code>.</dd>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">SchedulingSystem<T extends org.bukkit.plugin.java.JavaPlugin></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="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></span></div>
|
||||
<div class="block">This class is used to manage the scheduling of <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
||||
and the creation of <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.
|
||||
The <a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a> should be used to create new <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s on
|
||||
initialization of your plugin, and your <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s should be registered in the
|
||||
<code>JavaPlugin.onEnable()</code> method. You can then use the <a href="#queue(io.github.simplexdevelopment.api.IService)"><code>queue(IService)</code></a> method
|
||||
to then queue up your services, or call <a href="#queueAll()"><code>queueAll()</code></a> to queue up all services in every pool.
|
||||
<a href="#forceStart(io.github.simplexdevelopment.api.IService)"><code>forceStart(IService)</code></a> and <a href="#forceStop(io.github.simplexdevelopment.api.IService)"><code>forceStop(IService)</code></a> will forcefully start and stop the services, respectively.
|
||||
<a href="#getMainScheduler()"><code>getMainScheduler()</code></a> gets the main scheduler for the scheduling system, which is a <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> object.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a></li>
|
||||
<li><a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a></li>
|
||||
<li><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== 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(T)" class="member-name-link">SchedulingSystem</a><wbr>(<a href="SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> plugin)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new instance of the scheduling system.</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>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="#forceStart(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStart</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</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="#forceStop(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStop</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</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><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMainScheduler()" class="member-name-link">getMainScheduler</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>@NotNull reactor.core.publisher.Mono<<a href="SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProvidingPlugin()" class="member-name-link">getProvidingPlugin</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>@NotNull reactor.core.publisher.Mono<<a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServiceManager()" class="member-name-link">getServiceManager</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>@NotNull reactor.core.publisher.Mono<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="#queue(io.github.simplexdevelopment.api.IService)" class="member-name-link">queue</a><wbr>(@NotNull <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Queues a service to be executed in a service pool.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Flux<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="#queueAll()" class="member-name-link">queueAll</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>@NotNull 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="#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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>
|
||||
</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>(T)">
|
||||
<h3 id="<init>(org.bukkit.plugin.java.JavaPlugin)">SchedulingSystem</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SchedulingSystem</span><wbr><span class="parameters">(<a href="SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> plugin)</span></div>
|
||||
<div class="block">Creates a new instance of the scheduling system. This is used to manage the scheduling of services.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>plugin</code> - The plugin to use for this scheduling system. This should be an instance of your plugin.</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="getServiceManager()">
|
||||
<h3>getServiceManager</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a>></span> <span class="element-name">getServiceManager</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/ISchedule.html#getServiceManager()">getServiceManager</a></code> in interface <code><a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The service manager which exerts control over the service pools and their associated services.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="queue(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>queue</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<reactor.core.Disposable></span> <span class="element-name">queue</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../api/ISchedule.html#queue(io.github.simplexdevelopment.api.IService)">ISchedule</a></code></span></div>
|
||||
<div class="block">Queues a service to be executed in a service pool.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/ISchedule.html#queue(io.github.simplexdevelopment.api.IService)">queue</a></code> in interface <code><a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to use to locate the associated service pool and queue the service for execution.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object that can be used to cancel the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="queueAll()">
|
||||
<h3>queueAll</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Flux<reactor.core.Disposable></span> <span class="element-name">queueAll</span>()</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="runOnce(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>runOnce</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull 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">runOnce</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/ISchedule.html#runOnce(io.github.simplexdevelopment.api.IService)">runOnce</a></code> in interface <code><a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to run once.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="forceStop(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>forceStop</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">forceStop</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/ISchedule.html#forceStop(io.github.simplexdevelopment.api.IService)">forceStop</a></code> in interface <code><a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully stop.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="forceStart(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>forceStart</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">forceStart</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/ISchedule.html#forceStart(io.github.simplexdevelopment.api.IService)">forceStart</a></code> in interface <code><a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully start.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getProvidingPlugin()">
|
||||
<h3>getProvidingPlugin</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a>></span> <span class="element-name">getProvidingPlugin</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono object containing your plugin, for non-blocking communication.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getMainScheduler()">
|
||||
<h3>getMainScheduler</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true)
|
||||
</span><span class="modifiers">public</span> <span class="return-type"><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></span> <span class="element-name">getMainScheduler</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The main thread which the scheduling system operates on.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,367 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ServiceManager (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: ServiceManager">
|
||||
<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>Nested | </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 ServiceManager" class="title">Class ServiceManager</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.ServiceManager</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ServiceManager</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></span></div>
|
||||
<div class="block">The ServiceManager is a factory class for managing <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.
|
||||
You can use this class for easy creation of <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s,
|
||||
as well as adding and removing <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s from the pool. You can create an
|
||||
<a href="#emptyServicePool(java.lang.String,boolean)"><code>emptyServicePool(String, boolean)</code></a>, <a href="#createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)"><code>createServicePool(String, IService...)</code></a>,
|
||||
and even create a <a href="#multithreadedServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)"><code>multithreadedServicePool(String, IService...)</code></a>.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== 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()" class="member-name-link">ServiceManager</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new instance of the Service Manager class.</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>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addToExistingPool(io.github.simplexdevelopment.scheduler.ServicePool,io.github.simplexdevelopment.api.IService...)" class="member-name-link">addToExistingPool</a><wbr>(@NotNull <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> pool,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</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>@NotNull reactor.core.publisher.Mono<<a href="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="#bukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin,io.github.simplexdevelopment.api.IService...)" class="member-name-link">bukkitServicePool</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> poolName,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</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>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)" class="member-name-link">createServicePool</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> poolName,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</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>@NotNull reactor.core.publisher.Mono<<a href="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="#emptyBukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">emptyBukkitServicePool</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> poolName,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin)</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>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#emptyServicePool(java.lang.String,boolean)" class="member-name-link">emptyServicePool</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> poolName,
|
||||
boolean multithreaded)</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>@NotNull reactor.core.publisher.Mono<<a href="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="#getAssociatedServicePool(io.github.simplexdevelopment.api.IService)" class="member-name-link">getAssociatedServicePool</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</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>@NotNull reactor.core.publisher.Flux<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServicePools()" class="member-name-link">getServicePools</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="#locateServiceWithinPools(io.github.simplexdevelopment.api.IService)" class="member-name-link">locateServiceWithinPools</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</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>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#multithreadedServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)" class="member-name-link">multithreadedServicePool</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> name,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</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>@NotNull reactor.core.publisher.Mono<<a href="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="#takeFromExistingPool(io.github.simplexdevelopment.scheduler.ServicePool,io.github.simplexdevelopment.api.IService...)" class="member-name-link">takeFromExistingPool</a><wbr>(@NotNull <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> pool,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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>
|
||||
</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>()">
|
||||
<h3>ServiceManager</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServiceManager</span>()</div>
|
||||
<div class="block">Creates a new instance of the Service Manager class.
|
||||
This class acts as a Service Pool factory, and can be used to create
|
||||
both single and multithreaded Service Pools, empty service pools, as well as
|
||||
retrieve existing Service Pools. It also provides methods for you to add and remove
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s from the {ServicePool} parameter.</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="createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)">
|
||||
<h3>createServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true,
|
||||
value="_, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">createServicePool</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> poolName,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>poolName</code> - The name of the service pool.</dd>
|
||||
<dd><code>services</code> - The services to register within the service pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element.
|
||||
This service pool will execute each service consecutively within a singular non-blocking thread.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="emptyBukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin)">
|
||||
<h3>emptyBukkitServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true,
|
||||
value="_, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">emptyBukkitServicePool</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> poolName,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>poolName</code> - The name of the service pool.</dd>
|
||||
<dd><code>plugin</code> - The plugin which will be used to register the service pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element.
|
||||
This Service Pool will execute each service within the main server thread.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="bukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin,io.github.simplexdevelopment.api.IService...)">
|
||||
<h3>bukkitServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true,
|
||||
value="_, _, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">bukkitServicePool</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> poolName,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>poolName</code> - The name of the service pool.</dd>
|
||||
<dd><code>plugin</code> - The plugin which will be used to register the service pool.</dd>
|
||||
<dd><code>services</code> - The services to register within the service pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element.
|
||||
This Service Pool will execute each service within the main server thread.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="multithreadedServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)">
|
||||
<h3>multithreadedServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true,
|
||||
value="_, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">multithreadedServicePool</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> name,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>name</code> - The name of the service pool.</dd>
|
||||
<dd><code>services</code> - The services to register within the service pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element.
|
||||
This service pool will execute each service across a set of non-blocking threads.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="emptyServicePool(java.lang.String,boolean)">
|
||||
<h3>emptyServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true,
|
||||
value="_, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">emptyServicePool</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> poolName,
|
||||
boolean multithreaded)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>poolName</code> - The name of the service pool.</dd>
|
||||
<dd><code>multithreaded</code> - Whether the service pool should be multithreaded, or operate upon a single thread.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element.
|
||||
This pool is empty, meaning it contains no services. Any attempt to run services on this pool while it remains empty will either fail or error.
|
||||
You can add services to this pool by using <a href="#addToExistingPool(io.github.simplexdevelopment.scheduler.ServicePool,io.github.simplexdevelopment.api.IService...)"><code>addToExistingPool(ServicePool, IService...)</code></a>,
|
||||
or by using <code>ServicePool.addService(IService)</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="addToExistingPool(io.github.simplexdevelopment.scheduler.ServicePool,io.github.simplexdevelopment.api.IService...)">
|
||||
<h3>addToExistingPool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract("_, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">addToExistingPool</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> pool,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>pool</code> - The service pool to add to.</dd>
|
||||
<dd><code>services</code> - The services to register within the service pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains the <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element that now contains the registered services.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="takeFromExistingPool(io.github.simplexdevelopment.scheduler.ServicePool,io.github.simplexdevelopment.api.IService...)">
|
||||
<h3>takeFromExistingPool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract("_, _ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">takeFromExistingPool</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> pool,
|
||||
<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>... services)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>pool</code> - The service pool to take from.</dd>
|
||||
<dd><code>services</code> - The services to remove from the pool.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains the <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> that no longer contains the removed services.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getServicePools()">
|
||||
<h3>getServicePools</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(" -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Flux<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">getServicePools</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Flux</code> object which contains all the service pools currently available.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="locateServiceWithinPools(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>locateServiceWithinPools</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true)
|
||||
</span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">locateServiceWithinPools</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to locate.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>True if the service is somewhere within a service pool, false otherwise.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getAssociatedServicePool(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>getAssociatedServicePool</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract("_ -> new")
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">getAssociatedServicePool</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service pool to call from.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a> element which contains the specified service.
|
||||
If no service pool can be found, an empty Mono is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,371 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ServicePool (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: ServicePool">
|
||||
<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>Nested | </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 ServicePool" class="title">Class ServicePool</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.ServicePool</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ServicePool</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="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></span></div>
|
||||
<div class="block">A service pool is a collection of services which are managed by a single scheduler.
|
||||
The scheduler can either be an instance of <code>Scheduler</code> or <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a>.
|
||||
Using <code>Scheduler</code> allows for more flexibility, but doesn't communicate with the Main thread.
|
||||
Using <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> allows for communication with the Main thread, but is less flexible.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a></li>
|
||||
<li><code>Scheduler</code></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== 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(java.lang.String,boolean)" class="member-name-link">ServicePool</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> name,
|
||||
boolean multithreaded)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">This will create a new instance of a Service Pool with a <code>Scheduler</code> as its main scheduler.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ServicePool</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> name,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">This will create a new instance of a Service Pool with the <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> as its main scheduler.</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>@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAssociatedServices()" class="member-name-link">getAssociatedServices</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><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></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</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>reactor.core.scheduler.Scheduler</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheduler()" class="member-name-link">getScheduler</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>@NotNull reactor.core.publisher.Mono<<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getService(java.lang.String)" class="member-name-link">getService</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> service_name)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets a service based on the name of the service defined by <a href="../api/Identifier.html#getName()"><code>Identifier.getName()</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<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="#queueService(io.github.simplexdevelopment.api.IService)" class="member-name-link">queueService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This method is the actual method used to schedule a service.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Flux<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="#queueServices()" class="member-name-link">queueServices</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This method can be used to start all the services registered with this pool.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recycle()" class="member-name-link">recycle</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This will clear the ServicePool of all services and return an empty pool.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull 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="#stopService(java.lang.String,reactor.core.publisher.Mono)" class="member-name-link">stopService</a><wbr>(@NotNull <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> service_name,
|
||||
@Nullable reactor.core.publisher.Mono<reactor.core.Disposable> disposable)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This is the method used to stop a service.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull 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="#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices</a><wbr>(@NotNull reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">This method can be used to stop all the services registered with this pool.</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.Identifier">Methods inherited from interface io.github.simplexdevelopment.api.<a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></h3>
|
||||
<code><a href="../api/Identifier.html#getNumericalId()">getNumericalId</a>, <a href="../api/Identifier.html#getUniqueId()">getUniqueId</a></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>(java.lang.String,boolean)">
|
||||
<h3>ServicePool</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServicePool</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> name,
|
||||
boolean multithreaded)</span></div>
|
||||
<div class="block">This will create a new instance of a Service Pool with a <code>Scheduler</code> as its main scheduler.
|
||||
This should be used if you'd like to execute tasks without communicating on the main server thread.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>name</code> - The name of this service pool.</dd>
|
||||
<dd><code>multithreaded</code> - Whether this service pool should be multithreaded, or operate upon a single thread.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String,org.bukkit.plugin.java.JavaPlugin)">
|
||||
<h3>ServicePool</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServicePool</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> name,
|
||||
org.bukkit.plugin.java.JavaPlugin plugin)</span></div>
|
||||
<div class="block">This will create a new instance of a Service Pool with the <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> as its main scheduler.
|
||||
This should be used if you'd like to execute tasks while communicating on the main server thread.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>name</code> - The name of this service pool.</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="getAssociatedServices()">
|
||||
<h3>getAssociatedServices</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true)
|
||||
@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>></span> <span class="element-name">getAssociatedServices</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link"><code>Set</code></a> of <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a> objects which are registered with this pool.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="queueService(io.github.simplexdevelopment.api.IService)">
|
||||
<h3>queueService</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<reactor.core.Disposable></span> <span class="element-name">queueService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div>
|
||||
<div class="block">This method is the actual method used to schedule a service.
|
||||
This will register the service with the scheduler, and then return a <code>Disposable</code> object
|
||||
encapsulated within a <code>Mono</code>. If <a href="../api/IService.html#isPeriodic()"><code>IService.isPeriodic()</code></a> returns true, then the service
|
||||
will be scheduled to run periodically. Otherwise, it will be scheduled to run once.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The name of the service to queue. This should be a service that is located within this service pool.
|
||||
If you name a service that is stored within another service pool,
|
||||
this method will throw an error.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains a <code>Disposable</code> element which can be used to destroy the registered service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="queueServices()">
|
||||
<h3>queueServices</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Flux<reactor.core.Disposable></span> <span class="element-name">queueServices</span>()</div>
|
||||
<div class="block">This method can be used to start all the services registered with this pool.
|
||||
If there are no services, this will do nothing.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Flux</code> object which contains a collection of <code>Disposable</code> elements,
|
||||
which can be used to destroy the registered services using <a href="#stopServices(reactor.core.publisher.Flux)"><code>stopServices(Flux)</code></a>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="stopServices(reactor.core.publisher.Flux)">
|
||||
<h3>stopServices</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull 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">stopServices</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)</span></div>
|
||||
<div class="block">This method can be used to stop all the services registered with this pool.
|
||||
If there are no services, this will do nothing.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>disposableThread</code> - A <code>reactor.core.publisher.Flux<reactor.core.Disposable></code> which contains all the services that should be disposed..</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <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> object which can be used to stop the services.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="stopService(java.lang.String,reactor.core.publisher.Mono)">
|
||||
<h3>stopService</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull 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">stopService</span><wbr><span class="parameters">(@NotNull
|
||||
@NotNull <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> service_name,
|
||||
@Nullable
|
||||
@Nullable reactor.core.publisher.Mono<reactor.core.Disposable> disposable)</span></div>
|
||||
<div class="block">This is the method used to stop a service. This will call the relative <code>Disposable.dispose()</code> method
|
||||
to the <code>Scheduler</code> supplied for this pool. If you are using the <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a>,
|
||||
this will cancel the task upstream on the <code>BukkitScheduler</code>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service_name</code> - The name of the service to stop.</dd>
|
||||
<dd><code>disposable</code> - A <code>Disposable</code> object which contains the service that should be disposed.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <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> object which can be used to stop the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getService(java.lang.String)">
|
||||
<h3>getService</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>></span> <span class="element-name">getService</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> service_name)</span></div>
|
||||
<div class="block">Gets a service based on the name of the service defined by <a href="../api/Identifier.html#getName()"><code>Identifier.getName()</code></a>.
|
||||
This will search the service pool for a service with the same name, and return it.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service_name</code> - The name of the service to get.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A <code>Mono</code> object which contains the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="recycle()">
|
||||
<h3>recycle</h3>
|
||||
<div class="member-signature"><span class="annotations">@NotNull
|
||||
</span><span class="modifiers">public</span> <span class="return-type">@NotNull reactor.core.publisher.Mono<<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">recycle</span>()</div>
|
||||
<div class="block">This will clear the ServicePool of all services and return an empty pool.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>This service pool after being cleared of all services.
|
||||
You will need to register services with this pool again before using it.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getScheduler()">
|
||||
<h3>getScheduler</h3>
|
||||
<div class="member-signature"><span class="annotations">@Contract(pure=true)
|
||||
</span><span class="modifiers">public</span> <span class="return-type">reactor.core.scheduler.Scheduler</span> <span class="element-name">getScheduler</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The <code>Scheduler</code> which hosts the threads for the service pool.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getName()">
|
||||
<h3>getName</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getName</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="../api/Identifier.html#getName()">getName</a></code> in interface <code><a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The name of the identifiable object in a readable format.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,111 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>io.github.simplexdevelopment.scheduler (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">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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="package-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 class="nav-bar-cell1-rev">Package</li>
|
||||
<li>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#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li>Related Packages | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</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">
|
||||
<div class="header">
|
||||
<h1 title="Package io.github.simplexdevelopment.scheduler" class="title">Package io.github.simplexdevelopment.scheduler</h1>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">io.github.simplexdevelopment.scheduler</span></div>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
<div id="class-summary">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab4" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab4', 2)" class="table-tab">Record Classes</button></div>
|
||||
<div id="class-summary.tabpanel" role="tabpanel">
|
||||
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab4"><a href="BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab4">
|
||||
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><T extends org.bukkit.plugin.java.JavaPlugin></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">This class is used to manage the scheduling of <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
||||
and the creation of <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">The ServiceManager is a factory class for managing <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,80 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>io.github.simplexdevelopment.scheduler Class Hierarchy (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="tree: package: io.github.simplexdevelopment.scheduler">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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="package-tree-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../../../../index.html">Overview</a></li>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 class="title">Hierarchy For Package io.github.simplexdevelopment.scheduler</h1>
|
||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
||||
<ul class="horizontal">
|
||||
<li><a href="../../../../overview-tree.html">All Packages</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="ExecutableService.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a> (implements io.github.simplexdevelopment.api.<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>)</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="ReactorBukkitScheduler.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a> (implements reactor.core.scheduler.Scheduler, reactor.core.scheduler.Scheduler.Worker)</li>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" class="type-name-link external-link" title="class or interface in java.lang">Record</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="BukkitDisposable.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a> (implements reactor.core.Disposable)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="SchedulingSystem.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><T> (implements io.github.simplexdevelopment.api.<a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a>)</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="ServiceManager.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> (implements io.github.simplexdevelopment.api.<a href="../api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
34
build/docs/javadoc/jquery-ui.overrides.css
vendored
Normal file
34
build/docs/javadoc/jquery-ui.overrides.css
vendored
Normal file
@ -0,0 +1,34 @@
|
||||
/*
|
||||
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
|
||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||
*
|
||||
* This code is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License version 2 only, as
|
||||
* published by the Free Software Foundation. Oracle designates this
|
||||
* particular file as subject to the "Classpath" exception as provided
|
||||
* by Oracle in the LICENSE file that accompanied this code.
|
||||
*
|
||||
* This code is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
* version 2 for more details (a copy is included in the LICENSE file that
|
||||
* accompanied this code).
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License version
|
||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
*
|
||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
||||
* or visit www.oracle.com if you need additional information or have any
|
||||
* questions.
|
||||
*/
|
||||
|
||||
.ui-state-active,
|
||||
.ui-widget-content .ui-state-active,
|
||||
.ui-widget-header .ui-state-active,
|
||||
a.ui-button:active,
|
||||
.ui-button:active,
|
||||
.ui-button.ui-state-active:hover {
|
||||
/* Overrides the color of selection used in jQuery UI */
|
||||
background: #F8981D;
|
||||
}
|
||||
1
build/docs/javadoc/legal/ADDITIONAL_LICENSE_INFO
Normal file
1
build/docs/javadoc/legal/ADDITIONAL_LICENSE_INFO
Normal file
@ -0,0 +1 @@
|
||||
Please see ..\java.base\ADDITIONAL_LICENSE_INFO
|
||||
1
build/docs/javadoc/legal/ASSEMBLY_EXCEPTION
Normal file
1
build/docs/javadoc/legal/ASSEMBLY_EXCEPTION
Normal file
@ -0,0 +1 @@
|
||||
Please see ..\java.base\ASSEMBLY_EXCEPTION
|
||||
1
build/docs/javadoc/legal/LICENSE
Normal file
1
build/docs/javadoc/legal/LICENSE
Normal file
@ -0,0 +1 @@
|
||||
Please see ..\java.base\LICENSE
|
||||
72
build/docs/javadoc/legal/jquery.md
Normal file
72
build/docs/javadoc/legal/jquery.md
Normal file
@ -0,0 +1,72 @@
|
||||
## jQuery v3.5.1
|
||||
|
||||
### jQuery License
|
||||
```
|
||||
jQuery v 3.5.1
|
||||
Copyright JS Foundation and other contributors, https://js.foundation/
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
******************************************
|
||||
|
||||
The jQuery JavaScript Library v3.5.1 also includes Sizzle.js
|
||||
|
||||
Sizzle.js includes the following license:
|
||||
|
||||
Copyright JS Foundation and other contributors, https://js.foundation/
|
||||
|
||||
This software consists of voluntary contributions made by many
|
||||
individuals. For exact contribution history, see the revision history
|
||||
available at https://github.com/jquery/sizzle
|
||||
|
||||
The following license applies to all parts of this software except as
|
||||
documented below:
|
||||
|
||||
====
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
====
|
||||
|
||||
All files located in the node_modules and external directories are
|
||||
externally maintained libraries used by this software which have their
|
||||
own licenses; we recommend you read them, as their terms may differ from
|
||||
the terms above.
|
||||
|
||||
*********************
|
||||
|
||||
```
|
||||
49
build/docs/javadoc/legal/jqueryUI.md
Normal file
49
build/docs/javadoc/legal/jqueryUI.md
Normal file
@ -0,0 +1,49 @@
|
||||
## jQuery UI v1.12.1
|
||||
|
||||
### jQuery UI License
|
||||
```
|
||||
Copyright jQuery Foundation and other contributors, https://jquery.org/
|
||||
|
||||
This software consists of voluntary contributions made by many
|
||||
individuals. For exact contribution history, see the revision history
|
||||
available at https://github.com/jquery/jquery-ui
|
||||
|
||||
The following license applies to all parts of this software except as
|
||||
documented below:
|
||||
|
||||
====
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
====
|
||||
|
||||
Copyright and related rights for sample code are waived via CC0. Sample
|
||||
code is defined as all source code contained within the demos directory.
|
||||
|
||||
CC0: http://creativecommons.org/publicdomain/zero/1.0/
|
||||
|
||||
====
|
||||
|
||||
All files located in the node_modules and external directories are
|
||||
externally maintained libraries used by this software which have their
|
||||
own licenses; we recommend you read them, as their terms may differ from
|
||||
the terms above.
|
||||
|
||||
```
|
||||
1
build/docs/javadoc/member-search-index.js
Normal file
1
build/docs/javadoc/member-search-index.js
Normal file
File diff suppressed because one or more lines are too long
1
build/docs/javadoc/module-search-index.js
Normal file
1
build/docs/javadoc/module-search-index.js
Normal file
@ -0,0 +1 @@
|
||||
moduleSearchIndex = [];updateSearchResults();
|
||||
25
build/docs/javadoc/overview-summary.html
Normal file
25
build/docs/javadoc/overview-summary.html
Normal file
@ -0,0 +1,25 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>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="index redirect">
|
||||
<meta name="generator" content="javadoc/IndexRedirectWriter">
|
||||
<link rel="canonical" href="index.html">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script type="text/javascript">window.location.replace('index.html')</script>
|
||||
<noscript>
|
||||
<meta http-equiv="Refresh" content="0;index.html">
|
||||
</noscript>
|
||||
</head>
|
||||
<body class="index-redirect-page">
|
||||
<main role="main">
|
||||
<noscript>
|
||||
<p>JavaScript is disabled on your browser.</p>
|
||||
</noscript>
|
||||
<p><a href="index.html">index.html</a></p>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
126
build/docs/javadoc/overview-tree.html
Normal file
126
build/docs/javadoc/overview-tree.html
Normal file
@ -0,0 +1,126 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Class Hierarchy (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="class tree">
|
||||
<meta name="generator" content="javadoc/TreeWriter">
|
||||
<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="tree-page">
|
||||
<script type="text/javascript">var pathtoroot = "./";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 class="title">Hierarchy For All Packages</h1>
|
||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
||||
<ul class="horizontal">
|
||||
<li><a href="io/github/simplexdevelopment/api/package-tree.html">io.github.simplexdevelopment.api</a>, </li>
|
||||
<li><a href="io/github/simplexdevelopment/impl/package-tree.html">io.github.simplexdevelopment.impl</a>, </li>
|
||||
<li><a href="io/github/simplexdevelopment/scheduler/package-tree.html">io.github.simplexdevelopment.scheduler</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a> (implements io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>)
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/ServiceImpl.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">org.bukkit.plugin.PluginBase (implements org.bukkit.plugin.Plugin)
|
||||
<ul>
|
||||
<li class="circle">org.bukkit.plugin.java.JavaPlugin
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.impl.<a href="io/github/simplexdevelopment/impl/Main.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">Main</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a> (implements reactor.core.scheduler.Scheduler, reactor.core.scheduler.Scheduler.Worker)</li>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html" class="type-name-link external-link" title="class or interface in java.lang">Record</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a> (implements reactor.core.Disposable)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><T> (implements io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a>)</li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></li>
|
||||
<li class="circle">io.github.simplexdevelopment.scheduler.<a href="io/github/simplexdevelopment/scheduler/ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> (implements io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a>)</li>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" class="type-name-link external-link" title="class or interface in java.lang">Throwable</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" class="type-name-link external-link" title="class or interface in java.lang">Exception</a>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" class="type-name-link external-link" title="class or interface in java.lang">RuntimeException</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServiceException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServiceException</a></li>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ServicePoolException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Context.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Context</a><S></li>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Identifier.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Identifier</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">IService</a> (also extends java.lang.<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>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/ISchedule.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">ISchedule</a></li>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Runnable.html" class="type-name-link external-link" title="class or interface in java.lang">Runnable</a>
|
||||
<ul>
|
||||
<li class="circle">io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/IService.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">IService</a> (also extends io.github.simplexdevelopment.api.<a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
1
build/docs/javadoc/package-search-index.js
Normal file
1
build/docs/javadoc/package-search-index.js
Normal file
@ -0,0 +1 @@
|
||||
packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"io.github.simplexdevelopment.api"},{"l":"io.github.simplexdevelopment.impl"},{"l":"io.github.simplexdevelopment.scheduler"}];updateSearchResults();
|
||||
BIN
build/docs/javadoc/resources/glass.png
Normal file
BIN
build/docs/javadoc/resources/glass.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 499 B |
BIN
build/docs/javadoc/resources/x.png
Normal file
BIN
build/docs/javadoc/resources/x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 394 B |
Binary file not shown.
|
After Width: | Height: | Size: 335 B |
Binary file not shown.
|
After Width: | Height: | Size: 262 B |
Binary file not shown.
|
After Width: | Height: | Size: 262 B |
Binary file not shown.
|
After Width: | Height: | Size: 262 B |
Binary file not shown.
|
After Width: | Height: | Size: 332 B |
Binary file not shown.
|
After Width: | Height: | Size: 280 B |
BIN
build/docs/javadoc/script-dir/images/ui-icons_222222_256x240.png
Normal file
BIN
build/docs/javadoc/script-dir/images/ui-icons_222222_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
BIN
build/docs/javadoc/script-dir/images/ui-icons_2e83ff_256x240.png
Normal file
BIN
build/docs/javadoc/script-dir/images/ui-icons_2e83ff_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
BIN
build/docs/javadoc/script-dir/images/ui-icons_454545_256x240.png
Normal file
BIN
build/docs/javadoc/script-dir/images/ui-icons_454545_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
BIN
build/docs/javadoc/script-dir/images/ui-icons_888888_256x240.png
Normal file
BIN
build/docs/javadoc/script-dir/images/ui-icons_888888_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
BIN
build/docs/javadoc/script-dir/images/ui-icons_cd0a0a_256x240.png
Normal file
BIN
build/docs/javadoc/script-dir/images/ui-icons_cd0a0a_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
2
build/docs/javadoc/script-dir/jquery-3.5.1.min.js
vendored
Normal file
2
build/docs/javadoc/script-dir/jquery-3.5.1.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
7
build/docs/javadoc/script-dir/jquery-ui.min.css
vendored
Normal file
7
build/docs/javadoc/script-dir/jquery-ui.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
6
build/docs/javadoc/script-dir/jquery-ui.min.js
vendored
Normal file
6
build/docs/javadoc/script-dir/jquery-ui.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
5
build/docs/javadoc/script-dir/jquery-ui.structure.min.css
vendored
Normal file
5
build/docs/javadoc/script-dir/jquery-ui.structure.min.css
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
/*! jQuery UI - v1.12.1 - 2018-12-06
|
||||
* http://jqueryui.com
|
||||
* Copyright jQuery Foundation and other contributors; Licensed MIT */
|
||||
|
||||
.ui-helper-hidden{display:none}.ui-helper-hidden-accessible{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.ui-helper-reset{margin:0;padding:0;border:0;outline:0;line-height:1.3;text-decoration:none;font-size:100%;list-style:none}.ui-helper-clearfix:before,.ui-helper-clearfix:after{content:"";display:table;border-collapse:collapse}.ui-helper-clearfix:after{clear:both}.ui-helper-zfix{width:100%;height:100%;top:0;left:0;position:absolute;opacity:0;filter:Alpha(Opacity=0)}.ui-front{z-index:100}.ui-state-disabled{cursor:default!important;pointer-events:none}.ui-icon{display:inline-block;vertical-align:middle;margin-top:-.25em;position:relative;text-indent:-99999px;overflow:hidden;background-repeat:no-repeat}.ui-widget-icon-block{left:50%;margin-left:-8px;display:block}.ui-widget-overlay{position:fixed;top:0;left:0;width:100%;height:100%}.ui-autocomplete{position:absolute;top:0;left:0;cursor:default}.ui-menu{list-style:none;padding:0;margin:0;display:block;outline:0}.ui-menu .ui-menu{position:absolute}.ui-menu .ui-menu-item{margin:0;cursor:pointer;list-style-image:url("data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7")}.ui-menu .ui-menu-item-wrapper{position:relative;padding:3px 1em 3px .4em}.ui-menu .ui-menu-divider{margin:5px 0;height:0;font-size:0;line-height:0;border-width:1px 0 0 0}.ui-menu .ui-state-focus,.ui-menu .ui-state-active{margin:-1px}.ui-menu-icons{position:relative}.ui-menu-icons .ui-menu-item-wrapper{padding-left:2em}.ui-menu .ui-icon{position:absolute;top:0;bottom:0;left:.2em;margin:auto 0}.ui-menu .ui-menu-icon{left:auto;right:0}
|
||||
132
build/docs/javadoc/script.js
Normal file
132
build/docs/javadoc/script.js
Normal file
@ -0,0 +1,132 @@
|
||||
/*
|
||||
* Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved.
|
||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||
*
|
||||
* This code is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License version 2 only, as
|
||||
* published by the Free Software Foundation. Oracle designates this
|
||||
* particular file as subject to the "Classpath" exception as provided
|
||||
* by Oracle in the LICENSE file that accompanied this code.
|
||||
*
|
||||
* This code is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
* version 2 for more details (a copy is included in the LICENSE file that
|
||||
* accompanied this code).
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License version
|
||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
*
|
||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
||||
* or visit www.oracle.com if you need additional information or have any
|
||||
* questions.
|
||||
*/
|
||||
|
||||
var moduleSearchIndex;
|
||||
var packageSearchIndex;
|
||||
var typeSearchIndex;
|
||||
var memberSearchIndex;
|
||||
var tagSearchIndex;
|
||||
function loadScripts(doc, tag) {
|
||||
createElem(doc, tag, 'search.js');
|
||||
|
||||
createElem(doc, tag, 'module-search-index.js');
|
||||
createElem(doc, tag, 'package-search-index.js');
|
||||
createElem(doc, tag, 'type-search-index.js');
|
||||
createElem(doc, tag, 'member-search-index.js');
|
||||
createElem(doc, tag, 'tag-search-index.js');
|
||||
}
|
||||
|
||||
function createElem(doc, tag, path) {
|
||||
var script = doc.createElement(tag);
|
||||
var scriptElement = doc.getElementsByTagName(tag)[0];
|
||||
script.src = pathtoroot + path;
|
||||
scriptElement.parentNode.insertBefore(script, scriptElement);
|
||||
}
|
||||
|
||||
function show(tableId, selected, columns) {
|
||||
if (tableId !== selected) {
|
||||
document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')')
|
||||
.forEach(function(elem) {
|
||||
elem.style.display = 'none';
|
||||
});
|
||||
}
|
||||
document.querySelectorAll('div.' + selected)
|
||||
.forEach(function(elem, index) {
|
||||
elem.style.display = '';
|
||||
var isEvenRow = index % (columns * 2) < columns;
|
||||
elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor);
|
||||
elem.classList.add(isEvenRow ? evenRowColor : oddRowColor);
|
||||
});
|
||||
updateTabs(tableId, selected);
|
||||
}
|
||||
|
||||
function updateTabs(tableId, selected) {
|
||||
document.querySelector('div#' + tableId +' .summary-table')
|
||||
.setAttribute('aria-labelledby', selected);
|
||||
document.querySelectorAll('button[id^="' + tableId + '"]')
|
||||
.forEach(function(tab, index) {
|
||||
if (selected === tab.id || (tableId === selected && index === 0)) {
|
||||
tab.className = activeTableTab;
|
||||
tab.setAttribute('aria-selected', true);
|
||||
tab.setAttribute('tabindex',0);
|
||||
} else {
|
||||
tab.className = tableTab;
|
||||
tab.setAttribute('aria-selected', false);
|
||||
tab.setAttribute('tabindex',-1);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function switchTab(e) {
|
||||
var selected = document.querySelector('[aria-selected=true]');
|
||||
if (selected) {
|
||||
if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) {
|
||||
// left or up arrow key pressed: move focus to previous tab
|
||||
selected.previousSibling.click();
|
||||
selected.previousSibling.focus();
|
||||
e.preventDefault();
|
||||
} else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) {
|
||||
// right or down arrow key pressed: move focus to next tab
|
||||
selected.nextSibling.click();
|
||||
selected.nextSibling.focus();
|
||||
e.preventDefault();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var updateSearchResults = function() {};
|
||||
|
||||
function indexFilesLoaded() {
|
||||
return moduleSearchIndex
|
||||
&& packageSearchIndex
|
||||
&& typeSearchIndex
|
||||
&& memberSearchIndex
|
||||
&& tagSearchIndex;
|
||||
}
|
||||
|
||||
// Workaround for scroll position not being included in browser history (8249133)
|
||||
document.addEventListener("DOMContentLoaded", function(e) {
|
||||
var contentDiv = document.querySelector("div.flex-content");
|
||||
window.addEventListener("popstate", function(e) {
|
||||
if (e.state !== null) {
|
||||
contentDiv.scrollTop = e.state;
|
||||
}
|
||||
});
|
||||
window.addEventListener("hashchange", function(e) {
|
||||
history.replaceState(contentDiv.scrollTop, document.title);
|
||||
});
|
||||
contentDiv.addEventListener("scroll", function(e) {
|
||||
var timeoutID;
|
||||
if (!timeoutID) {
|
||||
timeoutID = setTimeout(function() {
|
||||
history.replaceState(contentDiv.scrollTop, document.title);
|
||||
timeoutID = null;
|
||||
}, 100);
|
||||
}
|
||||
});
|
||||
if (!location.hash) {
|
||||
history.replaceState(contentDiv.scrollTop, document.title);
|
||||
}
|
||||
});
|
||||
354
build/docs/javadoc/search.js
Normal file
354
build/docs/javadoc/search.js
Normal file
@ -0,0 +1,354 @@
|
||||
/*
|
||||
* Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved.
|
||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||
*
|
||||
* This code is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License version 2 only, as
|
||||
* published by the Free Software Foundation. Oracle designates this
|
||||
* particular file as subject to the "Classpath" exception as provided
|
||||
* by Oracle in the LICENSE file that accompanied this code.
|
||||
*
|
||||
* This code is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
* version 2 for more details (a copy is included in the LICENSE file that
|
||||
* accompanied this code).
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License version
|
||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
*
|
||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
||||
* or visit www.oracle.com if you need additional information or have any
|
||||
* questions.
|
||||
*/
|
||||
|
||||
var noResult = {l: "No results found"};
|
||||
var loading = {l: "Loading search index..."};
|
||||
var catModules = "Modules";
|
||||
var catPackages = "Packages";
|
||||
var catTypes = "Classes and Interfaces";
|
||||
var catMembers = "Members";
|
||||
var catSearchTags = "Search Tags";
|
||||
var highlight = "<span class=\"result-highlight\">$&</span>";
|
||||
var searchPattern = "";
|
||||
var fallbackPattern = "";
|
||||
var RANKING_THRESHOLD = 2;
|
||||
var NO_MATCH = 0xffff;
|
||||
var MIN_RESULTS = 3;
|
||||
var MAX_RESULTS = 500;
|
||||
var UNNAMED = "<Unnamed>";
|
||||
function escapeHtml(str) {
|
||||
return str.replace(/</g, "<").replace(/>/g, ">");
|
||||
}
|
||||
function getHighlightedText(item, matcher, fallbackMatcher) {
|
||||
var escapedItem = escapeHtml(item);
|
||||
var highlighted = escapedItem.replace(matcher, highlight);
|
||||
if (highlighted === escapedItem) {
|
||||
highlighted = escapedItem.replace(fallbackMatcher, highlight)
|
||||
}
|
||||
return highlighted;
|
||||
}
|
||||
function getURLPrefix(ui) {
|
||||
var urlPrefix="";
|
||||
var slash = "/";
|
||||
if (ui.item.category === catModules) {
|
||||
return ui.item.l + slash;
|
||||
} else if (ui.item.category === catPackages && ui.item.m) {
|
||||
return ui.item.m + slash;
|
||||
} else if (ui.item.category === catTypes || ui.item.category === catMembers) {
|
||||
if (ui.item.m) {
|
||||
urlPrefix = ui.item.m + slash;
|
||||
} else {
|
||||
$.each(packageSearchIndex, function(index, item) {
|
||||
if (item.m && ui.item.p === item.l) {
|
||||
urlPrefix = item.m + slash;
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
return urlPrefix;
|
||||
}
|
||||
function createSearchPattern(term) {
|
||||
var pattern = "";
|
||||
var isWordToken = false;
|
||||
term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) {
|
||||
if (index > 0) {
|
||||
// whitespace between identifiers is significant
|
||||
pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*";
|
||||
}
|
||||
var tokens = w.split(/(?=[A-Z,.()<>[\/])/);
|
||||
for (var i = 0; i < tokens.length; i++) {
|
||||
var s = tokens[i];
|
||||
if (s === "") {
|
||||
continue;
|
||||
}
|
||||
pattern += $.ui.autocomplete.escapeRegex(s);
|
||||
isWordToken = /\w$/.test(s);
|
||||
if (isWordToken) {
|
||||
pattern += "([a-z0-9_$<>\\[\\]]*?)";
|
||||
}
|
||||
}
|
||||
});
|
||||
return pattern;
|
||||
}
|
||||
function createMatcher(pattern, flags) {
|
||||
var isCamelCase = /[A-Z]/.test(pattern);
|
||||
return new RegExp(pattern, flags + (isCamelCase ? "" : "i"));
|
||||
}
|
||||
var watermark = 'Search';
|
||||
$(function() {
|
||||
var search = $("#search-input");
|
||||
var reset = $("#reset-button");
|
||||
search.val('');
|
||||
search.prop("disabled", false);
|
||||
reset.prop("disabled", false);
|
||||
search.val(watermark).addClass('watermark');
|
||||
search.blur(function() {
|
||||
if ($(this).val().length === 0) {
|
||||
$(this).val(watermark).addClass('watermark');
|
||||
}
|
||||
});
|
||||
search.on('click keydown paste', function() {
|
||||
if ($(this).val() === watermark) {
|
||||
$(this).val('').removeClass('watermark');
|
||||
}
|
||||
});
|
||||
reset.click(function() {
|
||||
search.val('').focus();
|
||||
});
|
||||
search.focus()[0].setSelectionRange(0, 0);
|
||||
});
|
||||
$.widget("custom.catcomplete", $.ui.autocomplete, {
|
||||
_create: function() {
|
||||
this._super();
|
||||
this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)");
|
||||
},
|
||||
_renderMenu: function(ul, items) {
|
||||
var rMenu = this;
|
||||
var currentCategory = "";
|
||||
rMenu.menu.bindings = $();
|
||||
$.each(items, function(index, item) {
|
||||
var li;
|
||||
if (item.category && item.category !== currentCategory) {
|
||||
ul.append("<li class=\"ui-autocomplete-category\">" + item.category + "</li>");
|
||||
currentCategory = item.category;
|
||||
}
|
||||
li = rMenu._renderItemData(ul, item);
|
||||
if (item.category) {
|
||||
li.attr("aria-label", item.category + " : " + item.l);
|
||||
li.attr("class", "result-item");
|
||||
} else {
|
||||
li.attr("aria-label", item.l);
|
||||
li.attr("class", "result-item");
|
||||
}
|
||||
});
|
||||
},
|
||||
_renderItem: function(ul, item) {
|
||||
var label = "";
|
||||
var matcher = createMatcher(escapeHtml(searchPattern), "g");
|
||||
var fallbackMatcher = new RegExp(fallbackPattern, "gi")
|
||||
if (item.category === catModules) {
|
||||
label = getHighlightedText(item.l, matcher, fallbackMatcher);
|
||||
} else if (item.category === catPackages) {
|
||||
label = getHighlightedText(item.l, matcher, fallbackMatcher);
|
||||
} else if (item.category === catTypes) {
|
||||
label = (item.p && item.p !== UNNAMED)
|
||||
? getHighlightedText(item.p + "." + item.l, matcher, fallbackMatcher)
|
||||
: getHighlightedText(item.l, matcher, fallbackMatcher);
|
||||
} else if (item.category === catMembers) {
|
||||
label = (item.p && item.p !== UNNAMED)
|
||||
? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher, fallbackMatcher)
|
||||
: getHighlightedText(item.c + "." + item.l, matcher, fallbackMatcher);
|
||||
} else if (item.category === catSearchTags) {
|
||||
label = getHighlightedText(item.l, matcher, fallbackMatcher);
|
||||
} else {
|
||||
label = item.l;
|
||||
}
|
||||
var li = $("<li/>").appendTo(ul);
|
||||
var div = $("<div/>").appendTo(li);
|
||||
if (item.category === catSearchTags && item.h) {
|
||||
if (item.d) {
|
||||
div.html(label + "<span class=\"search-tag-holder-result\"> (" + item.h + ")</span><br><span class=\"search-tag-desc-result\">"
|
||||
+ item.d + "</span><br>");
|
||||
} else {
|
||||
div.html(label + "<span class=\"search-tag-holder-result\"> (" + item.h + ")</span>");
|
||||
}
|
||||
} else {
|
||||
if (item.m) {
|
||||
div.html(item.m + "/" + label);
|
||||
} else {
|
||||
div.html(label);
|
||||
}
|
||||
}
|
||||
return li;
|
||||
}
|
||||
});
|
||||
function rankMatch(match, category) {
|
||||
if (!match) {
|
||||
return NO_MATCH;
|
||||
}
|
||||
var index = match.index;
|
||||
var input = match.input;
|
||||
var leftBoundaryMatch = 2;
|
||||
var periferalMatch = 0;
|
||||
// make sure match is anchored on a left word boundary
|
||||
if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index]) {
|
||||
leftBoundaryMatch = 0;
|
||||
} else if ("_" === input[index - 1] || (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input))) {
|
||||
leftBoundaryMatch = 1;
|
||||
}
|
||||
var matchEnd = index + match[0].length;
|
||||
var leftParen = input.indexOf("(");
|
||||
var endOfName = leftParen > -1 ? leftParen : input.length;
|
||||
// exclude peripheral matches
|
||||
if (category !== catModules && category !== catSearchTags) {
|
||||
var delim = category === catPackages ? "/" : ".";
|
||||
if (leftParen > -1 && leftParen < index) {
|
||||
periferalMatch += 2;
|
||||
} else if (input.lastIndexOf(delim, endOfName) >= matchEnd) {
|
||||
periferalMatch += 2;
|
||||
}
|
||||
}
|
||||
var delta = match[0].length === endOfName ? 0 : 1; // rank full match higher than partial match
|
||||
for (var i = 1; i < match.length; i++) {
|
||||
// lower ranking if parts of the name are missing
|
||||
if (match[i])
|
||||
delta += match[i].length;
|
||||
}
|
||||
if (category === catTypes) {
|
||||
// lower ranking if a type name contains unmatched camel-case parts
|
||||
if (/[A-Z]/.test(input.substring(matchEnd)))
|
||||
delta += 5;
|
||||
if (/[A-Z]/.test(input.substring(0, index)))
|
||||
delta += 5;
|
||||
}
|
||||
return leftBoundaryMatch + periferalMatch + (delta / 200);
|
||||
|
||||
}
|
||||
function doSearch(request, response) {
|
||||
var result = [];
|
||||
searchPattern = createSearchPattern(request.term);
|
||||
fallbackPattern = createSearchPattern(request.term.toLowerCase());
|
||||
if (searchPattern === "") {
|
||||
return this.close();
|
||||
}
|
||||
var camelCaseMatcher = createMatcher(searchPattern, "");
|
||||
var fallbackMatcher = new RegExp(fallbackPattern, "i");
|
||||
|
||||
function searchIndexWithMatcher(indexArray, matcher, category, nameFunc) {
|
||||
if (indexArray) {
|
||||
var newResults = [];
|
||||
$.each(indexArray, function (i, item) {
|
||||
item.category = category;
|
||||
var ranking = rankMatch(matcher.exec(nameFunc(item)), category);
|
||||
if (ranking < RANKING_THRESHOLD) {
|
||||
newResults.push({ranking: ranking, item: item});
|
||||
}
|
||||
return newResults.length <= MAX_RESULTS;
|
||||
});
|
||||
return newResults.sort(function(e1, e2) {
|
||||
return e1.ranking - e2.ranking;
|
||||
}).map(function(e) {
|
||||
return e.item;
|
||||
});
|
||||
}
|
||||
return [];
|
||||
}
|
||||
function searchIndex(indexArray, category, nameFunc) {
|
||||
var primaryResults = searchIndexWithMatcher(indexArray, camelCaseMatcher, category, nameFunc);
|
||||
result = result.concat(primaryResults);
|
||||
if (primaryResults.length <= MIN_RESULTS && !camelCaseMatcher.ignoreCase) {
|
||||
var secondaryResults = searchIndexWithMatcher(indexArray, fallbackMatcher, category, nameFunc);
|
||||
result = result.concat(secondaryResults.filter(function (item) {
|
||||
return primaryResults.indexOf(item) === -1;
|
||||
}));
|
||||
}
|
||||
}
|
||||
|
||||
searchIndex(moduleSearchIndex, catModules, function(item) { return item.l; });
|
||||
searchIndex(packageSearchIndex, catPackages, function(item) {
|
||||
return (item.m && request.term.indexOf("/") > -1)
|
||||
? (item.m + "/" + item.l) : item.l;
|
||||
});
|
||||
searchIndex(typeSearchIndex, catTypes, function(item) {
|
||||
return request.term.indexOf(".") > -1 ? item.p + "." + item.l : item.l;
|
||||
});
|
||||
searchIndex(memberSearchIndex, catMembers, function(item) {
|
||||
return request.term.indexOf(".") > -1
|
||||
? item.p + "." + item.c + "." + item.l : item.l;
|
||||
});
|
||||
searchIndex(tagSearchIndex, catSearchTags, function(item) { return item.l; });
|
||||
|
||||
if (!indexFilesLoaded()) {
|
||||
updateSearchResults = function() {
|
||||
doSearch(request, response);
|
||||
}
|
||||
result.unshift(loading);
|
||||
} else {
|
||||
updateSearchResults = function() {};
|
||||
}
|
||||
response(result);
|
||||
}
|
||||
$(function() {
|
||||
$("#search-input").catcomplete({
|
||||
minLength: 1,
|
||||
delay: 300,
|
||||
source: doSearch,
|
||||
response: function(event, ui) {
|
||||
if (!ui.content.length) {
|
||||
ui.content.push(noResult);
|
||||
} else {
|
||||
$("#search-input").empty();
|
||||
}
|
||||
},
|
||||
autoFocus: true,
|
||||
focus: function(event, ui) {
|
||||
return false;
|
||||
},
|
||||
position: {
|
||||
collision: "flip"
|
||||
},
|
||||
select: function(event, ui) {
|
||||
if (ui.item.category) {
|
||||
var url = getURLPrefix(ui);
|
||||
if (ui.item.category === catModules) {
|
||||
url += "module-summary.html";
|
||||
} else if (ui.item.category === catPackages) {
|
||||
if (ui.item.u) {
|
||||
url = ui.item.u;
|
||||
} else {
|
||||
url += ui.item.l.replace(/\./g, '/') + "/package-summary.html";
|
||||
}
|
||||
} else if (ui.item.category === catTypes) {
|
||||
if (ui.item.u) {
|
||||
url = ui.item.u;
|
||||
} else if (ui.item.p === UNNAMED) {
|
||||
url += ui.item.l + ".html";
|
||||
} else {
|
||||
url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html";
|
||||
}
|
||||
} else if (ui.item.category === catMembers) {
|
||||
if (ui.item.p === UNNAMED) {
|
||||
url += ui.item.c + ".html" + "#";
|
||||
} else {
|
||||
url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#";
|
||||
}
|
||||
if (ui.item.u) {
|
||||
url += ui.item.u;
|
||||
} else {
|
||||
url += ui.item.l;
|
||||
}
|
||||
} else if (ui.item.category === catSearchTags) {
|
||||
url += ui.item.u;
|
||||
}
|
||||
if (top !== window) {
|
||||
parent.classFrame.location = pathtoroot + url;
|
||||
} else {
|
||||
window.location.href = pathtoroot + url;
|
||||
}
|
||||
$("#search-input").focus();
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
78
build/docs/javadoc/serialized-form.html
Normal file
78
build/docs/javadoc/serialized-form.html
Normal file
@ -0,0 +1,78 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Serialized Form (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="serialized forms">
|
||||
<meta name="generator" content="javadoc/SerializedFormWriterImpl">
|
||||
<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="serialized-form-page">
|
||||
<script type="text/javascript">var pathtoroot = "./";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="deprecated-list.html">Deprecated</a></li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="help-doc.html#serialized-form">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 title="Serialized Form" class="title">Serialized Form</h1>
|
||||
</div>
|
||||
<ul class="block-list">
|
||||
<li>
|
||||
<section class="serialized-package-container">
|
||||
<h2 title="Package">Package <a href="io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></h2>
|
||||
<ul class="block-list">
|
||||
<li>
|
||||
<section class="serialized-class-details" id="io.github.simplexdevelopment.api.ServiceException">
|
||||
<h3>Exception <a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">io.github.simplexdevelopment.api.ServiceException</a></h3>
|
||||
<div class="type-signature">class ServiceException extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a> implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="serialized-class-details" id="io.github.simplexdevelopment.api.ServicePoolException">
|
||||
<h3>Exception <a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">io.github.simplexdevelopment.api.ServicePoolException</a></h3>
|
||||
<div class="type-signature">class ServicePoolException extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a> implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
865
build/docs/javadoc/stylesheet.css
Normal file
865
build/docs/javadoc/stylesheet.css
Normal file
@ -0,0 +1,865 @@
|
||||
/*
|
||||
* Javadoc style sheet
|
||||
*/
|
||||
|
||||
@import url('resources/fonts/dejavu.css');
|
||||
|
||||
/*
|
||||
* Styles for individual HTML elements.
|
||||
*
|
||||
* These are styles that are specific to individual HTML elements. Changing them affects the style of a particular
|
||||
* HTML element throughout the page.
|
||||
*/
|
||||
|
||||
body {
|
||||
background-color:#ffffff;
|
||||
color:#353833;
|
||||
font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
|
||||
font-size:14px;
|
||||
margin:0;
|
||||
padding:0;
|
||||
height:100%;
|
||||
width:100%;
|
||||
}
|
||||
iframe {
|
||||
margin:0;
|
||||
padding:0;
|
||||
height:100%;
|
||||
width:100%;
|
||||
overflow-y:scroll;
|
||||
border:none;
|
||||
}
|
||||
a:link, a:visited {
|
||||
text-decoration:none;
|
||||
color:#4A6782;
|
||||
}
|
||||
a[href]:hover, a[href]:focus {
|
||||
text-decoration:none;
|
||||
color:#bb7a2a;
|
||||
}
|
||||
a[name] {
|
||||
color:#353833;
|
||||
}
|
||||
pre {
|
||||
font-family:'DejaVu Sans Mono', monospace;
|
||||
font-size:14px;
|
||||
}
|
||||
h1 {
|
||||
font-size:20px;
|
||||
}
|
||||
h2 {
|
||||
font-size:18px;
|
||||
}
|
||||
h3 {
|
||||
font-size:16px;
|
||||
}
|
||||
h4 {
|
||||
font-size:15px;
|
||||
}
|
||||
h5 {
|
||||
font-size:14px;
|
||||
}
|
||||
h6 {
|
||||
font-size:13px;
|
||||
}
|
||||
ul {
|
||||
list-style-type:disc;
|
||||
}
|
||||
code, tt {
|
||||
font-family:'DejaVu Sans Mono', monospace;
|
||||
}
|
||||
:not(h1, h2, h3, h4, h5, h6) > code,
|
||||
:not(h1, h2, h3, h4, h5, h6) > tt {
|
||||
font-size:14px;
|
||||
padding-top:4px;
|
||||
margin-top:8px;
|
||||
line-height:1.4em;
|
||||
}
|
||||
dt code {
|
||||
font-family:'DejaVu Sans Mono', monospace;
|
||||
font-size:14px;
|
||||
padding-top:4px;
|
||||
}
|
||||
.summary-table dt code {
|
||||
font-family:'DejaVu Sans Mono', monospace;
|
||||
font-size:14px;
|
||||
vertical-align:top;
|
||||
padding-top:4px;
|
||||
}
|
||||
sup {
|
||||
font-size:8px;
|
||||
}
|
||||
button {
|
||||
font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
|
||||
font-size: 14px;
|
||||
}
|
||||
/*
|
||||
* Styles for HTML generated by javadoc.
|
||||
*
|
||||
* These are style classes that are used by the standard doclet to generate HTML documentation.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Styles for document title and copyright.
|
||||
*/
|
||||
.clear {
|
||||
clear:both;
|
||||
height:0;
|
||||
overflow:hidden;
|
||||
}
|
||||
.about-language {
|
||||
float:right;
|
||||
padding:0 21px 8px 8px;
|
||||
font-size:11px;
|
||||
margin-top:-9px;
|
||||
height:2.9em;
|
||||
}
|
||||
.legal-copy {
|
||||
margin-left:.5em;
|
||||
}
|
||||
.tab {
|
||||
background-color:#0066FF;
|
||||
color:#ffffff;
|
||||
padding:8px;
|
||||
width:5em;
|
||||
font-weight:bold;
|
||||
}
|
||||
/*
|
||||
* Styles for navigation bar.
|
||||
*/
|
||||
@media screen {
|
||||
.flex-box {
|
||||
position:fixed;
|
||||
display:flex;
|
||||
flex-direction:column;
|
||||
height: 100%;
|
||||
width: 100%;
|
||||
}
|
||||
.flex-header {
|
||||
flex: 0 0 auto;
|
||||
}
|
||||
.flex-content {
|
||||
flex: 1 1 auto;
|
||||
overflow-y: auto;
|
||||
}
|
||||
}
|
||||
.top-nav {
|
||||
background-color:#4D7A97;
|
||||
color:#FFFFFF;
|
||||
float:left;
|
||||
padding:0;
|
||||
width:100%;
|
||||
clear:right;
|
||||
min-height:2.8em;
|
||||
padding-top:10px;
|
||||
overflow:hidden;
|
||||
font-size:12px;
|
||||
}
|
||||
.sub-nav {
|
||||
background-color:#dee3e9;
|
||||
float:left;
|
||||
width:100%;
|
||||
overflow:hidden;
|
||||
font-size:12px;
|
||||
}
|
||||
.sub-nav div {
|
||||
clear:left;
|
||||
float:left;
|
||||
padding:0 0 5px 6px;
|
||||
text-transform:uppercase;
|
||||
}
|
||||
.sub-nav .nav-list {
|
||||
padding-top:5px;
|
||||
}
|
||||
ul.nav-list {
|
||||
display:block;
|
||||
margin:0 25px 0 0;
|
||||
padding:0;
|
||||
}
|
||||
ul.sub-nav-list {
|
||||
float:left;
|
||||
margin:0 25px 0 0;
|
||||
padding:0;
|
||||
}
|
||||
ul.nav-list li {
|
||||
list-style:none;
|
||||
float:left;
|
||||
padding: 5px 6px;
|
||||
text-transform:uppercase;
|
||||
}
|
||||
.sub-nav .nav-list-search {
|
||||
float:right;
|
||||
margin:0 0 0 0;
|
||||
padding:5px 6px;
|
||||
clear:none;
|
||||
}
|
||||
.nav-list-search label {
|
||||
position:relative;
|
||||
right:-16px;
|
||||
}
|
||||
ul.sub-nav-list li {
|
||||
list-style:none;
|
||||
float:left;
|
||||
padding-top:10px;
|
||||
}
|
||||
.top-nav a:link, .top-nav a:active, .top-nav a:visited {
|
||||
color:#FFFFFF;
|
||||
text-decoration:none;
|
||||
text-transform:uppercase;
|
||||
}
|
||||
.top-nav a:hover {
|
||||
text-decoration:none;
|
||||
color:#bb7a2a;
|
||||
text-transform:uppercase;
|
||||
}
|
||||
.nav-bar-cell1-rev {
|
||||
background-color:#F8981D;
|
||||
color:#253441;
|
||||
margin: auto 5px;
|
||||
}
|
||||
.skip-nav {
|
||||
position:absolute;
|
||||
top:auto;
|
||||
left:-9999px;
|
||||
overflow:hidden;
|
||||
}
|
||||
/*
|
||||
* Hide navigation links and search box in print layout
|
||||
*/
|
||||
@media print {
|
||||
ul.nav-list, div.sub-nav {
|
||||
display:none;
|
||||
}
|
||||
}
|
||||
/*
|
||||
* Styles for page header and footer.
|
||||
*/
|
||||
.title {
|
||||
color:#2c4557;
|
||||
margin:10px 0;
|
||||
}
|
||||
.sub-title {
|
||||
margin:5px 0 0 0;
|
||||
}
|
||||
.header ul {
|
||||
margin:0 0 15px 0;
|
||||
padding:0;
|
||||
}
|
||||
.header ul li, .footer ul li {
|
||||
list-style:none;
|
||||
font-size:13px;
|
||||
}
|
||||
/*
|
||||
* Styles for headings.
|
||||
*/
|
||||
body.class-declaration-page .summary h2,
|
||||
body.class-declaration-page .details h2,
|
||||
body.class-use-page h2,
|
||||
body.module-declaration-page .block-list h2 {
|
||||
font-style: italic;
|
||||
padding:0;
|
||||
margin:15px 0;
|
||||
}
|
||||
body.class-declaration-page .summary h3,
|
||||
body.class-declaration-page .details h3,
|
||||
body.class-declaration-page .summary .inherited-list h2 {
|
||||
background-color:#dee3e9;
|
||||
border:1px solid #d0d9e0;
|
||||
margin:0 0 6px -8px;
|
||||
padding:7px 5px;
|
||||
}
|
||||
/*
|
||||
* Styles for page layout containers.
|
||||
*/
|
||||
main {
|
||||
clear:both;
|
||||
padding:10px 20px;
|
||||
position:relative;
|
||||
}
|
||||
dl.notes > dt {
|
||||
font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
|
||||
font-size:12px;
|
||||
font-weight:bold;
|
||||
margin:10px 0 0 0;
|
||||
color:#4E4E4E;
|
||||
}
|
||||
dl.notes > dd {
|
||||
margin:5px 10px 10px 0;
|
||||
font-size:14px;
|
||||
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
|
||||
}
|
||||
dl.name-value > dt {
|
||||
margin-left:1px;
|
||||
font-size:1.1em;
|
||||
display:inline;
|
||||
font-weight:bold;
|
||||
}
|
||||
dl.name-value > dd {
|
||||
margin:0 0 0 1px;
|
||||
font-size:1.1em;
|
||||
display:inline;
|
||||
}
|
||||
/*
|
||||
* Styles for lists.
|
||||
*/
|
||||
li.circle {
|
||||
list-style:circle;
|
||||
}
|
||||
ul.horizontal li {
|
||||
display:inline;
|
||||
font-size:0.9em;
|
||||
}
|
||||
div.inheritance {
|
||||
margin:0;
|
||||
padding:0;
|
||||
}
|
||||
div.inheritance div.inheritance {
|
||||
margin-left:2em;
|
||||
}
|
||||
ul.block-list,
|
||||
ul.details-list,
|
||||
ul.member-list,
|
||||
ul.summary-list {
|
||||
margin:10px 0 10px 0;
|
||||
padding:0;
|
||||
}
|
||||
ul.block-list > li,
|
||||
ul.details-list > li,
|
||||
ul.member-list > li,
|
||||
ul.summary-list > li {
|
||||
list-style:none;
|
||||
margin-bottom:15px;
|
||||
line-height:1.4;
|
||||
}
|
||||
.summary-table dl, .summary-table dl dt, .summary-table dl dd {
|
||||
margin-top:0;
|
||||
margin-bottom:1px;
|
||||
}
|
||||
ul.see-list, ul.see-list-long {
|
||||
padding-left: 0;
|
||||
list-style: none;
|
||||
}
|
||||
ul.see-list li {
|
||||
display: inline;
|
||||
}
|
||||
ul.see-list li:not(:last-child):after,
|
||||
ul.see-list-long li:not(:last-child):after {
|
||||
content: ", ";
|
||||
white-space: pre-wrap;
|
||||
}
|
||||
/*
|
||||
* Styles for tables.
|
||||
*/
|
||||
.summary-table, .details-table {
|
||||
width:100%;
|
||||
border-spacing:0;
|
||||
border-left:1px solid #EEE;
|
||||
border-right:1px solid #EEE;
|
||||
border-bottom:1px solid #EEE;
|
||||
padding:0;
|
||||
}
|
||||
.caption {
|
||||
position:relative;
|
||||
text-align:left;
|
||||
background-repeat:no-repeat;
|
||||
color:#253441;
|
||||
font-weight:bold;
|
||||
clear:none;
|
||||
overflow:hidden;
|
||||
padding:0;
|
||||
padding-top:10px;
|
||||
padding-left:1px;
|
||||
margin:0;
|
||||
white-space:pre;
|
||||
}
|
||||
.caption a:link, .caption a:visited {
|
||||
color:#1f389c;
|
||||
}
|
||||
.caption a:hover,
|
||||
.caption a:active {
|
||||
color:#FFFFFF;
|
||||
}
|
||||
.caption span {
|
||||
white-space:nowrap;
|
||||
padding-top:5px;
|
||||
padding-left:12px;
|
||||
padding-right:12px;
|
||||
padding-bottom:7px;
|
||||
display:inline-block;
|
||||
float:left;
|
||||
background-color:#F8981D;
|
||||
border: none;
|
||||
height:16px;
|
||||
}
|
||||
div.table-tabs {
|
||||
padding:10px 0 0 1px;
|
||||
margin:0;
|
||||
}
|
||||
div.table-tabs > button {
|
||||
border: none;
|
||||
cursor: pointer;
|
||||
padding: 5px 12px 7px 12px;
|
||||
font-weight: bold;
|
||||
margin-right: 3px;
|
||||
}
|
||||
div.table-tabs > button.active-table-tab {
|
||||
background: #F8981D;
|
||||
color: #253441;
|
||||
}
|
||||
div.table-tabs > button.table-tab {
|
||||
background: #4D7A97;
|
||||
color: #FFFFFF;
|
||||
}
|
||||
.two-column-summary {
|
||||
display: grid;
|
||||
grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
|
||||
}
|
||||
.three-column-summary {
|
||||
display: grid;
|
||||
grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto);
|
||||
}
|
||||
.four-column-summary {
|
||||
display: grid;
|
||||
grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto);
|
||||
}
|
||||
@media screen and (max-width: 600px) {
|
||||
.two-column-summary {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr;
|
||||
}
|
||||
}
|
||||
@media screen and (max-width: 800px) {
|
||||
.three-column-summary {
|
||||
display: grid;
|
||||
grid-template-columns: minmax(10%, max-content) minmax(25%, auto);
|
||||
}
|
||||
.three-column-summary .col-last {
|
||||
grid-column-end: span 2;
|
||||
}
|
||||
}
|
||||
@media screen and (max-width: 1000px) {
|
||||
.four-column-summary {
|
||||
display: grid;
|
||||
grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
|
||||
}
|
||||
}
|
||||
.summary-table > div, .details-table > div {
|
||||
text-align:left;
|
||||
padding: 8px 3px 3px 7px;
|
||||
}
|
||||
.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name {
|
||||
vertical-align:top;
|
||||
padding-right:0;
|
||||
padding-top:8px;
|
||||
padding-bottom:3px;
|
||||
}
|
||||
.table-header {
|
||||
background:#dee3e9;
|
||||
font-weight: bold;
|
||||
}
|
||||
.col-first, .col-first {
|
||||
font-size:13px;
|
||||
}
|
||||
.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last {
|
||||
font-size:13px;
|
||||
}
|
||||
.col-first, .col-second, .col-constructor-name {
|
||||
vertical-align:top;
|
||||
overflow: auto;
|
||||
}
|
||||
.col-last {
|
||||
white-space:normal;
|
||||
}
|
||||
.col-first a:link, .col-first a:visited,
|
||||
.col-second a:link, .col-second a:visited,
|
||||
.col-first a:link, .col-first a:visited,
|
||||
.col-second a:link, .col-second a:visited,
|
||||
.col-constructor-name a:link, .col-constructor-name a:visited,
|
||||
.col-summary-item-name a:link, .col-summary-item-name a:visited,
|
||||
.constant-values-container a:link, .constant-values-container a:visited,
|
||||
.all-classes-container a:link, .all-classes-container a:visited,
|
||||
.all-packages-container a:link, .all-packages-container a:visited {
|
||||
font-weight:bold;
|
||||
}
|
||||
.table-sub-heading-color {
|
||||
background-color:#EEEEFF;
|
||||
}
|
||||
.even-row-color, .even-row-color .table-header {
|
||||
background-color:#FFFFFF;
|
||||
}
|
||||
.odd-row-color, .odd-row-color .table-header {
|
||||
background-color:#EEEEEF;
|
||||
}
|
||||
/*
|
||||
* Styles for contents.
|
||||
*/
|
||||
.deprecated-content {
|
||||
margin:0;
|
||||
padding:10px 0;
|
||||
}
|
||||
div.block {
|
||||
font-size:14px;
|
||||
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
|
||||
}
|
||||
.col-last div {
|
||||
padding-top:0;
|
||||
}
|
||||
.col-last a {
|
||||
padding-bottom:3px;
|
||||
}
|
||||
.module-signature,
|
||||
.package-signature,
|
||||
.type-signature,
|
||||
.member-signature {
|
||||
font-family:'DejaVu Sans Mono', monospace;
|
||||
font-size:14px;
|
||||
margin:14px 0;
|
||||
white-space: pre-wrap;
|
||||
}
|
||||
.module-signature,
|
||||
.package-signature,
|
||||
.type-signature {
|
||||
margin-top: 0;
|
||||
}
|
||||
.member-signature .type-parameters-long,
|
||||
.member-signature .parameters,
|
||||
.member-signature .exceptions {
|
||||
display: inline-block;
|
||||
vertical-align: top;
|
||||
white-space: pre;
|
||||
}
|
||||
.member-signature .type-parameters {
|
||||
white-space: normal;
|
||||
}
|
||||
/*
|
||||
* Styles for formatting effect.
|
||||
*/
|
||||
.source-line-no {
|
||||
color:green;
|
||||
padding:0 30px 0 0;
|
||||
}
|
||||
h1.hidden {
|
||||
visibility:hidden;
|
||||
overflow:hidden;
|
||||
font-size:10px;
|
||||
}
|
||||
.block {
|
||||
display:block;
|
||||
margin:0 10px 5px 0;
|
||||
color:#474747;
|
||||
}
|
||||
.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link,
|
||||
.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type,
|
||||
.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label {
|
||||
font-weight:bold;
|
||||
}
|
||||
.deprecation-comment, .help-footnote, .preview-comment {
|
||||
font-style:italic;
|
||||
}
|
||||
.deprecation-block {
|
||||
font-size:14px;
|
||||
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
|
||||
border-style:solid;
|
||||
border-width:thin;
|
||||
border-radius:10px;
|
||||
padding:10px;
|
||||
margin-bottom:10px;
|
||||
margin-right:10px;
|
||||
display:inline-block;
|
||||
}
|
||||
.preview-block {
|
||||
font-size:14px;
|
||||
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
|
||||
border-style:solid;
|
||||
border-width:thin;
|
||||
border-radius:10px;
|
||||
padding:10px;
|
||||
margin-bottom:10px;
|
||||
margin-right:10px;
|
||||
display:inline-block;
|
||||
}
|
||||
div.block div.deprecation-comment {
|
||||
font-style:normal;
|
||||
}
|
||||
/*
|
||||
* Styles specific to HTML5 elements.
|
||||
*/
|
||||
main, nav, header, footer, section {
|
||||
display:block;
|
||||
}
|
||||
/*
|
||||
* Styles for javadoc search.
|
||||
*/
|
||||
.ui-autocomplete-category {
|
||||
font-weight:bold;
|
||||
font-size:15px;
|
||||
padding:7px 0 7px 3px;
|
||||
background-color:#4D7A97;
|
||||
color:#FFFFFF;
|
||||
}
|
||||
.result-item {
|
||||
font-size:13px;
|
||||
}
|
||||
.ui-autocomplete {
|
||||
max-height:85%;
|
||||
max-width:65%;
|
||||
overflow-y:scroll;
|
||||
overflow-x:scroll;
|
||||
white-space:nowrap;
|
||||
box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
|
||||
}
|
||||
ul.ui-autocomplete {
|
||||
position:fixed;
|
||||
z-index:999999;
|
||||
}
|
||||
ul.ui-autocomplete li {
|
||||
float:left;
|
||||
clear:both;
|
||||
width:100%;
|
||||
}
|
||||
.result-highlight {
|
||||
font-weight:bold;
|
||||
}
|
||||
#search-input {
|
||||
background-image:url('resources/glass.png');
|
||||
background-size:13px;
|
||||
background-repeat:no-repeat;
|
||||
background-position:2px 3px;
|
||||
padding-left:20px;
|
||||
position:relative;
|
||||
right:-18px;
|
||||
width:400px;
|
||||
}
|
||||
#reset-button {
|
||||
background-color: rgb(255,255,255);
|
||||
background-image:url('resources/x.png');
|
||||
background-position:center;
|
||||
background-repeat:no-repeat;
|
||||
background-size:12px;
|
||||
border:0 none;
|
||||
width:16px;
|
||||
height:16px;
|
||||
position:relative;
|
||||
left:-4px;
|
||||
top:-4px;
|
||||
font-size:0px;
|
||||
}
|
||||
.watermark {
|
||||
color:#545454;
|
||||
}
|
||||
.search-tag-desc-result {
|
||||
font-style:italic;
|
||||
font-size:11px;
|
||||
}
|
||||
.search-tag-holder-result {
|
||||
font-style:italic;
|
||||
font-size:12px;
|
||||
}
|
||||
.search-tag-result:target {
|
||||
background-color:yellow;
|
||||
}
|
||||
.module-graph span {
|
||||
display:none;
|
||||
position:absolute;
|
||||
}
|
||||
.module-graph:hover span {
|
||||
display:block;
|
||||
margin: -100px 0 0 100px;
|
||||
z-index: 1;
|
||||
}
|
||||
.inherited-list {
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
section.class-description {
|
||||
line-height: 1.4;
|
||||
}
|
||||
.summary section[class$="-summary"], .details section[class$="-details"],
|
||||
.class-uses .detail, .serialized-class-details {
|
||||
padding: 0px 20px 5px 10px;
|
||||
border: 1px solid #ededed;
|
||||
background-color: #f8f8f8;
|
||||
}
|
||||
.inherited-list, section[class$="-details"] .detail {
|
||||
padding:0 0 5px 8px;
|
||||
background-color:#ffffff;
|
||||
border:none;
|
||||
}
|
||||
.vertical-separator {
|
||||
padding: 0 5px;
|
||||
}
|
||||
ul.help-section-list {
|
||||
margin: 0;
|
||||
}
|
||||
ul.help-subtoc > li {
|
||||
display: inline-block;
|
||||
padding-right: 5px;
|
||||
font-size: smaller;
|
||||
}
|
||||
ul.help-subtoc > li::before {
|
||||
content: "\2022" ;
|
||||
padding-right:2px;
|
||||
}
|
||||
span.help-note {
|
||||
font-style: italic;
|
||||
}
|
||||
/*
|
||||
* Indicator icon for external links.
|
||||
*/
|
||||
main a[href*="://"]::after {
|
||||
content:"";
|
||||
display:inline-block;
|
||||
background-image:url('data:image/svg+xml; utf8, \
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="768" height="768">\
|
||||
<path d="M584 664H104V184h216V80H0v688h688V448H584zM384 0l132 \
|
||||
132-240 240 120 120 240-240 132 132V0z" fill="%234a6782"/>\
|
||||
</svg>');
|
||||
background-size:100% 100%;
|
||||
width:7px;
|
||||
height:7px;
|
||||
margin-left:2px;
|
||||
margin-bottom:4px;
|
||||
}
|
||||
main a[href*="://"]:hover::after,
|
||||
main a[href*="://"]:focus::after {
|
||||
background-image:url('data:image/svg+xml; utf8, \
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="768" height="768">\
|
||||
<path d="M584 664H104V184h216V80H0v688h688V448H584zM384 0l132 \
|
||||
132-240 240 120 120 240-240 132 132V0z" fill="%23bb7a2a"/>\
|
||||
</svg>');
|
||||
}
|
||||
|
||||
/*
|
||||
* Styles for user-provided tables.
|
||||
*
|
||||
* borderless:
|
||||
* No borders, vertical margins, styled caption.
|
||||
* This style is provided for use with existing doc comments.
|
||||
* In general, borderless tables should not be used for layout purposes.
|
||||
*
|
||||
* plain:
|
||||
* Plain borders around table and cells, vertical margins, styled caption.
|
||||
* Best for small tables or for complex tables for tables with cells that span
|
||||
* rows and columns, when the "striped" style does not work well.
|
||||
*
|
||||
* striped:
|
||||
* Borders around the table and vertical borders between cells, striped rows,
|
||||
* vertical margins, styled caption.
|
||||
* Best for tables that have a header row, and a body containing a series of simple rows.
|
||||
*/
|
||||
|
||||
table.borderless,
|
||||
table.plain,
|
||||
table.striped {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
table.borderless > caption,
|
||||
table.plain > caption,
|
||||
table.striped > caption {
|
||||
font-weight: bold;
|
||||
font-size: smaller;
|
||||
}
|
||||
table.borderless th, table.borderless td,
|
||||
table.plain th, table.plain td,
|
||||
table.striped th, table.striped td {
|
||||
padding: 2px 5px;
|
||||
}
|
||||
table.borderless,
|
||||
table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th,
|
||||
table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td {
|
||||
border: none;
|
||||
}
|
||||
table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr {
|
||||
background-color: transparent;
|
||||
}
|
||||
table.plain {
|
||||
border-collapse: collapse;
|
||||
border: 1px solid black;
|
||||
}
|
||||
table.plain > thead > tr, table.plain > tbody tr, table.plain > tr {
|
||||
background-color: transparent;
|
||||
}
|
||||
table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th,
|
||||
table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td {
|
||||
border: 1px solid black;
|
||||
}
|
||||
table.striped {
|
||||
border-collapse: collapse;
|
||||
border: 1px solid black;
|
||||
}
|
||||
table.striped > thead {
|
||||
background-color: #E3E3E3;
|
||||
}
|
||||
table.striped > thead > tr > th, table.striped > thead > tr > td {
|
||||
border: 1px solid black;
|
||||
}
|
||||
table.striped > tbody > tr:nth-child(even) {
|
||||
background-color: #EEE
|
||||
}
|
||||
table.striped > tbody > tr:nth-child(odd) {
|
||||
background-color: #FFF
|
||||
}
|
||||
table.striped > tbody > tr > th, table.striped > tbody > tr > td {
|
||||
border-left: 1px solid black;
|
||||
border-right: 1px solid black;
|
||||
}
|
||||
table.striped > tbody > tr > th {
|
||||
font-weight: normal;
|
||||
}
|
||||
/**
|
||||
* Tweak font sizes and paddings for small screens.
|
||||
*/
|
||||
@media screen and (max-width: 1050px) {
|
||||
#search-input {
|
||||
width: 300px;
|
||||
}
|
||||
}
|
||||
@media screen and (max-width: 800px) {
|
||||
#search-input {
|
||||
width: 200px;
|
||||
}
|
||||
.top-nav,
|
||||
.bottom-nav {
|
||||
font-size: 11px;
|
||||
padding-top: 6px;
|
||||
}
|
||||
.sub-nav {
|
||||
font-size: 11px;
|
||||
}
|
||||
.about-language {
|
||||
padding-right: 16px;
|
||||
}
|
||||
ul.nav-list li,
|
||||
.sub-nav .nav-list-search {
|
||||
padding: 6px;
|
||||
}
|
||||
ul.sub-nav-list li {
|
||||
padding-top: 5px;
|
||||
}
|
||||
main {
|
||||
padding: 10px;
|
||||
}
|
||||
.summary section[class$="-summary"], .details section[class$="-details"],
|
||||
.class-uses .detail, .serialized-class-details {
|
||||
padding: 0 8px 5px 8px;
|
||||
}
|
||||
body {
|
||||
-webkit-text-size-adjust: none;
|
||||
}
|
||||
}
|
||||
@media screen and (max-width: 500px) {
|
||||
#search-input {
|
||||
width: 150px;
|
||||
}
|
||||
.top-nav,
|
||||
.bottom-nav {
|
||||
font-size: 10px;
|
||||
}
|
||||
.sub-nav {
|
||||
font-size: 10px;
|
||||
}
|
||||
.about-language {
|
||||
font-size: 10px;
|
||||
padding-right: 12px;
|
||||
}
|
||||
}
|
||||
1
build/docs/javadoc/tag-search-index.js
Normal file
1
build/docs/javadoc/tag-search-index.js
Normal file
@ -0,0 +1 @@
|
||||
tagSearchIndex = [{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults();
|
||||
1
build/docs/javadoc/type-search-index.js
Normal file
1
build/docs/javadoc/type-search-index.js
Normal file
@ -0,0 +1 @@
|
||||
typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"io.github.simplexdevelopment.scheduler","l":"BukkitDisposable"},{"p":"io.github.simplexdevelopment.api","l":"Context"},{"p":"io.github.simplexdevelopment.scheduler","l":"ExecutableService"},{"p":"io.github.simplexdevelopment.api","l":"Identifier"},{"p":"io.github.simplexdevelopment.api","l":"ISchedule"},{"p":"io.github.simplexdevelopment.api","l":"IService"},{"p":"io.github.simplexdevelopment.impl","l":"Main"},{"p":"io.github.simplexdevelopment.scheduler","l":"ReactorBukkitScheduler"},{"p":"io.github.simplexdevelopment.scheduler","l":"SchedulingSystem"},{"p":"io.github.simplexdevelopment.api","l":"ServiceException"},{"p":"io.github.simplexdevelopment.impl","l":"ServiceImpl"},{"p":"io.github.simplexdevelopment.scheduler","l":"ServiceManager"},{"p":"io.github.simplexdevelopment.scheduler","l":"ServicePool"},{"p":"io.github.simplexdevelopment.api","l":"ServicePoolException"}];updateSearchResults();
|
||||
7
build/resources/main/plugin.yml
Normal file
7
build/resources/main/plugin.yml
Normal file
@ -0,0 +1,7 @@
|
||||
name: SimplexSS
|
||||
version: '1.0.1'
|
||||
main: io.github.simplex.simplexss.SimplexSS
|
||||
api-version: 1.19
|
||||
authors: [ SimplexDevelopment ]
|
||||
description: A Scheduler Service API written with Reactor designed to create fully reactive non-blocking tasks.
|
||||
website: https://github.com/SimplexDevelopment
|
||||
BIN
build/tmp/compileJava/previous-compilation-data.bin
Normal file
BIN
build/tmp/compileJava/previous-compilation-data.bin
Normal file
Binary file not shown.
20
build/tmp/javadoc/javadoc.options
Normal file
20
build/tmp/javadoc/javadoc.options
Normal file
@ -0,0 +1,20 @@
|
||||
-classpath 'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\build\\classes\\java\\main;C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\build\\resources\\main;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\io.papermc.paper\\paper-api\\1.19-R0.1-SNAPSHOT\\16c0c5a4a38ed1d4c2e543b7b794c5f2eec086b9\\paper-api-1.19-R0.1-SNAPSHOT.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\io.projectreactor\\reactor-core\\3.4.24\\43fc394f483d4c4397f399013b3ed602b9d067d1\\reactor-core-3.4.24.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.md-5\\bungeecord-chat\\1.16-R0.4-deprecated+build.6\\34a32cc95e1c5f12176cf0a8aeeff087ff8a17e0\\bungeecord-chat-1.16-R0.4-deprecated+build.6.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\com.google.guava\\guava\\31.0.1-jre\\119ea2b2bc205b138974d351777b20f02b92704b\\guava-31.0.1-jre.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\adventure-text-logger-slf4j\\4.11.0\\22414f4f37e334ce4b8ca042108922554794b1d1\\adventure-text-logger-slf4j-4.11.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\adventure-text-minimessage\\4.11.0\\bae2b3df851f0997f8fd3f56aa1a9987d7b54792\\adventure-text-minimessage-4.11.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\adventure-text-serializer-legacy\\4.11.0\\de25209fbd6a08d47342f97b99c0c52cc4acc247\\adventure-text-serializer-legacy-4.11.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\adventure-text-serializer-plain\\4.11.0\\a15eb311b588ce2b19b410b53df696fe058a5076\\adventure-text-serializer-plain-4.11.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\adventure-api\\4.11.0\\925ce8f663bab063d522de8a895ac152a023dab8\\adventure-api-4.11.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\adventure-key\\4.11.0\\6ac82c19a7c677f0918369cc3610e89f1a2f7d66\\adventure-key-4.11.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\adventure-text-serializer-gson\\4.11.0\\aa74697a6d1e1c225a40ead4c5d07bee77d19164\\adventure-text-serializer-gson-4.11.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\com.google.code.gson\\gson\\2.8.9\\8a432c1d6825781e21a02db2e2c33c5fde2833b9\\gson-2.8.9.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\org.yaml\\snakeyaml\\1.30\\8fde7fe2586328ac3c68db92045e1c8759125000\\snakeyaml-1.30.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\com.googlecode.json-simple\\json-simple\\1.1.1\\c9ad4a0850ab676c5c64461a05ca524cdfff59f1\\json-simple-1.1.1.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\it.unimi.dsi\\fastutil\\8.5.6\\76f95700418a68fbc4ac050525261f05dc681ca1\\fastutil-8.5.6.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\org.apache.logging.log4j\\log4j-api\\2.17.1\\d771af8e336e372fb5399c99edabe0919aeaf5b2\\log4j-api-2.17.1.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\org.slf4j\\slf4j-api\\1.8.0-beta4\\83b0359d847ee053d745be7ec0d8e9e8a44304b4\\slf4j-api-1.8.0-beta4.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\org.checkerframework\\checker-qual\\3.21.0\\55aaf38ec65c7aee19697257d644493c06dee1fe\\checker-qual-3.21.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\org.reactivestreams\\reactive-streams\\1.0.4\\3864a1320d97d7b045f729a326e1e077661f31b7\\reactive-streams-1.0.4.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\com.google.guava\\failureaccess\\1.0.1\\1dcf1de382a0bf95a3d8b0849546c88bac1292c9\\failureaccess-1.0.1.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\com.google.guava\\listenablefuture\\9999.0-empty-to-avoid-conflict-with-guava\\b421526c5f297295adef1c886e5246c39d4ac629\\listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\com.google.code.findbugs\\jsr305\\3.0.2\\25ea2e8b0c338a877313bd4672d3fe056ea78f0d\\jsr305-3.0.2.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\com.google.errorprone\\error_prone_annotations\\2.7.1\\458d9042f7aa6fa9a634df902b37f544e15aacac\\error_prone_annotations-2.7.1.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\com.google.j2objc\\j2objc-annotations\\1.3\\ba035118bc8bac37d7eff77700720999acd9986d\\j2objc-annotations-1.3.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\examination-string\\1.3.0\\6f34afef5c54ccce4996bc321abf77518b55b4bd\\examination-string-1.3.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\net.kyori\\examination-api\\1.3.0\\8a2d185275307f1e2ef2adf7152b9a0d1d44c30b\\examination-api-1.3.0.jar;C:\\Users\\Samantha\\.gradle\\caches\\modules-2\\files-2.1\\org.jetbrains\\annotations\\23.0.0\\8cc20c07506ec18e0834947b84a864bfc094484e\\annotations-23.0.0.jar'
|
||||
-d 'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\build\\docs\\javadoc'
|
||||
-doctitle 'SimplexSS 1.0.1 API'
|
||||
-notimestamp
|
||||
-quiet
|
||||
-windowtitle 'SimplexSS 1.0.1 API'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\api\\Context.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\api\\Identifier.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\api\\ISchedule.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\api\\IService.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\api\\ServiceException.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\api\\ServicePoolException.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\impl\\Main.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\impl\\ServiceImpl.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\scheduler\\BukkitDisposable.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\scheduler\\ExecutableService.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\scheduler\\ReactorBukkitScheduler.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\scheduler\\SchedulingSystem.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\scheduler\\ServiceManager.java'
|
||||
'C:\\Users\\Samantha\\IdeaProjects\\SimplexSS\\src\\main\\java\\io\\github\\simplexdevelopment\\scheduler\\ServicePool.java'
|
||||
2
build/tmp/javadocJar/MANIFEST.MF
Normal file
2
build/tmp/javadocJar/MANIFEST.MF
Normal file
@ -0,0 +1,2 @@
|
||||
Manifest-Version: 1.0
|
||||
|
||||
3
build/tmp/shadowJar/MANIFEST.MF
Normal file
3
build/tmp/shadowJar/MANIFEST.MF
Normal file
@ -0,0 +1,3 @@
|
||||
Manifest-Version: 1.0
|
||||
Class-Path: reactor-core-3.4.24.jar reactive-streams-1.0.4.jar
|
||||
|
||||
2
build/tmp/sourcesJar/MANIFEST.MF
Normal file
2
build/tmp/sourcesJar/MANIFEST.MF
Normal file
@ -0,0 +1,2 @@
|
||||
Manifest-Version: 1.0
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>All Classes and Interfaces</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -62,35 +62,58 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab4"> </div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||||
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a><<a href="io/github/simplexdevelopment/api/Context.html" title="type parameter in Context">S</a>></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
||||
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> </div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
|
||||
<div class="block">This interface contains surface level methods for the <a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
||||
<div class="block">Represents a service that can be registered to a <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">This class is used to manage the scheduling of <a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
||||
and the creation of <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
|
||||
<div class="block">This class is used to represent a service exception.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> </div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> </div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">The ServiceManager is a factory class for managing <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
|
||||
<div class="block">This class is used to represent a service pool exception.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>All Packages</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>Constant Field Values</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>Deprecated List</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>API Help</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>A-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>L-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>M-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>N-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>O-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>P-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -65,15 +65,13 @@ loadScripts(document, 'script');</script>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#plugin" class="member-name-link">plugin</a> - Variable in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#plugin" class="member-name-link">plugin</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">The plugin instance.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#plugin" class="member-name-link">plugin</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd>
|
||||
<div class="block">The plugin to use for registering tasks.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html" class="type-name-link" title="class in io.github.simplexdevelopment.impl">PoolHolder</a> - Class in <a href="../io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#%3Cinit%3E(io.github.simplexdevelopment.impl.Main)" class="member-name-link">PoolHolder(Main)</a> - Constructor for class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>Q-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -60,8 +60,16 @@ loadScripts(document, 'script');</script>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#queue(io.github.simplexdevelopment.api.IService)" class="member-name-link">queue(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#queueService(io.github.simplexdevelopment.api.IService)" class="member-name-link">queueService(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#queueAll()" class="member-name-link">queueAll()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#queueService(io.github.simplexdevelopment.api.IService)" class="member-name-link">queueService(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This method is the actual method used to schedule a service.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#queueServices()" class="member-name-link">queueServices()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This method can be used to start all the services registered with this pool.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>R-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -55,15 +55,21 @@ loadScripts(document, 'script');</script>
|
||||
<h2 class="title" id="I:R">R</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#%3Cinit%3E(org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">ReactorBukkitScheduler(JavaPlugin)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#recycle()" class="member-name-link">recycle()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/Main.html#registerServices(io.github.simplexdevelopment.impl.PoolHolder)" class="member-name-link">registerServices(PoolHolder)</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
||||
<dd>
|
||||
<div class="block">This will clear the ServicePool of all services and return an empty pool.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/Main.html#registerServices(java.lang.String)" class="member-name-link">registerServices(String)</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#removeService(io.github.simplexdevelopment.api.IService)" class="member-name-link">removeService(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This method removes a service from the service pool set.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#repeating" class="member-name-link">repeating</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">If the service should be executed once or continuously.</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>S-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -69,25 +69,30 @@ loadScripts(document, 'script');</script>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/Main.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">The bukkit scheduler.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#scheduler" class="member-name-link">scheduler</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">The scheduler used to run the services in this pool.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a><<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This class is used to manage the scheduling of <a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
|
||||
and the creation of <a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#%3Cinit%3E(T)" class="member-name-link">SchedulingSystem(T)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of the scheduling system.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#selectedPool" class="member-name-link">selectedPool</a> - Variable in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#service_name" class="member-name-link">service_name</a> - Variable in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">The name of the service.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServiceException</a> - Exception in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This class is used to represent a service exception.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html#%3Cinit%3E(io.github.simplexdevelopment.api.IService)" class="member-name-link">ServiceException(IService)</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a new service exception which states the service is not present within any service pools.</div>
|
||||
@ -103,13 +108,17 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">The service manager to use for controlling service pools.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">The ServiceManager is a factory class for managing <a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#%3Cinit%3E()" class="member-name-link">ServiceManager()</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of the Service Manager class.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#%3Cinit%3E(java.lang.String,boolean)" class="member-name-link">ServicePool(String, boolean)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd>
|
||||
<div class="block">This will create a new instance of a Service Pool with a <code>Scheduler</code> as its main scheduler.</div>
|
||||
@ -118,10 +127,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">This will create a new instance of a Service Pool with the <a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> as its main scheduler.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#servicePoolCollection" class="member-name-link">servicePoolCollection</a> - Variable in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html" class="type-name-link" title="class in io.github.simplexdevelopment.api">ServicePoolException</a> - Exception in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This class is used to represent a service pool exception.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html#%3Cinit%3E()" class="member-name-link">ServicePoolException()</a> - Constructor for exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a new generic service pool exception.</div>
|
||||
@ -138,8 +147,6 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Cancels the execution of this service.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#setContext(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setContext(ServicePool)</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Context.html#setContext(S)" class="member-name-link">setContext(S)</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html#setParentPool(io.github.simplexdevelopment.scheduler.ServicePool)" class="member-name-link">setParentPool(ServicePool)</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
@ -154,8 +161,6 @@ loadScripts(document, 'script');</script>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#start()" class="member-name-link">start()</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#startServices()" class="member-name-link">startServices()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html#stop()" class="member-name-link">stop()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd>
|
||||
<div class="block">The actual end method for the service.</div>
|
||||
@ -163,9 +168,13 @@ loadScripts(document, 'script');</script>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/ServiceImpl.html#stop()" class="member-name-link">stop()</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#stopService(java.lang.String,reactor.core.publisher.Mono)" class="member-name-link">stopService(String, Mono<Disposable>)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This is the method used to stop a service.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices(Flux<Disposable>)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This method can be used to stop all the services registered with this pool.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ServicePoolException.html#supplyException()" class="member-name-link">supplyException()</a> - Static method in exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ServiceException.html#supplyException(io.github.simplexdevelopment.api.IService)" class="member-name-link">supplyException(IService)</a> - Static method in exception io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></dt>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>T-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>B-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -55,11 +55,15 @@ loadScripts(document, 'script');</script>
|
||||
<h2 class="title" id="I:B">B</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a> - Record Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html#%3Cinit%3E(org.bukkit.scheduler.BukkitTask)" class="member-name-link">BukkitDisposable(BukkitTask)</a> - Constructor for record class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates an instance of a <code>BukkitDisposable</code> record class.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#bukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin,io.github.simplexdevelopment.api.IService...)" class="member-name-link">bukkitServicePool(String, JavaPlugin, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>C-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -63,11 +63,11 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Whether the service has been cancelled or not.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Context.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Context</a><<a href="../io/github/simplexdevelopment/api/Context.html" title="type parameter in Context">S</a>> - Interface in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Context.html#contextCollection()" class="member-name-link">contextCollection()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#contextCollection()" class="member-name-link">contextCollection()</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#createServicePool(java.lang.String,io.github.simplexdevelopment.api.IService...)" class="member-name-link">createServicePool(String, IService...)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html#createWorker()" class="member-name-link">createWorker()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></dt>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>D-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>E-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -54,6 +54,8 @@ loadScripts(document, 'script');</script>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a>
|
||||
<h2 class="title" id="I:E">E</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#emptyBukkitServicePool(java.lang.String,org.bukkit.plugin.java.JavaPlugin)" class="member-name-link">emptyBukkitServicePool(String, JavaPlugin)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html#emptyServicePool(java.lang.String,boolean)" class="member-name-link">emptyServicePool(String, boolean)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
@ -61,7 +63,9 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Indicates whether some other object is "equal to" this one.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" class="type-name-link" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a> - Class in <a href="../io/github/simplexdevelopment/scheduler/package-summary.html">io.github.simplexdevelopment.scheduler</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#%3Cinit%3E(java.lang.String)" class="member-name-link">ExecutableService(String)</a> - Constructor for class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new instance of an executable service.</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>F-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>G-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -60,10 +60,6 @@ loadScripts(document, 'script');</script>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Context.html#getContext()" class="member-name-link">getContext()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/PoolHolder.html#getContext()" class="member-name-link">getContext()</a> - Method in class io.github.simplexdevelopment.impl.<a href="../io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#getDefaultNamespacedKey()" class="member-name-link">getDefaultNamespacedKey()</a> - Static method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html#getDelay()" class="member-name-link">getDelay()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#getDelay()" class="member-name-link">getDelay()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
@ -74,6 +70,8 @@ loadScripts(document, 'script');</script>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#getName()" class="member-name-link">getName()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#getName()" class="member-name-link">getName()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Identifier.html#getNumericalId()" class="member-name-link">getNumericalId()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html#getParentPool()" class="member-name-link">getParentPool()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
@ -95,7 +93,9 @@ loadScripts(document, 'script');</script>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#getScheduler()" class="member-name-link">getScheduler()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#getService(java.lang.String)" class="member-name-link">getService(String)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">Gets a service based on the name of the service defined by <a href="../io/github/simplexdevelopment/api/Identifier.html#getName()"><code>Identifier.getName()</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ISchedule.html#getServiceManager()" class="member-name-link">getServiceManager()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html#getServiceManager()" class="member-name-link">getServiceManager()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></dt>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>H-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>I-Index</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -55,7 +55,9 @@ loadScripts(document, 'script');</script>
|
||||
<h2 class="title" id="I:I">I</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../io/github/simplexdevelopment/api/Identifier.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">Identifier</a> - Interface in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a> - package io.github.simplexdevelopment.api</dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/impl/package-summary.html">io.github.simplexdevelopment.impl</a> - package io.github.simplexdevelopment.impl</dt>
|
||||
@ -67,19 +69,25 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Cancels the execution of this service.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/ISchedule.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">ISchedule</a> - Interface in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">This interface contains surface level methods for the <a href="../io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html#isDisposed()" class="member-name-link">isDisposed()</a> - Method in record class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></dt>
|
||||
<dd>
|
||||
<div class="block">Checks if the task is cancelled.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html" class="type-name-link" title="interface in io.github.simplexdevelopment.api">IService</a> - Interface in <a href="../io/github/simplexdevelopment/api/package-summary.html">io.github.simplexdevelopment.api</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">Represents a service that can be registered to a <a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/api/IService.html#isPeriodic()" class="member-name-link">isPeriodic()</a> - Method in interface io.github.simplexdevelopment.api.<a href="../io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html#isPeriodic()" class="member-name-link">isPeriodic()</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../io/github/simplexdevelopment/scheduler/ServicePool.html#isValidService(io.github.simplexdevelopment.api.IService)" class="member-name-link">isValidService(IService)</a> - Method in class io.github.simplexdevelopment.scheduler.<a href="../io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></dt>
|
||||
<dd> </dd>
|
||||
<dd>
|
||||
<div class="block">Checks to see if the defined service is present within this pool.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">L</a> <a href="index-11.html">M</a> <a href="index-12.html">N</a> <a href="index-13.html">O</a> <a href="index-14.html">P</a> <a href="index-15.html">Q</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized Form</a></main>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>Overview</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>Context</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -74,11 +74,12 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Known Implementing Classes:</dt>
|
||||
<dd><code><a href="../impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></code></dd>
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>S</code> - Any object type to wrap with this class.</dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Context<S></span></div>
|
||||
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>ISchedule</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -79,6 +79,7 @@ loadScripts(document, 'script');</script>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISchedule</span></div>
|
||||
<div class="block">This interface contains surface level methods for the <a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
@ -145,7 +146,7 @@ loadScripts(document, 'script');</script>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to use to locate the associated service pool and queue the service for execution.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Disposable> that can be used to cancel the service.</dd>
|
||||
<dd>A Mono object that can be used to cancel the service.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@ -157,7 +158,7 @@ loadScripts(document, 'script');</script>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to run once.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@ -169,7 +170,7 @@ loadScripts(document, 'script');</script>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully stop.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@ -181,7 +182,7 @@ loadScripts(document, 'script');</script>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>service</code> - The service to forcefully start.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Mono<Void> object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
|
||||
<dd>A Mono object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
|
||||
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
|
||||
<title>IService</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@ -84,6 +84,10 @@ loadScripts(document, 'script');</script>
|
||||
<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>, <a href="Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></span></div>
|
||||
<div class="block">Represents a service that can be registered to a <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.
|
||||
<p>
|
||||
This interface provides surface level methods to be used by the <a href="../scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>
|
||||
associated to each service.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user