org.cloudburstmc.server.scheduler

Class PluginTask<T>

java.lang.Object

org.cloudburstmc.server.scheduler.Task

org.cloudburstmc.server.scheduler.PluginTask<T>

All Implemented Interfaces:

Runnable

public abstract class PluginTask<T>
extends Task

Represents a task created by a plugin. For plugin developers: Tasks that extend this class, won't be executed when the plugin is disabled. Otherwise, tasks that extend this class can use getOwner() to get its owner. An example for plugin create a task:

     public class ExampleTask extends PluginTask<ExamplePlugin>{
         public ExampleTask(ExamplePlugin plugin){
             super(plugin);
         }

         @Override
         public void onRun(int currentTick){
             getOwner().getLogger().info("Task is executed in tick "+currentTick);
         }
     }
 

If you want Cloudburst to execute this task with delay or repeat, use ServerScheduler.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.cloudburstmc.api.plugin.PluginContainer	container
protected T	owner

Constructor Summary

Constructors

Constructor and Description
PluginTask(T owner) Constructs a plugin-owned task.

Method Summary

Modifier and Type	Method and Description
org.cloudburstmc.api.plugin.PluginContainer	getContainer()
T	getOwner() Returns the owner of this task.

Methods inherited from class org.cloudburstmc.server.scheduler.Task

cancel, getHandler, getTaskId, onCancel, onRun, run, setHandler

Methods inherited from class java.lang.Object

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

Field Detail

owner

protected final T owner

container

protected final org.cloudburstmc.api.plugin.PluginContainer container

Constructor Detail

PluginTask

public PluginTask(@Nonnull
                  T owner)

Constructs a plugin-owned task.

Parameters:

owner - The plugin object that owns this task.

Method Detail

getOwner

@Nonnull
public final T getOwner()

Returns the owner of this task.

Returns:

The plugin object that owns this task.

getContainer

@Nonnull
public org.cloudburstmc.api.plugin.PluginContainer getContainer()