com.sk89q.worldguard.protection.flags

Class StringFlag

java.lang.Object

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

com.sk89q.worldguard.protection.flags.StringFlag

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

Stores a string.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefault() Get the default value.
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, 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

StringFlag

public StringFlag(java.lang.String name)

StringFlag

public StringFlag(java.lang.String name,
                  java.lang.String defaultValue)

StringFlag

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

StringFlag

public StringFlag(java.lang.String name,
                  RegionGroup defaultGroup,
                  java.lang.String defaultValue)

Method Detail

getDefault

@Nullable
public java.lang.String getDefault()

Description copied from class: Flag

Get the default value.

Overrides:

getDefault in class Flag<java.lang.String>

Returns:

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

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