Package io.github.simplex.api

Class ExecutableService

java.lang.Object

io.github.simplex.api.ExecutableService

All Implemented Interfaces:

IService, Runnable

Direct Known Subclasses:

ServiceImpl

public abstract class ExecutableService
extends Object
implements IService

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	cancelled
private final long	delay
private final boolean	mayInterruptWhenRunning
private final long	period
private final boolean	repeating
private final org.bukkit.NamespacedKey	service_name

Constructor Summary

Constructors

Constructor	Description
ExecutableService(@NotNull org.bukkit.NamespacedKey service_name, @Nullable Long delay, @Nullable Long period, @NotNull Boolean repeating, @NotNull Boolean mayInterruptWhenRunning)	Creates a new instance of an executable service.

Method Summary

Modifier and Type	Method	Description
(package private) reactor.core.publisher.Mono<Void>	cancel()	Actual stop call, to ensure that the service actually #isCancelled().
long	getDelay()
org.bukkit.NamespacedKey	getNamespacedKey()
long	getPeriod()
boolean	isCancelled()	Cancels the execution of this service.
boolean	isPeriodic()
reactor.core.publisher.Mono<Void>	setCancelled(boolean cancel)	Cancels the execution of this service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.simplex.api.IService

getParentPool, getPlugin, run, start, stop

Field Details

service_name

private final org.bukkit.NamespacedKey service_name

delay

private final long delay

period

private final long period

repeating

private final boolean repeating

mayInterruptWhenRunning

private final boolean mayInterruptWhenRunning

cancelled

private boolean cancelled

Constructor Details

ExecutableService

public ExecutableService(@NotNull
 @NotNull org.bukkit.NamespacedKey service_name,
 @Nullable
 @Nullable Long delay,
 @Nullable
 @Nullable Long period,
 @NotNull
 @NotNull Boolean repeating,
 @NotNull
 @NotNull Boolean mayInterruptWhenRunning)

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 repeating as true, and the period is null, then the period will automatically be set to 20 minutes. Each service is registered with a NamespacedKey, to allow for easy identification within the associated ServicePool.

Parameters:

service_name - A namespaced key which can be used to identify the service.

delay - A specified amount of time (in ticks) to wait before the service runs.

period - How long the service should wait between service executions (in ticks).

repeating - If the service should be scheduled for repeated executions or not.

mayInterruptWhenRunning - If the service can be cancelled during execution.

Method Details

getNamespacedKey

public org.bukkit.NamespacedKey getNamespacedKey()

Specified by:

getNamespacedKey in interface IService

Returns:

The NamespacedKey of this service.

getDelay

public long getDelay()

Specified by:

getDelay in interface IService

Returns:

How long the service should wait before executing the first time.

getPeriod

public long getPeriod()

Specified by:

getPeriod in interface IService

Returns:

How long the service should wait between subsequent executions.

isPeriodic

public boolean isPeriodic()

Specified by:

isPeriodic in interface IService

Returns:

If the service should be scheduled for repeated executions or not.

isCancelled

public boolean isCancelled()

Cancels the execution of this service.

Returns:

true if the service was cancelled, false if not.

setCancelled

public reactor.core.publisher.Mono<Void> setCancelled(boolean cancel)

Cancels the execution of this service.

Parameters:

cancel - Whether the service should be cancelled or not.

cancel

@Contract(pure=true)
reactor.core.publisher.Mono<Void> cancel()

Actual stop call, to ensure that the service actually #isCancelled().