Package org.omegazero.common.event

Class Tasks

java.lang.Object

org.omegazero.common.event.Tasks

public final class Tasks
extends Object

Convenience class for globally scheduled tasks using a TaskScheduler.

This class uses a single TaskScheduler instance, accessible through the constant I.

Since:

2.1

Field Summary

Fields

Modifier and Type	Field	Description
static final TaskScheduler	I	The TaskScheduler instance.
static final TaskScheduler	TASKS	The TaskScheduler instance, an alias of I.

Method Summary

Modifier and Type	Method	Description
static void	async(Runnable handler)	Queues the given Runnable to be run asychronously, as soon as possible.
static void	async(Consumer<Object[]> handler, Object... args)	Queues the given Consumer with the given arguments to be run asychronously, as soon as possible.
static boolean	clear(long id)	Deprecated. Since 2.9.1, use I
static boolean	clear(TaskScheduler.TimerTask tt)	Deprecated. Since 2.9.1, use I
static void	exit()	See TaskScheduler.exit().
static TaskScheduler.TimerTask	interval(Runnable handler, long timeout)	Deprecated. Since 2.9.1, use I
static TaskScheduler.TimerTask	interval(Consumer<Object[]> handler, long interval, Object... args)	Deprecated. Since 2.9.1, use I
static void	setErrorHandler(Consumer<Throwable> errorHandler)	See TaskScheduler.setErrorHandler(Consumer).
static TaskScheduler.TimerTask	timeout(Runnable handler, long timeout)	Deprecated. Since 2.9.1, use I
static TaskScheduler.TimerTask	timeout(Consumer<Object[]> handler, long timeout, Object... args)	Deprecated. Since 2.9.1, use I

Methods inherited from class java.lang.Object

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

Field Details

I

public static final TaskScheduler I

The TaskScheduler instance.

Since:

2.9.1

See Also:

• TASKS

TASKS

public static final TaskScheduler TASKS

The TaskScheduler instance, an alias of I.

This constant may be used instead of I in a static import, because it has a more descriptive name.

Since:

2.9.1

Method Details

timeout

@Deprecated
public static TaskScheduler.TimerTask timeout(Runnable handler,
 long timeout)

Deprecated.

Since 2.9.1, use I

See TaskScheduler.timeout(Runnable, long).

Parameters:

handler - The handler

timeout - The timeout in milliseconds

Returns:

The TaskScheduler.TimerTask instance

Since:

2.6

timeout

@Deprecated
public static TaskScheduler.TimerTask timeout(Consumer<Object[]> handler,
 long timeout,
 Object... args)

Deprecated.

Since 2.9.1, use I

See TaskScheduler.timeout(Consumer, long, Object...).

Parameters:

handler - The handler

timeout - The timeout in milliseconds

args - Handler arguments

Returns:

The TaskScheduler.TimerTask instance

Since:

2.1

interval

@Deprecated
public static TaskScheduler.TimerTask interval(Runnable handler,
 long timeout)

Deprecated.

Since 2.9.1, use I

See TaskScheduler.interval(Runnable, long).

Parameters:

handler - The handler

timeout - The interval in milliseconds

Returns:

The TaskScheduler.TimerTask instance

Since:

2.6

interval

@Deprecated
public static TaskScheduler.TimerTask interval(Consumer<Object[]> handler,
 long interval,
 Object... args)

Deprecated.

Since 2.9.1, use I

See TaskScheduler.interval(Consumer, long, Object...).

Parameters:

handler - The handler

interval - The interval in milliseconds

args - Handler arguments

Returns:

The TaskScheduler.TimerTask instance

Since:

2.1

clear

@Deprecated
public static boolean clear(TaskScheduler.TimerTask tt)

Deprecated.

Since 2.9.1, use I

See TaskScheduler.clear(TimerTask).

Parameters:

tt - The TaskScheduler.TimerTask to cancel

Returns:

true if tt is not null

Since:

2.1

clear

@Deprecated
public static boolean clear(long id)

Deprecated.

Since 2.9.1, use I

See TaskScheduler.clear(long).

Parameters:

id - The id of the TaskScheduler.TimerTask to cancel

Returns:

true if the task was found and successfully canceled

Since:

2.1

async

public static void async(Runnable handler)

Queues the given Runnable to be run asychronously, as soon as possible.

This method calls TaskScheduler.timeout(Runnable, long) with a timeout value of 0. Usage of this method should be kept at a minimum, since the worker threads executing handlers passed to this method are shared with other timer tasks. For more resource- or IO-intensive tasks, a dedicated TaskQueueExecutor should be used instead.

Parameters:

handler - The handler

Since:

2.11.0

See Also:

• async(Consumer, Object...)

async

public static void async(Consumer<Object[]> handler,
 Object... args)

Queues the given Consumer with the given arguments to be run asychronously, as soon as possible.

See async(Runnable) for usage hints regarding the async methods.

Parameters:

handler - The handler

args - Arguments to be passed to the handler

Since:

2.11.0

See Also:

• async(Runnable)

exit

public static void exit()

See TaskScheduler.exit(). Called with I.

setErrorHandler

public static void setErrorHandler(Consumer<Throwable> errorHandler)

See TaskScheduler.setErrorHandler(Consumer). Called with I.

Parameters:

errorHandler - The error handler

Since:

2.6