net.risingworld.api.events

Enum Threading

java.lang.Object

java.lang.Enum<Threading>

net.risingworld.api.events.Threading

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Threading>

public enum Threading
extends java.lang.Enum<Threading>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Async Default behaviour, calls event directly (same thread, not synchronized).
Sync Synchronizes event calls.
Threaded Creates a separate, new thread to call the event.

Method Summary

Modifier and Type	Method and Description
static Threading	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Threading[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Sync

public static final Threading Sync

Synchronizes event calls. This slows down the event calls, but makes them thread-safe.

Async

public static final Threading Async

Default behaviour, calls event directly (same thread, not synchronized). This is the fastest way to trigger events, but it is not thread-safe.

Threaded

public static final Threading Threaded

Creates a separate, new thread to call the event. Event call is not thread-safe, and it is no longer possible to cancel events, but it makes sense to use this mode when doing heavy computations (so it does not slow down or halt execution of the regular event).

Method Detail

values

public static Threading[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Threading c : Threading.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Threading valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null