com.sk89q.worldguard.protection.flags

Class CommandStringFlag

java.lang.Object

com.sk89q.worldguard.protection.flags.Flag<java.lang.String>

com.sk89q.worldguard.protection.flags.CommandStringFlag

public class CommandStringFlag
extends Flag<java.lang.String>

Stores a command/

Constructor Summary

Constructors

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

Method Summary

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

CommandStringFlag

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

CommandStringFlag

public CommandStringFlag(java.lang.String name)

Method Detail

parseInput

public java.lang.String 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.lang.String>

Parameters:

context - the FlagContext

Returns:

The coerced type

Throws:

InvalidFlagFormat - Raised if the input is invalid

unmarshal

public java.lang.String 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<java.lang.String>

Parameters:

o - The object

Returns:

The unmarshalled type

marshal

public java.lang.Object marshal(java.lang.String 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.lang.String>

Parameters:

o - The object

Returns:

The marshalled type