Package com.sk89q.worldguard.protection.managers.storage

Interface RegionDriver

All Known Implementing Classes:
DirectoryYamlDriver, SQLDriver
public interface RegionDriver
A driver manages RegionDatabases for several worlds. An instance can return instances of a database for any given world.
See Also:

  • Method Summary

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

  • Method Details

    • get

      RegionDatabase get(String name)
      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.

      Parameters:
      name - the name of the world, which may be case sensitive
      Returns:
      the world

    • getAll

      List<RegionDatabase> getAll() throws StorageException
      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.

      Returns:
      a list of databases
      Throws:
      StorageException - thrown if the fetch operation fails