com.sk89q.worldguard.protection

Class AbstractRegionSet

java.lang.Object

com.sk89q.worldguard.protection.AbstractRegionSet

All Implemented Interfaces:

ApplicableRegionSet, Iterable<ProtectedRegion>

Direct Known Subclasses:

FailedLoadRegionSet, PermissiveRegionSet, RegionResultSet

public abstract class AbstractRegionSet
extends Object
implements ApplicableRegionSet

Constructor Summary

Constructors

Constructor and Description
AbstractRegionSet()

Method Summary

Modifier and Type	Method and Description
boolean	allows(StateFlag flag) Deprecated.
boolean	allows(StateFlag flag, LocalPlayer player) Deprecated.
boolean	canBuild(LocalPlayer player) Deprecated.
boolean	canConstruct(LocalPlayer player) Deprecated.
<T extends Flag<V>,V> V	getFlag(T flag) Deprecated.
<T extends Flag<V>,V> V	getFlag(T flag, LocalPlayer groupPlayer) Deprecated.
StateFlag.State	queryState(RegionAssociable subject, StateFlag... flags) Get the (effective) value for a list of state flags.
boolean	testState(RegionAssociable subject, StateFlag... flags) Test whether the (effective) value for a list of state flags equals ALLOW.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldguard.protection.ApplicableRegionSet

getRegions, isMemberOfAll, isOwnerOfAll, isVirtual, queryAllValues, queryValue, size

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

AbstractRegionSet

public AbstractRegionSet()

Method Detail

canBuild

@Deprecated
public boolean canBuild(LocalPlayer player)

Deprecated.

Description copied from interface: ApplicableRegionSet

Tests whether the DefaultFlag.BUILD flag or membership requirements permit the given player.

Specified by:

canBuild in interface ApplicableRegionSet

Parameters:

player - the player to check

Returns:

true if permitted

canConstruct

@Deprecated
public boolean canConstruct(LocalPlayer player)

Deprecated.

Description copied from interface: ApplicableRegionSet

Test whether the construct flag evaluates true for the given player.

Specified by:

canConstruct in interface ApplicableRegionSet

Parameters:

player - the player

Returns:

true if true

testState

public boolean testState(@Nullable
                         RegionAssociable subject,
                         StateFlag... flags)

Description copied from interface: ApplicableRegionSet

Test whether the (effective) value for a list of state flags equals ALLOW.

subject can be non-null to satisfy region group requirements, otherwise it will be assumed that the caller that is not a member of any regions. (Flags on a region can be changed so that they only apply to certain users.) The subject argument is required if the DefaultFlag.BUILD flag is in the list of flags.

Specified by:

testState in interface ApplicableRegionSet

Parameters:

subject - an optional subject, which would be used to determine the region groups that apply

flags - a list of flags to check

Returns:

true if the result was ALLOW

See Also:

ApplicableRegionSet.queryState(RegionAssociable, StateFlag...)

queryState

@Nullable
public StateFlag.State queryState(@Nullable
                                            RegionAssociable subject,
                                            StateFlag... flags)

Description copied from interface: ApplicableRegionSet

Get the (effective) value for a list of state flags. The rules of states is observed here; that is, DENY overrides ALLOW, and ALLOW overrides NONE. One flag may override another.

subject can be non-null to satisfy region group requirements, otherwise it will be assumed that the caller that is not a member of any regions. (Flags on a region can be changed so that they only apply to certain users.) The subject argument is required if the DefaultFlag.BUILD flag is in the list of flags.

Specified by:

queryState in interface ApplicableRegionSet

Parameters:

subject - an optional subject, which would be used to determine the region groups that apply

flags - a list of flags to check

Returns:

a state

allows

@Deprecated
public boolean allows(StateFlag flag)

Deprecated.

Description copied from interface: ApplicableRegionSet

Gets the state of a state flag. This cannot be used for the build flag.

Specified by:

allows in interface ApplicableRegionSet

Parameters:

flag - flag to check

Returns:

whether it is allowed

allows

@Deprecated
public boolean allows(StateFlag flag,
                                  @Nullable
                                  LocalPlayer player)

Deprecated.

Description copied from interface: ApplicableRegionSet

Gets the state of a state flag. This cannot be used for the build flag.

Specified by:

allows in interface ApplicableRegionSet

Parameters:

flag - flag to check

player - player (used by some flags)

Returns:

whether the state is allows for it

getFlag

@Deprecated
 @Nullable
public <T extends Flag<V>,V> V getFlag(T flag,
                                                              @Nullable
                                                              LocalPlayer groupPlayer)

Deprecated.

Description copied from interface: ApplicableRegionSet

Gets the value of a flag. Do not use this for state flags (use ApplicableRegionSet.allows(StateFlag, LocalPlayer) for that).

Specified by:

getFlag in interface ApplicableRegionSet

Parameters:

flag - flag to check

groupPlayer - player to check RegionGroups against

Returns:

value of the flag, which may be null

getFlag

@Deprecated
 @Nullable
public <T extends Flag<V>,V> V getFlag(T flag)

Deprecated.

Description copied from interface: ApplicableRegionSet

Gets the value of a flag. Do not use this for state flags (use ApplicableRegionSet.allows(StateFlag, LocalPlayer) for that).

Specified by:

getFlag in interface ApplicableRegionSet

Parameters:

flag - the flag to check

Returns:

value of the flag, which may be null