Package me.totalfreedom.service

Class SubscriptionProvider

java.lang.Object

me.totalfreedom.service.SubscriptionProvider

public final class SubscriptionProvider
extends Object

Provides static methods for creating ServiceSubscription and TaskSubscription objects.

Method Summary

Modifier and Type	Method	Description
static final <S extends Service> @NotNull ServiceSubscription<S>	asyncService(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, long interval, S service)	Creates a new ServiceSubscription object that will run the given Service object on the given interval.
static final <S extends Service> @NotNull ServiceSubscription<S>	asyncService(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, S service)	Creates a new ServiceSubscription object that will run the given Service object on the default tick interval, which is a single tick.
static final <T extends Task> @NotNull TaskSubscription<T>	runAsyncTask(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, T task)	Creates a new TaskSubscription object that will run the given Task object asynchronously on the main thread.
static final <T extends Task> @NotNull TaskSubscription<T>	runSyncTask(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, T task)	Creates a new TaskSubscription object that will run the given Task object synchronously on the main thread.
static final <S extends Service> @NotNull ServiceSubscription<S>	syncService(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, long interval, S service)	Creates a new ServiceSubscription object that will run the given Service object on the main thread at the given interval.
static final <S extends Service> @NotNull ServiceSubscription<S>	syncService(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, S service)	Creates a new ServiceSubscription object that will run the given Service object on the main thread a single time.

Methods inherited from class java.lang.Object

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

Method Details

syncService

@NotNull
@Contract(value="_, _ -> new",
          pure=false)
public static final <S extends Service>
@NotNull ServiceSubscription<S> syncService(@NotNull
 @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
 @NotNull
 S service)

Creates a new ServiceSubscription object that will run the given Service object on the main thread a single time.

Type Parameters:

S - Type inference to maintain the service type.

Parameters:

plugin - The plugin that owns the service.

service - The service to run.

Returns:

The new ServiceSubscription object.

syncService

@NotNull
@Contract(value="_,_,_ -> new",
          pure=false)
public static final <S extends Service>
@NotNull ServiceSubscription<S> syncService(@NotNull
 @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
 long interval,
 @NotNull
 S service)

Creates a new ServiceSubscription object that will run the given Service object on the main thread at the given interval.

Type Parameters:

S - Type inference to maintain the service type.

Parameters:

plugin - The plugin that owns the service.

interval - The interval to run the service at.

service - The service to run.

Returns:

The new ServiceSubscription object.

asyncService

@NotNull
@Contract(value="_, _ -> new",
          pure=false)
public static final <S extends Service>
@NotNull ServiceSubscription<S> asyncService(@NotNull
 @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
 @NotNull
 S service)

Creates a new ServiceSubscription object that will run the given Service object on the default tick interval, which is a single tick. This method will create an asynchronous service.

Type Parameters:

S - Type inference to maintain the service type.

Parameters:

plugin - The plugin that owns the service.

service - The service to run.

Returns:

The new ServiceSubscription object.

asyncService

@NotNull
@Contract(value="_,_,_ -> new",
          pure=false)
public static final <S extends Service>
@NotNull ServiceSubscription<S> asyncService(@NotNull
 @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
 long interval,
 @NotNull
 S service)

Creates a new ServiceSubscription object that will run the given Service object on the given interval. This method will create an asynchronous service.

Type Parameters:

S - Type inference to maintain the service type.

Parameters:

plugin - The plugin that owns the service.

interval - The interval to run the service at.

service - The service to run.

Returns:

The new ServiceSubscription object.

runSyncTask

@NotNull
@Contract(value="_, _ -> new",
          pure=false)
public static final <T extends Task>
@NotNull TaskSubscription<T> runSyncTask(@NotNull
 @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
 @NotNull
 T task)

Creates a new TaskSubscription object that will run the given Task object synchronously on the main thread.

Type Parameters:

T - Type inference to maintain the task type.

Parameters:

plugin - The plugin that owns the task.

task - The task to run.

Returns:

The new TaskSubscription object.

runAsyncTask

@NotNull
@Contract(value="_, _ -> new",
          pure=false)
public static final <T extends Task>
@NotNull TaskSubscription<T> runAsyncTask(@NotNull
 @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
 @NotNull
 T task)

Creates a new TaskSubscription object that will run the given Task object asynchronously on the main thread.

Type Parameters:

T - Type inference to maintain the task type.

Parameters:

plugin - The plugin that owns the task.

task - The task to run.

Returns:

The new TaskSubscription object.