Package com.sk89q.worldedit.extension.platform

Enum Class Preference

java.lang.Object

java.lang.Enum<Preference>

com.sk89q.worldedit.extension.platform.Preference

All Implemented Interfaces:

Serializable, Comparable<Preference>, Constable

public enum Preference
extends Enum<Preference>

Indicates the preference of a platform for a particular Capability.

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
NORMAL	Indicates that preference for a platform is neutral for a given capability.
PREFER_OTHERS	Indicates that there should not be a preference for the platform for a given capability.
PREFERRED	Indicates that the platform should be preferred for a given capability.

Method Summary

Modifier and Type	Method	Description
boolean	isPreferredOver(Preference other)	Returns whether this given preference is preferred over the given other preference.
static Preference	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Preference[]	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

PREFERRED

public static final Preference PREFERRED

Indicates that the platform should be preferred for a given capability.

NORMAL

public static final Preference NORMAL

Indicates that preference for a platform is neutral for a given capability.

PREFER_OTHERS

public static final Preference PREFER_OTHERS

Indicates that there should not be a preference for the platform for a given capability.

Method Details

values

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

isPreferredOver

public boolean isPreferredOver(Preference other)

Returns whether this given preference is preferred over the given other preference.

Parameters:

other - the other preference

Returns:

true if this preference is greater