EpicKnarvik97/Jail
EpicKnarvik97/Jail
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Add some JavaDoc to the JailIO class.

Browse Source
This commit is contained in:
graywolf336 2013-12-16 12:26:38 -06:00
parent f03714a5f7
commit 677d006978
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/main/java/com/graywolf336/jail/JailIO.java
View File

@ -13,6 +13,14 @@ import com.graywolf336.jail.beans.Jail;
import com.graywolf336.jail.beans.Prisoner; import com.graywolf336.jail.beans.Prisoner;
import com.graywolf336.jail.beans.SimpleLocation; import com.graywolf336.jail.beans.SimpleLocation;
/**
* Handles all the saving and loading of the plugin's data.
*
* @author graywolf336
* @since 3.0.0
* @version 1.0.0
*
*/
public class JailIO { public class JailIO {
private JailMain pl; private JailMain pl;
private FileConfiguration flat; private FileConfiguration flat;
@ -31,6 +39,9 @@ public class JailIO {
} }
} }
/**
* Prepares the storage engine to be used.
*/
public void prepareStorage() { public void prepareStorage() {
switch(storage) { switch(storage) {
case 1: case 1:
@ -45,6 +56,9 @@ public class JailIO {
} }
} }
/**
* Loads the jails, this should <strong>only</strong> be called after {@link #prepareStorage()}.
*/
public void loadJails() { public void loadJails() {
switch(storage) { switch(storage) {
case 1: case 1:
@ -58,12 +72,9 @@ public class JailIO {
if(flat.isConfigurationSection("jails")) { if(flat.isConfigurationSection("jails")) {
Set<String> jails = flat.getConfigurationSection("jails").getKeys(false); Set<String> jails = flat.getConfigurationSection("jails").getKeys(false);
if(!jails.isEmpty()) { if(!jails.isEmpty()) {
pl.getLogger().info("Jails configuration section exists and there are " + jails.size() + ".");
for(String name : jails) { for(String name : jails) {
loadJail(name); loadJail(name);
} }
}else {
pl.getLogger().warning("Jails configuration section exists but no jails are there.");
} }
} }
break; break;
@ -73,6 +84,11 @@ public class JailIO {
pl.getLogger().info("Loaded " + s + (s == 1 ? " jail." : " jails.")); pl.getLogger().info("Loaded " + s + (s == 1 ? " jail." : " jails."));
} }
/**
* Saves the provided {@link Jail jail} to the storage system we are using.
*
* @param j The jail to save.
*/
public void saveJail(Jail j) { public void saveJail(Jail j) {
switch(storage) { switch(storage) {
case 1: case 1: