Package com.earth2me.essentials.api
Interface IJails
- All Superinterfaces:
IConf
- All Known Subinterfaces:
IJails
- All Known Implementing Classes:
Jails
Deprecated.
Provides access to the storage of jail locations. Maintainers should add methods to this interface.
-
Method Summary
Modifier and TypeMethodDescriptionint
getCount()
Deprecated.Gets the number of jailsDeprecated.Gets the location of the jail with the given namegetList()
Deprecated.Gets a list of jails by namesvoid
removeJail
(String jail) Deprecated.Remove the jail with the given namevoid
sendToJail
(IUser user, String jail) Deprecated.void
sendToJail
(IUser user, String jail, CompletableFuture<Boolean> future) Deprecated.Attempts to send the given user to the given jailvoid
Deprecated.Set a new jail with the given name and locationvoid
Deprecated.Begins a transactionvoid
stopTransaction
(boolean blocking) Deprecated.Ends the current transaction and saves the stateMethods inherited from interface com.earth2me.essentials.IConf
reloadConfig
-
Method Details
-
getJail
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
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
Deprecated.Remove the jail with the given name- Parameters:
jail
- the jail to remove- Throws:
Exception
- if the jail does not exist
-
sendToJail
Deprecated.Attempts to send the given user to the given jail- Parameters:
user
- the user to send to jailjail
- the jail to send the user to- Throws:
Exception
- if the user is offline or jail does not exist
-
sendToJail
Deprecated.Attempts to send the given user to the given jail- Parameters:
user
- the user to send to jailjail
- the jail to send the user tofuture
- Future which is completed with the success status of the execution- Throws:
Exception
- if the user is offline or jail does not exist
-
setJail
Deprecated.Set a new jail with the given name and location- Parameters:
jailName
- the name of the jail being setloc
- 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
-
IJails
instead of this interface in case future APIs are added.