SetFlag (worldguard-core 7.0.9 API)

java.lang.Object

com.sk89q.worldguard.protection.flags.Flag<Set<T>>

com.sk89q.worldguard.protection.flags.SetFlag<T>

public class SetFlag<T> extends Flag<Set<T>>

Stores a set of types.

Constructor Summary

Constructors

Constructor

Description

SetFlag(String name, Flag<T> subFlag)

SetFlag(String name, RegionGroup defaultGroup, Flag<T> subFlag)
Method Summary

Modifier and Type

Method

Description

Flag<T>

getType()

Get the flag that is stored in this flag.

Object

marshal(Set<T> o)

Convert the value stored for this flag into a type that can be serialized into YAML.

Set<T>

parseInput(FlagContext context)

Parse a given input to coerce it to a type compatible with the flag.

Set<T>

unmarshal(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 Details
- SetFlag
  
  public SetFlag(String name, RegionGroup defaultGroup, Flag<T> subFlag)
- SetFlag
  
  public SetFlag(String name, Flag<T> subFlag)
Method Details
- getType
  
  public Flag<T> getType()
  
  Get the flag that is stored in this flag.
  
  Returns:
  
  the stored flag type
- parseInput
  
  public Set<T> 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<Set<T>>
  
  Parameters:
  
  context - the FlagContext
  
  Returns:
  
  The coerced type
  
  Throws:
  
  InvalidFlagFormat - Raised if the input is invalid
- unmarshal
  
  public Set<T> 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<Set<T>>
  
  Parameters:
  
  o - The object
  
  Returns:
  
  The unmarshalled type
- marshal
  
  public Object marshal(Set<T> 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<Set<T>>
  
  Parameters:
  
  o - The object
  
  Returns:
  
  The marshalled type