com.sk89q.worldguard.protection.managers.storage.file

Class DirectoryYamlDriver

java.lang.Object

com.sk89q.worldguard.protection.managers.storage.file.DirectoryYamlDriver

All Implemented Interfaces:

RegionDriver

public class DirectoryYamlDriver
extends java.lang.Object
implements RegionDriver

Stores region data in a {root_dir}/{id}/{filename} pattern on disk using YamlRegionFile.

Constructor Summary

Constructors

Constructor and Description
DirectoryYamlDriver(java.io.File rootDir, java.lang.String filename) Create a new instance.

Method Summary

Modifier and Type	Method and Description
RegionDatabase	get(java.lang.String id) Get a region database for a world.
java.util.List<RegionDatabase>	getAll() Fetch all the region databases that have been stored using this driver.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryYamlDriver

public DirectoryYamlDriver(java.io.File rootDir,
                           java.lang.String filename)

Create a new instance.

Parameters:

rootDir - the directory where the world folders reside

filename - the filename (i.e. "regions.yml")

Method Detail

get

public RegionDatabase get(java.lang.String id)

Description copied from interface: RegionDriver

Get a region database for a world.

The given name should be a unique name for the world. Due to legacy reasons, there are no stipulations on the case sensitivity of the name. Historically, however, if the driver is a file-based driver, case-sensitivity will vary on whether the underlying filesystem is case-sensitive.

This method should return quickly.

Specified by:

get in interface RegionDriver

Parameters:

id - the name of the world, which may be case sensitive

Returns:

the world

getAll

public java.util.List<RegionDatabase> getAll()
                                      throws StorageException

Description copied from interface: RegionDriver

Fetch all the region databases that have been stored using this driver. Essentially, return a region database for all worlds that have had regions saved for it in the past.

As this may require a query to be performed, this method may block for a prolonged period of time.

Specified by:

getAll in interface RegionDriver

Returns:

a list of databases

Throws:

StorageException - thrown if the fetch operation fails