com.sk89q.worldguard.protection.managers

Class RegionManager

java.lang.Object

com.sk89q.worldguard.protection.managers.RegionManager

public final class RegionManager
extends Object

A region manager holds the regions for a world.

Constructor Summary

Constructors

Constructor and Description
RegionManager(RegionDatabase store, com.google.common.base.Supplier<? extends ConcurrentRegionIndex> indexFactory) Create a new index.

Method Summary

Modifier and Type	Method and Description
void	addRegion(ProtectedRegion region) Aad a region to the manager.
ApplicableRegionSet	getApplicableRegions(org.bukkit.Location loc) Helper method for getApplicableRegions(Vector) using Bukkit locations.
ApplicableRegionSet	getApplicableRegions(ProtectedRegion region) Query for effective flags and owners for the area represented by the given region.
ApplicableRegionSet	getApplicableRegions(com.sk89q.worldedit.Vector position) Query for effective flags and owners for the given positive.
List<String>	getApplicableRegionsIDs(com.sk89q.worldedit.Vector position) Get a list of region names for regions that contain the given position.
String	getName() Get a displayable name for this store.
ProtectedRegion	getRegion(String id) Get the region named by the given name (equality determined using Normal).
int	getRegionCountOfPlayer(LocalPlayer player) Get the number of regions that are owned by the given player.
Map<String,ProtectedRegion>	getRegions() Get an unmodifiable map of regions containing the state of the index at the time of call.
boolean	hasRegion(String id) Return whether the index contains a region by the given name, with equality determined by Normal.
void	load() Load regions from storage and replace the index on this manager with the regions loaded from the store.
void	loadChunk(com.sk89q.worldedit.Vector2D position) Load the regions for a chunk.
void	loadChunks(Collection<com.sk89q.worldedit.Vector2D> positions) Load the regions for a chunk.
ProtectedRegion	matchRegion(String pattern) Matches a region using either the pattern #{region_index} or simply by the exact name of the region.
boolean	overlapsUnownedRegion(ProtectedRegion region, LocalPlayer player) Return whether there are any regions intersecting the given region that are not owned by the given player.
Set<ProtectedRegion>	removeRegion(String id) Remove a region from the index with the given name, opting to remove the children of the removed region.
Set<ProtectedRegion>	removeRegion(String id, RemovalStrategy strategy) Remove a region from the index with the given name.
void	save() Save a snapshot of all the regions as it is right now to storage.
boolean	saveChanges() Save changes to the region index to disk, preferring to only save the changes (rather than the whole index), but choosing to save the whole index if the underlying store does not support partial saves.
void	setRegions(Collection<ProtectedRegion> regions) Replace the index with the regions in the given collection.
void	setRegions(Map<String,ProtectedRegion> regions) Replace the index with the regions in the given map.
int	size() Get the number of regions.
void	unloadChunk(com.sk89q.worldedit.Vector2D position) Unload the regions for a chunk.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionManager

public RegionManager(RegionDatabase store,
                     com.google.common.base.Supplier<? extends ConcurrentRegionIndex> indexFactory)

Create a new index.

Parameters:

store - the region store

indexFactory - the factory for creating new instances of the index

Method Detail

getName

public String getName()

Get a displayable name for this store.

load

public void load()
          throws StorageException

Load regions from storage and replace the index on this manager with the regions loaded from the store.

This method will block until the save completes, but it will not block access to the region data from other threads, nor will it prevent the creation or modification of regions in the index while a new collection of regions is loaded from storage.

Throws:

StorageException - thrown when loading fails

save

public void save()
          throws StorageException

Save a snapshot of all the regions as it is right now to storage.

Throws:

StorageException - thrown on save error

saveChanges

public boolean saveChanges()
                    throws StorageException

Save changes to the region index to disk, preferring to only save the changes (rather than the whole index), but choosing to save the whole index if the underlying store does not support partial saves.

This method does nothing if there are no changes.

Returns:

true if there were changes to be saved

Throws:

StorageException - thrown on save error

loadChunk

public void loadChunk(com.sk89q.worldedit.Vector2D position)

Load the regions for a chunk.

Parameters:

position - the position

loadChunks

public void loadChunks(Collection<com.sk89q.worldedit.Vector2D> positions)

Load the regions for a chunk.

Parameters:

positions - a collection of positions

unloadChunk

public void unloadChunk(com.sk89q.worldedit.Vector2D position)

Unload the regions for a chunk.

Parameters:

position - the position

getRegions

public Map<String,ProtectedRegion> getRegions()

Get an unmodifiable map of regions containing the state of the index at the time of call.

This call is relatively heavy (and may block other threads), so refrain from calling it frequently.

Returns:

a map of regions

setRegions

public void setRegions(Map<String,ProtectedRegion> regions)

Replace the index with the regions in the given map.

The parents of the regions will also be added to the index, even if they are not in the provided map.

Parameters:

regions - a map of regions

setRegions

public void setRegions(Collection<ProtectedRegion> regions)

Replace the index with the regions in the given collection.

The parents of the regions will also be added to the index, even if they are not in the provided map.

Parameters:

regions - a collection of regions

addRegion

public void addRegion(ProtectedRegion region)

Aad a region to the manager.

The parents of the region will also be added to the index.

Parameters:

region - the region

hasRegion

public boolean hasRegion(String id)

Return whether the index contains a region by the given name, with equality determined by Normal.

Parameters:

id - the name of the region

Returns:

true if this index contains the region

getRegion

@Nullable
public ProtectedRegion getRegion(String id)

Get the region named by the given name (equality determined using Normal).

Parameters:

id - the name of the region

Returns:

a region or null

matchRegion

@Nullable
public ProtectedRegion matchRegion(String pattern)

Matches a region using either the pattern #{region_index} or simply by the exact name of the region.

Parameters:

pattern - the pattern

Returns:

a region

removeRegion

@Nullable
public Set<ProtectedRegion> removeRegion(String id)

Remove a region from the index with the given name, opting to remove the children of the removed region.

Parameters:

id - the name of the region

Returns:

a list of removed regions where the first entry is the region specified by id

removeRegion

@Nullable
public Set<ProtectedRegion> removeRegion(String id,
                                                   RemovalStrategy strategy)

Remove a region from the index with the given name.

Parameters:

id - the name of the region

strategy - what to do with children

Returns:

a list of removed regions where the first entry is the region specified by id

getApplicableRegions

public ApplicableRegionSet getApplicableRegions(com.sk89q.worldedit.Vector position)

Query for effective flags and owners for the given positive.

Parameters:

position - the position

Returns:

the query object

getApplicableRegions

public ApplicableRegionSet getApplicableRegions(ProtectedRegion region)

Query for effective flags and owners for the area represented by the given region.

Parameters:

region - the region

Returns:

the query object

getApplicableRegionsIDs

public List<String> getApplicableRegionsIDs(com.sk89q.worldedit.Vector position)

Get a list of region names for regions that contain the given position.

Parameters:

position - the position

Returns:

a list of names

overlapsUnownedRegion

public boolean overlapsUnownedRegion(ProtectedRegion region,
                                     LocalPlayer player)

Return whether there are any regions intersecting the given region that are not owned by the given player.

Parameters:

region - the region

player - the player

Returns:

true if there are such intersecting regions

size

public int size()

Get the number of regions.

Returns:

the number of regions

getRegionCountOfPlayer

public int getRegionCountOfPlayer(LocalPlayer player)

Get the number of regions that are owned by the given player.

Parameters:

player - the player

Returns:

name number of regions that a player owns

getApplicableRegions

public ApplicableRegionSet getApplicableRegions(org.bukkit.Location loc)

Helper method for getApplicableRegions(Vector) using Bukkit locations.

Parameters:

loc - the location

Returns:

an ApplicableRegionSet