com.sk89q.worldguard.protection.flags

Class MapFlag<K,V>

java.lang.Object

com.sk89q.worldguard.protection.flags.Flag<java.util.Map<K,V>>

com.sk89q.worldguard.protection.flags.MapFlag<K,V>

public class MapFlag<K,V>
extends Flag<java.util.Map<K,V>>

Stores a key value map of typed Flags.

Constructor Summary

Constructors

Constructor and Description
MapFlag(java.lang.String name, Flag<K> keyFlag, Flag<V> valueFlag)
MapFlag(java.lang.String name, RegionGroup defaultGroup, Flag<K> keyFlag, Flag<V> valueFlag)

Method Summary

Modifier and Type	Method and Description
Flag<K>	getKeyFlag() Get the flag that is stored as the key flag type.
Flag<V>	getValueFlag() Get the flag type that is stored as values.
java.lang.Object	marshal(java.util.Map<K,V> o) Convert the value stored for this flag into a type that can be serialized into YAML.
java.util.Map<K,V>	parseInput(FlagContext context) Parse a given input to coerce it to a type compatible with the flag.
java.util.Map<K,V>	unmarshal(java.lang.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, isValidName, requiresSubject, toString, usesMembershipAsDefault

Methods inherited from class java.lang.Object

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

Constructor Detail

MapFlag

public MapFlag(java.lang.String name,
               Flag<K> keyFlag,
               Flag<V> valueFlag)

MapFlag

public MapFlag(java.lang.String name,
               @Nullable
               RegionGroup defaultGroup,
               Flag<K> keyFlag,
               Flag<V> valueFlag)

Method Detail

getKeyFlag

public Flag<K> getKeyFlag()

Get the flag that is stored as the key flag type.

Returns:

The key flag type.

getValueFlag

public Flag<V> getValueFlag()

Get the flag type that is stored as values.

Returns:

The value flag type.

parseInput

public java.util.Map<K,V> parseInput(FlagContext context)
                              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<java.util.Map<K,V>>

Parameters:

context - the FlagContext

Returns:

The coerced type

Throws:

InvalidFlagFormat - Raised if the input is invalid

unmarshal

public java.util.Map<K,V> unmarshal(@Nullable
                                    java.lang.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<java.util.Map<K,V>>

Parameters:

o - The object

Returns:

The unmarshalled type

marshal

public java.lang.Object marshal(java.util.Map<K,V> 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<java.util.Map<K,V>>

Parameters:

o - The object

Returns:

The marshalled type