com.sk89q.worldguard.protection.flags.registry

Class SimpleFlagRegistry

java.lang.Object

com.sk89q.worldguard.protection.flags.registry.SimpleFlagRegistry

All Implemented Interfaces:

FlagRegistry, java.lang.Iterable<Flag<?>>

public class SimpleFlagRegistry
extends java.lang.Object
implements FlagRegistry

Constructor Summary

Constructors

Constructor and Description
SimpleFlagRegistry()

Method Summary

Modifier and Type	Method and Description
Flag<?>	get(java.lang.String name) Get af flag by its name.
java.util.List<Flag<?>>	getAll() Get all flags
boolean	isInitialized()
java.util.Iterator<Flag<?>>	iterator()
void	register(Flag<?> flag) Register a new flag.
void	registerAll(java.util.Collection<Flag<?>> flags) Register a collection of flags.
void	setInitialized(boolean initialized)
int	size() Get the number of registered flags.
java.util.Map<Flag<?>,java.lang.Object>	unmarshal(java.util.Map<java.lang.String,java.lang.Object> rawValues, boolean createUnknown) Unmarshal a raw map of values into a map of flags with their unmarshalled values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SimpleFlagRegistry

public SimpleFlagRegistry()

Method Detail

isInitialized

public boolean isInitialized()

setInitialized

public void setInitialized(boolean initialized)

register

public void register(Flag<?> flag)
              throws FlagConflictException

Description copied from interface: FlagRegistry

Register a new flag.

There may be an appropriate time to register flags. If flags are registered outside this time, then an exception may be thrown.

Specified by:

register in interface FlagRegistry

Parameters:

flag - The flag

Throws:

FlagConflictException - Thrown when an existing flag exists with the same name

registerAll

public void registerAll(java.util.Collection<Flag<?>> flags)

Description copied from interface: FlagRegistry

Register a collection of flags.

There may be an appropriate time to register flags. If flags are registered outside this time, then an exception may be thrown.

If there is a flag conflict, then an error will be logged but no exception will be thrown.

Specified by:

registerAll in interface FlagRegistry

Parameters:

flags - a collection of flags

get

@Nullable
public Flag<?> get(java.lang.String name)

Description copied from interface: FlagRegistry

Get af flag by its name.

Specified by:

get in interface FlagRegistry

Parameters:

name - The name

Returns:

The flag, if it has been registered

getAll

public java.util.List<Flag<?>> getAll()

Description copied from interface: FlagRegistry

Get all flags

Specified by:

getAll in interface FlagRegistry

Returns:

All flags

unmarshal

public java.util.Map<Flag<?>,java.lang.Object> unmarshal(java.util.Map<java.lang.String,java.lang.Object> rawValues,
                                                         boolean createUnknown)

Description copied from interface: FlagRegistry

Unmarshal a raw map of values into a map of flags with their unmarshalled values.

Specified by:

unmarshal in interface FlagRegistry

Parameters:

rawValues - The raw values map

createUnknown - Whether "just in time" flags should be created for unknown flags

Returns:

The unmarshalled flag values map

size

public int size()

Description copied from interface: FlagRegistry

Get the number of registered flags.

Specified by:

size in interface FlagRegistry

Returns:

The number of registered flags

iterator

public java.util.Iterator<Flag<?>> iterator()

Specified by:

iterator in interface java.lang.Iterable<Flag<?>>