journeymap.api.v2.common.event.common

Enum WaypointEvent.Context

java.lang.Object

java.lang.Enum<WaypointEvent.Context>

journeymap.api.v2.common.event.common.WaypointEvent.Context

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WaypointEvent.Context>

Enclosing class:

WaypointEvent

public static enum WaypointEvent.Context
extends java.lang.Enum<WaypointEvent.Context>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE Fired when a new waypoint is created.
DELETED Fired when a waypoint is deleted.
READ Fired when a waypoint is read from disk, waypoints are always read in batches.
UPDATE Fired when an existing waypoint is updated.

Method Summary

Modifier and Type	Method and Description
static WaypointEvent.Context	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WaypointEvent.Context[]	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

CREATE

public static final WaypointEvent.Context CREATE

Fired when a new waypoint is created.

UPDATE

public static final WaypointEvent.Context UPDATE

Fired when an existing waypoint is updated.

DELETED

public static final WaypointEvent.Context DELETED

Fired when a waypoint is deleted.

READ

public static final WaypointEvent.Context READ

Fired when a waypoint is read from disk, waypoints are always read in batches. This event will be fired multiple times in a row, once per waypoint as it is loaded and put into internal cache.

This will happen periodically as the waypoint cache gets refreshed on dimension change, modifying some options, and at world join.

Method Detail

values

public static WaypointEvent.Context[] 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 (WaypointEvent.Context c : WaypointEvent.Context.values())
    System.out.println(c);

Returns:

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

valueOf

public static WaypointEvent.Context 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