Class StringFlag

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

public class StringFlag extends Flag<String>
Stores a string.
  • Constructor Details

  • Method Details

    • getDefault

      @Nullable public String getDefault()
      Description copied from class: Flag
      Get the default value.
      Overrides:
      getDefault in class Flag<String>
      Returns:
      The default value, if one exists, otherwise null may be returned
    • parseInput

      public 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<String>
      Parameters:
      context - the FlagContext
      Returns:
      The coerced type
      Throws:
      InvalidFlagFormat - Raised if the input is invalid
    • unmarshal

      public String unmarshal(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<String>
      Parameters:
      o - The object
      Returns:
      The unmarshalled type
    • marshal

      public Object marshal(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<String>
      Parameters:
      o - The object
      Returns:
      The marshalled type