Package com.sk89q.worldedit.util

Enum Class SideEffect

java.lang.Object

java.lang.Enum<SideEffect>

com.sk89q.worldedit.util.SideEffect

All Implemented Interfaces:

Serializable, Comparable<SideEffect>, Constable

public enum SideEffect
extends Enum<SideEffect>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SideEffect.State

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ENTITY_AI
EVENTS
LIGHTING
NEIGHBORS
NETWORK	Internal use only.
POI_UPDATE	Internal use only.
UPDATE
VALIDATION

Method Summary

Modifier and Type	Method	Description
SideEffect.State	getDefaultValue()
String	getDescription()
String	getDisplayName()
boolean	isExposed()	Determines if this side effect is considered API.
static SideEffect	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SideEffect[]	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

LIGHTING

public static final SideEffect LIGHTING

NEIGHBORS

public static final SideEffect NEIGHBORS

UPDATE

public static final SideEffect UPDATE

VALIDATION

public static final SideEffect VALIDATION

ENTITY_AI

public static final SideEffect ENTITY_AI

EVENTS

public static final SideEffect EVENTS

POI_UPDATE

public static final SideEffect POI_UPDATE

Internal use only.

NETWORK

public static final SideEffect NETWORK

Internal use only.

Method Details

values

public static SideEffect[] 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 SideEffect 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

getDisplayName

public String getDisplayName()

getDescription

public String getDescription()

getDefaultValue

public SideEffect.State getDefaultValue()

isExposed

public boolean isExposed()

Determines if this side effect is considered API.

Returns:

if the side effect is exposed via API