com.sk89q.worldguard.protection

Enum FlagValueCalculator.Result

java.lang.Object

java.lang.Enum<FlagValueCalculator.Result>

com.sk89q.worldguard.protection.FlagValueCalculator.Result

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FlagValueCalculator.Result>

Enclosing class:

FlagValueCalculator

public static enum FlagValueCalculator.Result
extends java.lang.Enum<FlagValueCalculator.Result>

Describes the membership result from FlagValueCalculator.getMembership(RegionAssociable).

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL Indicates that the player is not a member of all overlapping regions.
NO_REGIONS Indicates that there are no regions or the only regions are ones with Flags.PASSTHROUGH enabled.
SUCCESS Indicates that the player is a member of all overlapping regions.

Method Summary

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

NO_REGIONS

public static final FlagValueCalculator.Result NO_REGIONS

Indicates that there are no regions or the only regions are ones with Flags.PASSTHROUGH enabled.

FAIL

public static final FlagValueCalculator.Result FAIL

Indicates that the player is not a member of all overlapping regions.

SUCCESS

public static final FlagValueCalculator.Result SUCCESS

Indicates that the player is a member of all overlapping regions.

Method Detail

values

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

Returns:

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

valueOf

public static FlagValueCalculator.Result 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