/* * MIT License * * Copyright (c) 2023 Sevastjan * * 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. */ package me.clip.placeholderapi.scheduler; import me.clip.placeholderapi.scheduler.scheduling.schedulers.TaskScheduler; import me.clip.placeholderapi.scheduler.scheduling.tasks.MyScheduledTask; import org.bukkit.plugin.Plugin; /** * Just modified BukkitRunnable */ public abstract class UniversalRunnable implements Runnable { MyScheduledTask task; public synchronized void cancel() throws IllegalStateException { checkScheduled(); task.cancel(); } /** * Returns true if this task has been cancelled. * * @return true if the task has been cancelled * @throws IllegalStateException if task was not scheduled yet */ public synchronized boolean isCancelled() throws IllegalStateException { checkScheduled(); return task.isCancelled(); } /** * Schedules this in the Bukkit scheduler to run on next tick. * * @param plugin the reference to the plugin scheduling task * @return {@link MyScheduledTask} * @throws IllegalArgumentException if plugin is null * @throws IllegalStateException if this was already scheduled * @see TaskScheduler#runTask(Runnable) */ public synchronized MyScheduledTask runTask(Plugin plugin) throws IllegalArgumentException, IllegalStateException { checkNotYetScheduled(); return setupTask(UniversalScheduler.getScheduler(plugin).runTask(this)); } /** * Asynchronous tasks should never access any API in Bukkit. Great care * should be taken to assure the thread-safety of asynchronous tasks. *
* Schedules this in the Bukkit scheduler to run asynchronously. * * @param plugin the reference to the plugin scheduling task * @return {@link MyScheduledTask} * @throws IllegalArgumentException if plugin is null * @throws IllegalStateException if this was already scheduled * @see TaskScheduler#runTaskAsynchronously(Runnable) */ public synchronized MyScheduledTask runTaskAsynchronously(Plugin plugin) throws IllegalArgumentException, IllegalStateException { checkNotYetScheduled(); return setupTask(UniversalScheduler.getScheduler(plugin).runTaskAsynchronously(this)); } /** * Schedules this to run after the specified number of server ticks. * * @param plugin the reference to the plugin scheduling task * @param delay the ticks to wait before running the task * @return {@link MyScheduledTask} * @throws IllegalArgumentException if plugin is null * @throws IllegalStateException if this was already scheduled * @see TaskScheduler#runTaskLater(Runnable, long) */ public synchronized MyScheduledTask runTaskLater(Plugin plugin, long delay) throws IllegalArgumentException, IllegalStateException { checkNotYetScheduled(); return setupTask(UniversalScheduler.getScheduler(plugin).runTaskLater(this, delay)); } /** * Asynchronous tasks should never access any API in Bukkit. Great care * should be taken to assure the thread-safety of asynchronous tasks. *
* Schedules this to run asynchronously after the specified number of * server ticks. * * @param plugin the reference to the plugin scheduling task * @param delay the ticks to wait before running the task * @return {@link MyScheduledTask} * @throws IllegalArgumentException if plugin is null * @throws IllegalStateException if this was already scheduled * @see TaskScheduler#runTaskLaterAsynchronously(Runnable, long) */ public synchronized MyScheduledTask runTaskLaterAsynchronously(Plugin plugin, long delay) throws IllegalArgumentException, IllegalStateException { checkNotYetScheduled(); return setupTask(UniversalScheduler.getScheduler(plugin).runTaskLaterAsynchronously(this, delay)); } /** * Schedules this to repeatedly run until cancelled, starting after the * specified number of server ticks. * * @param plugin the reference to the plugin scheduling task * @param delay the ticks to wait before running the task * @param period the ticks to wait between runs * @return {@link MyScheduledTask} * @throws IllegalArgumentException if plugin is null * @throws IllegalStateException if this was already scheduled * @see TaskScheduler#runTaskTimer(Runnable, long, long) */ public synchronized MyScheduledTask runTaskTimer(Plugin plugin, long delay, long period) throws IllegalArgumentException, IllegalStateException { checkNotYetScheduled(); return setupTask(UniversalScheduler.getScheduler(plugin).runTaskTimer(this, delay, period)); } /** * Asynchronous tasks should never access any API in Bukkit. Great care * should be taken to assure the thread-safety of asynchronous tasks. *
* Schedules this to repeatedly run asynchronously until cancelled, * starting after the specified number of server ticks. * * @param plugin the reference to the plugin scheduling task * @param delay the ticks to wait before running the task for the first * time * @param period the ticks to wait between runs * @return {@link MyScheduledTask} * @throws IllegalArgumentException if plugin is null * @throws IllegalStateException if this was already scheduled * @see TaskScheduler#runTaskTimerAsynchronously(Runnable, long, long) */ public synchronized MyScheduledTask runTaskTimerAsynchronously(Plugin plugin, long delay, long period) throws IllegalArgumentException, IllegalStateException { checkNotYetScheduled(); return setupTask(UniversalScheduler.getScheduler(plugin).runTaskTimerAsynchronously(this, delay, period)); } private void checkScheduled() { if (task == null) { throw new IllegalStateException("Not scheduled yet"); } } private void checkNotYetScheduled() { if (task != null) { throw new IllegalStateException("Already scheduled"); } } private MyScheduledTask setupTask(final MyScheduledTask task) { this.task = task; return task; } }