com.sk89q.worldguard.protection.flags

Class LocationFlag

java.lang.Object

com.sk89q.worldguard.protection.flags.Flag<com.sk89q.worldedit.util.Location>

com.sk89q.worldguard.protection.flags.LocationFlag

public class LocationFlag
extends Flag<com.sk89q.worldedit.util.Location>

Constructor Summary

Constructors

Constructor and Description
LocationFlag(java.lang.String name)
LocationFlag(java.lang.String name, RegionGroup defaultGroup)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	marshal(com.sk89q.worldedit.util.Location o) Convert the value stored for this flag into a type that can be serialized into YAML.
com.sk89q.worldedit.util.Location	parseInput(FlagContext context) Parse a given input to coerce it to a type compatible with the flag.
com.sk89q.worldedit.util.Location	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

LocationFlag

public LocationFlag(java.lang.String name,
                    RegionGroup defaultGroup)

LocationFlag

public LocationFlag(java.lang.String name)

Method Detail

parseInput

public com.sk89q.worldedit.util.Location 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<com.sk89q.worldedit.util.Location>

Parameters:

context - the FlagContext

Returns:

The coerced type

Throws:

InvalidFlagFormat - Raised if the input is invalid

unmarshal

public com.sk89q.worldedit.util.Location unmarshal(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<com.sk89q.worldedit.util.Location>

Parameters:

o - The object

Returns:

The unmarshalled type

marshal

public java.lang.Object marshal(com.sk89q.worldedit.util.Location 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<com.sk89q.worldedit.util.Location>

Parameters:

o - The object

Returns:

The marshalled type