com.sk89q.worldguard.protection.flags

Class Flag<T>

java.lang.Object

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

Direct Known Subclasses:

BooleanFlag, CommandStringFlag, DoubleFlag, EnumFlag, IntegerFlag, LocationFlag, SetFlag, StateFlag, StringFlag, VectorFlag

public abstract class Flag<T>
extends Object

A flag carries extra data on a region.

Constructor Summary

Constructors

Constructor and Description
Flag(String name) Create a new flag with RegionGroup.ALL as the default group.
Flag(String name, RegionGroup defaultGroup) Create a new flag.

Method Summary

Modifier and Type	Method and Description
T	chooseValue(Collection<T> values)
T	getDefault() Get the default value.
String	getName() Get the name of the flag.
RegionGroupFlag	getRegionGroupFlag() Get the region group flag.
boolean	hasConflictStrategy() Whether the flag can take a list of values and choose a "best one."
boolean	implicitlySetWithMembership() Whether the flag implicitly has a value set as long as DefaultFlag.PASSTHROUGH is not set.
abstract Object	marshal(T o) Convert the value stored for this flag into a type that can be serialized into YAML.
abstract 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.
boolean	requiresSubject() Whether the flag requires that a subject is specified in FlagValueCalculator.
String	toString()
abstract T	unmarshal(Object o) Convert a raw type that was loaded (from a YAML file, for example) into the type that this flag uses.
boolean	usesMembershipAsDefault() Whether, if the flag is not set at all, the value should be derived from membership.

Methods inherited from class java.lang.Object

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

Constructor Detail

Flag

public Flag(String name,
            @Nullable
            RegionGroup defaultGroup)

Create a new flag.

Parameters:

name - The name of the flag

defaultGroup - The default group

Flag

public Flag(String name)

Create a new flag with RegionGroup.ALL as the default group.

Parameters:

name - The name of the flag

Method Detail

getName

public String getName()

Get the name of the flag.

Returns:

The name of the flag

getDefault

@Nullable
public T getDefault()

Get the default value.

Returns:

The default value, if one exists, otherwise null may be returned

chooseValue

@Nullable
public T chooseValue(Collection<T> values)

hasConflictStrategy

public boolean hasConflictStrategy()

Whether the flag can take a list of values and choose a "best one."

This is the case with the StateFlag where DENY overrides ALLOW, but most flags just return the first result from a list.

This flag is primarily used to optimize flag lookup in FlagValueCalculator.

Returns:

Whether a best value can be chosen

implicitlySetWithMembership

public boolean implicitlySetWithMembership()

Whether the flag implicitly has a value set as long as DefaultFlag.PASSTHROUGH is not set.

This value is only changed, at least in WorldGuard, for the DefaultFlag.BUILD flag.

Returns:

Whether the flag is ignored

usesMembershipAsDefault

public boolean usesMembershipAsDefault()

Whether, if the flag is not set at all, the value should be derived from membership.

This value is only changed, at least in WorldGuard, for the DefaultFlag.BUILD flag.

Returns:

Whether membership is used

requiresSubject

public boolean requiresSubject()

Whether the flag requires that a subject is specified in FlagValueCalculator.

This value is only changed, at least in WorldGuard, for the DefaultFlag.BUILD flag.

Returns:

Whether a subject is required

getRegionGroupFlag

public RegionGroupFlag getRegionGroupFlag()

Get the region group flag.

Every group has a region group flag except for region group flags themselves.

Returns:

The region group flag

parseInput

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

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

Parameters:

plugin - The plugin

sender - The sender

input - THe input

Returns:

The coerced type

Throws:

InvalidFlagFormat - Raised if the input is invalid

unmarshal

public abstract T unmarshal(@Nullable
                            Object o)

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

Parameters:

o - The object

Returns:

The unmarshalled type

marshal

public abstract Object marshal(T o)

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

Parameters:

o - The object

Returns:

The marshalled type

toString

public String toString()

Overrides:

toString in class Object