com.sk89q.worldguard.protection

Class PermissiveRegionSet

java.lang.Object

com.sk89q.worldguard.protection.AbstractRegionSet

com.sk89q.worldguard.protection.PermissiveRegionSet

All Implemented Interfaces:

ApplicableRegionSet, java.lang.Iterable<ProtectedRegion>

public class PermissiveRegionSet
extends AbstractRegionSet

A virtual region result set that is highly permissive, considering everyone a member. Returned flag values are default values (when available).

Method Summary

Modifier and Type	Method and Description
static PermissiveRegionSet	getInstance() Get an instance.
java.util.Set<ProtectedRegion>	getRegions() Get an immutable set of regions that are included in this set.
boolean	isMemberOfAll(LocalPlayer player) Test whether a player is an owner or member of all regions in this set.
boolean	isOwnerOfAll(LocalPlayer player) Test whether a player is an owner of all regions in this set.
boolean	isVirtual() Return whether this region set is a virtual set.
java.util.Iterator<ProtectedRegion>	iterator()
<V> java.util.Collection<V>	queryAllValues(RegionAssociable subject, Flag<V> flag) Get the effective values for a flag, returning a collection of all values.
<V> V	queryValue(RegionAssociable subject, Flag<V> flag) Get the effective value for a flag.
int	size() Get the number of regions that are included.

Methods inherited from class com.sk89q.worldguard.protection.AbstractRegionSet

queryState, testState

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

Method Detail

isVirtual

public boolean isVirtual()

Description copied from interface: ApplicableRegionSet

Return whether this region set is a virtual set. A virtual set does not contain real results.

A virtual result may be returned if region data failed to load or there was some special exception (i.e. the region bypass permission).

Be sure to check the value of this flag if an instance of this interface is being retrieved from RegionQuery as it may return an instance of PermissiveRegionSet or FailedLoadRegionSet, among other possibilities.

Returns:

true if loaded

See Also:

FailedLoadRegionSet

queryValue

@Nullable
public <V> V queryValue(@Nullable
                                   RegionAssociable subject,
                                   Flag<V> flag)

Description copied from interface: ApplicableRegionSet

Get the effective value for a flag. If there are multiple values (for example, multiple overlapping regions with the same priority may have the same flag set), then the selected (or "winning") value will depend on the flag type.

Only some flag types actually have a strategy for picking the "best value." For most types, the actual value that is chosen to be returned is undefined (it could be any value). As of writing, the only type of flag that actually has a strategy for picking a value is the StateFlag.

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. (FlagUtil on a region can be changed so that they only apply to certain users.) The subject argument is required if the Flags.BUILD flag is the flag being queried.

Parameters:

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

flag - the flag

Returns:

a value, which could be null

queryAllValues

public <V> java.util.Collection<V> queryAllValues(@Nullable
                                                  RegionAssociable subject,
                                                  Flag<V> flag)

Description copied from interface: ApplicableRegionSet

Get the effective values for a flag, returning a collection of all values. It is up to the caller to determine which value, if any, from the collection will be used.

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. (FlagUtil on a region can be changed so that they only apply to certain users.) The subject argument is required if the Flags.BUILD flag is the flag being queried.

Parameters:

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

flag - the flag

Returns:

a collection of values

isOwnerOfAll

public boolean isOwnerOfAll(LocalPlayer player)

Description copied from interface: ApplicableRegionSet

Test whether a player is an owner of all regions in this set.

Parameters:

player - the player

Returns:

whether the player is an owner of all regions

isMemberOfAll

public boolean isMemberOfAll(LocalPlayer player)

Description copied from interface: ApplicableRegionSet

Test whether a player is an owner or member of all regions in this set.

Parameters:

player - the player

Returns:

whether the player is a member of all regions

size

public int size()

Description copied from interface: ApplicableRegionSet

Get the number of regions that are included.

Returns:

the number of contained regions

getRegions

public java.util.Set<ProtectedRegion> getRegions()

Description copied from interface: ApplicableRegionSet

Get an immutable set of regions that are included in this set.

Returns:

a set of regions

iterator

public java.util.Iterator<ProtectedRegion> iterator()

getInstance

public static PermissiveRegionSet getInstance()

Get an instance.

Returns:

an instance