Package journeymap.api.v2.common.event.common

Enum Class WaypointEvent.Context

java.lang.Object

java.lang.Enum<WaypointEvent.Context>

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

All Implemented Interfaces:

Serializable, Comparable<WaypointEvent.Context>, Constable

Enclosing class:

WaypointEvent

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Description
static WaypointEvent.Context	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WaypointEvent.Context[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static WaypointEvent.Context[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static WaypointEvent.Context valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null