Package com.earth2me.essentials.api

Interface IJails

All Superinterfaces:
IConf
All Known Subinterfaces:
IJails
All Known Implementing Classes:
Jails
@Deprecated public interface IJails extends IConf
Deprecated.
External plugins should use IJails instead of this interface in case future APIs are added.
Provides access to the storage of jail locations. Maintainers should add methods to this interface.

  • Method Details

    • getJail

      Location getJail(String jailName) throws Exception
      Deprecated.
      Gets the location of the jail with the given name
      Parameters:
      jailName - The name of the jail
      Returns:
      the location of the jail
      Throws:
      Exception - if the jail does not exist

    • getList

      Collection<String> getList() throws Exception
      Deprecated.
      Gets a list of jails by names
      Returns:
      a list of jails, if there are none the list will be empty
      Throws:
      Exception

    • getCount

      int getCount()
      Deprecated.
      Gets the number of jails
      Returns:
      the size of the list of jails

    • removeJail

      void removeJail(String jail) throws Exception
      Deprecated.
      Remove the jail with the given name
      Parameters:
      jail - the jail to remove
      Throws:
      Exception - if the jail does not exist

    • sendToJail

      @Deprecated void sendToJail(IUser user, String jail) throws Exception
      Deprecated.
      Use sendToJail(IUser, String, CompletableFuture)
      Attempts to send the given user to the given jail
      Parameters:
      user - the user to send to jail
      jail - the jail to send the user to
      Throws:
      Exception - if the user is offline or jail does not exist

    • sendToJail

      void sendToJail(IUser user, String jail, CompletableFuture<Boolean> future) throws Exception
      Deprecated.
      Attempts to send the given user to the given jail
      Parameters:
      user - the user to send to jail
      jail - the jail to send the user to
      future - Future which is completed with the success status of the execution
      Throws:
      Exception - if the user is offline or jail does not exist

    • setJail

      void setJail(String jailName, Location loc) throws Exception
      Deprecated.
      Set a new jail with the given name and location
      Parameters:
      jailName - the name of the jail being set
      loc - the location of the jail being set
      Throws:
      Exception

    • startTransaction

      void startTransaction()
      Deprecated.
      Begins a transaction

    • stopTransaction

      void stopTransaction(boolean blocking)
      Deprecated.
      Ends the current transaction and saves the state