RegionResultSet (worldguard-core 7.0.4-SNAPSHOT API)

java.lang.Object
- com.sk89q.worldguard.protection.AbstractRegionSet
- - com.sk89q.worldguard.protection.RegionResultSet

All Implemented Interfaces:

ApplicableRegionSet, java.lang.Iterable<ProtectedRegion>
```
public class RegionResultSet
extends AbstractRegionSet
```
An implementation that calculates flags using a list of regions.

Constructor Summary

Constructors
Constructor and Description
`RegionResultSet(java.util.List<ProtectedRegion> applicable, ProtectedRegion globalRegion)` Create a new region result set.
`RegionResultSet(java.util.List<ProtectedRegion> applicable, ProtectedRegion globalRegion, boolean sorted)` Create a new region result set.
`RegionResultSet(java.util.Set<ProtectedRegion> applicable, ProtectedRegion globalRegion)` Create a new region result set.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RegionResultSet`	`fromSortedList(java.util.List<ProtectedRegion> regions, ProtectedRegion globalRegion)` Create a new instance using a list of regions that is known to already be sorted by priority descending.
`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.
`StateFlag.State`	`queryState(RegionAssociable subject, StateFlag... flags)` Get the (effective) value for a list of state flags.
`<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
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

- Constructor Detail
  - RegionResultSet
```
public RegionResultSet(java.util.List<ProtectedRegion> applicable,
                       @Nullable
                       ProtectedRegion globalRegion)
```
    Create a new region result set.
    The given list must not contain duplicates or the behavior of this instance will be undefined.
    
    Parameters:
    
    applicable - the regions contained in this set
    
    globalRegion - the global region, set aside for special handling.
  - RegionResultSet
```
public RegionResultSet(java.util.Set<ProtectedRegion> applicable,
                       @Nullable
                       ProtectedRegion globalRegion)
```
    Create a new region result set.
    
    Parameters:
    
    applicable - the regions contained in this set
    
    globalRegion - the global region, set aside for special handling.
  - RegionResultSet
```
public RegionResultSet(java.util.List<ProtectedRegion> applicable,
                       @Nullable
                       ProtectedRegion globalRegion,
                       boolean sorted)
```
    Create a new region result set.
    The list of regions may be first sorted with NormativeOrders. If that is the case, sorted should be true. Otherwise, the list will be sorted in-place.
    
    Parameters:
    
    applicable - the regions contained in this set
    
    globalRegion - the global region, set aside for special handling.
    
    sorted - true if the list is already sorted with NormativeOrders
- 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
  - 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 Flags.BUILD flag is in the list of flags.
    
    Specified by:
    
    queryState in interface ApplicableRegionSet
    
    Overrides:
    
    queryState in class AbstractRegionSet
    
    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
  - 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. (Flags 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. (Flags 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()
```
  - fromSortedList
```
public static RegionResultSet fromSortedList(java.util.List<ProtectedRegion> regions,
                                             @Nullable
                                             ProtectedRegion globalRegion)
```
    Create a new instance using a list of regions that is known to already be sorted by priority descending.
    
    Parameters:
    
    regions - a list of regions
    
    globalRegion - a global region
    
    Returns:
    
    an instance

Class RegionResultSet

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

RegionResultSet

RegionResultSet

RegionResultSet

Method Detail

isVirtual

queryState

queryValue

queryAllValues

isOwnerOfAll

isMemberOfAll

size

getRegions

iterator

fromSortedList