minecraft/Essentials
1
0
Fork 0
mirror of https://github.com/essentials/Essentials.git synced 2025-10-01 08:36:48 +02:00
Code Issues Releases Wiki Activity

API & misc cleanup

Browse Source
This commit is contained in:
Iaccidentally
2013-04-30 12:25:25 -04:00
parent 9b1fe33419
commit 648f78699c
7 changed files with 57 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
Essentials/src/com/earth2me/essentials/api/IJails.java
View File

@@ -6,15 +6,47 @@ import org.bukkit.Location;
public interface IJails extends IReload
{
/**
* Gets the location of the jail with the given name
* @param jailName The name of the jail
* @return the location of the jail
* @throws Exception if the jail does not exist
*/
Location getJail(String jailName) throws Exception;
/**
* Gets a list of jails by names
* @return a list of jails, if there are none the list will be empty
* @throws Exception
*/
Collection<String> getList() throws Exception;
/**
* Gets the number of jails
* @return the size of the list of jails
*/
int getCount();
/**
* Remove the jail with the given name
* @param jail the jail to remove
* @throws Exception if the jail does not exist
*/
void removeJail(String jail) throws Exception;
/**
* Attempts to send the given user to the given jail
* @param user the user to send to jail
* @param jail the jail to send the user to
* @throws Exception if the user is offline or jail does not exist
*/
void sendToJail(com.earth2me.essentials.IUser user, String jail) throws Exception;
/**
* Set a new jail with the given name and location
* @param jailName the name of the jail being set
* @param loc the location of the jail being set
* @throws Exception
*/
void setJail(String jailName, Location loc) throws Exception;
}