com.sk89q.worldguard.protection.flags

Class EnumFlag<T extends Enum<T>>

java.lang.Object

com.sk89q.worldguard.protection.flags.Flag<T>

com.sk89q.worldguard.protection.flags.EnumFlag<T>

Direct Known Subclasses:

EntityTypeFlag, RegionGroupFlag

public class EnumFlag<T extends Enum<T>>
extends Flag<T>

Stores an enum value.

Constructor Summary

Constructors

Constructor and Description
EnumFlag(String name, Class<T> enumClass)
EnumFlag(String name, Class<T> enumClass, RegionGroup defaultGroup)

Method Summary

Modifier and Type	Method and Description
T	detectValue(String input) Fuzzy detect the value if the value is not found.
Class<T>	getEnumClass() Get the enum class.
Object	marshal(T o) Convert the value stored for this flag into a type that can be serialized into YAML.
T	parseInput(WorldGuardPlugin plugin, org.bukkit.command.CommandSender sender, String input) Parse a given input to coerce it to a type compatible with the flag.
T	unmarshal(Object o) Convert a raw type that was loaded (from a YAML file, for example) into the type that this flag uses.

Methods inherited from class com.sk89q.worldguard.protection.flags.Flag

chooseValue, getDefault, getName, getRegionGroupFlag, hasConflictStrategy, implicitlySetWithMembership, requiresSubject, toString, usesMembershipAsDefault

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumFlag

public EnumFlag(String name,
                Class<T> enumClass,
                RegionGroup defaultGroup)

EnumFlag

public EnumFlag(String name,
                Class<T> enumClass)

Method Detail

getEnumClass

public Class<T> getEnumClass()

Get the enum class.

Returns:

the enum class

detectValue

public T detectValue(String input)

Fuzzy detect the value if the value is not found.

Parameters:

input - string input

Returns:

value or null

parseInput

public T parseInput(WorldGuardPlugin plugin,
                    org.bukkit.command.CommandSender sender,
                    String input)
             throws InvalidFlagFormat

Description copied from class: Flag

Parse a given input to coerce it to a type compatible with the flag.

Specified by:

parseInput in class Flag<T extends Enum<T>>

Parameters:

plugin - The plugin

sender - The sender

input - THe input

Returns:

The coerced type

Throws:

InvalidFlagFormat - Raised if the input is invalid

unmarshal

public T unmarshal(Object o)

Description copied from class: Flag

Convert a raw type that was loaded (from a YAML file, for example) into the type that this flag uses.

Specified by:

unmarshal in class Flag<T extends Enum<T>>

Parameters:

o - The object

Returns:

The unmarshalled type

marshal

public Object marshal(T o)

Description copied from class: Flag

Convert the value stored for this flag into a type that can be serialized into YAML.

Specified by:

marshal in class Flag<T extends Enum<T>>

Parameters:

o - The object

Returns:

The marshalled type