+ *
* * Stores the following: *
* * If the provided prefix is empty, then we add all of the jails. * @@ -293,7 +293,7 @@ public class JailManager { /** * Gets the {@link Jail jail} the given player is in. * - *
+ *
*
* Checks the cache first.
*
@@ -422,7 +422,7 @@ public class JailManager {
/**
* Forcefully clears all the jails if name provided is null.
*
- *
+ *
*
* This method just clears them from the storage, doesn't release them.
*
@@ -645,7 +645,11 @@ public class JailManager {
return this.jailCreators.get(name.toLowerCase());
}
- /** Removes a CreationPlayer with the given name from the jail creators. */
+ /**
+ * Removes a CreationPlayer with the given name from the jail creators.
+ *
+ * @param name player's name to remove
+ */
public void removeJailCreationPlayer(String name) {
this.jailCreators.remove(name.toLowerCase());
}
@@ -687,7 +691,11 @@ public class JailManager {
return this.cellCreators.get(name.toLowerCase());
}
- /** Removes a CreationPlayer with the given name from the cell creators. */
+ /**
+ * Removes a CreationPlayer with the given name from the cell creators.
+ *
+ * @param name player's name to remove
+ */
public void removeCellCreationPlayer(String name) {
this.cellCreators.remove(name.toLowerCase());
}
@@ -710,13 +718,22 @@ public class JailManager {
return this.ccs;
}
- /** Adds something to the confirming list. */
+ /**
+ * Adds something to the confirming list.
+ *
+ * @param name who to add
+ * @param confirmer {@link ConfirmPlayer} of what they're confirming
+ */
public void addConfirming(String name, ConfirmPlayer confirmer) {
getPlugin().debug("Adding a confirming for " + name + " to confirm " + confirmer.getConfirming().toString().toLowerCase());
this.confirms.put(name, confirmer);
}
- /** Removes a name from the confirming list. */
+ /**
+ * Removes a name from the confirming list.
+ *
+ * @param name who to remove
+ */
public void removeConfirming(String name) {
this.confirms.remove(name);
}
diff --git a/src/main/java/com/graywolf336/jail/JailsAPI.java b/src/main/java/com/graywolf336/jail/JailsAPI.java
index 79c5314..d0de71a 100644
--- a/src/main/java/com/graywolf336/jail/JailsAPI.java
+++ b/src/main/java/com/graywolf336/jail/JailsAPI.java
@@ -5,7 +5,7 @@ import com.graywolf336.jail.interfaces.IJailStickManager;
/**
* The static api interface for Jail plugin.
*
- *
+ *
*
* If you're looking for non-static methods, please see the
* {@link JailMain} interface.
diff --git a/src/main/java/com/graywolf336/jail/PrisonerManager.java b/src/main/java/com/graywolf336/jail/PrisonerManager.java
index 8a07728..2e53e9b 100644
--- a/src/main/java/com/graywolf336/jail/PrisonerManager.java
+++ b/src/main/java/com/graywolf336/jail/PrisonerManager.java
@@ -32,7 +32,7 @@ import com.graywolf336.jail.interfaces.ICell;
/**
* Provides methods, non-statically, that do the preparing of jails, jailing, etc.
*
- *
+ *
* *
* * In this we do the following: *
*
* If you're wanting to unjail a prisoner, see the {@link #unJail(Jail, ICell, Player, Prisoner, CommandSender)} method.
*
@@ -420,7 +420,7 @@ public class PrisonerManager {
/**
* Unjails a prisoner, sync, from jail, removing all their data.
*
- *
+ *
*
* Throws an exception if either the jail is null or the prisoner is null.
*
@@ -565,7 +565,7 @@ public class PrisonerManager {
/**
* Forcefully unjails a {@link Prisoner prisoner} from {@link Jail}.
*
- *
+ *
*
* This method forcefully removes all the references to this prisoner,
* meaning if they're offline the following won't happened:
@@ -577,7 +577,7 @@ public class PrisonerManager {
*
* But if they're online, it goes through the regular unjailing methods.
*
- *
+ *
*
* @param prisoner to release
* @param sender who is releasing the prisoner, can be null
@@ -593,7 +593,7 @@ public class PrisonerManager {
* Forcefully unjails a {@link Prisoner prisoner} from {@link Jail}.
*
*
- *
+ *
*
* This method forcefully removes all the references to this prisoner,
* meaning if they're offline the following won't happened:
@@ -605,7 +605,7 @@ public class PrisonerManager {
*
* But if they're online, it goes through the regular unjailing methods.
*
- *
+ *
*
* @param jail the prisoner is in
* @param cell the prisoner is in, can be null
diff --git a/src/main/java/com/graywolf336/jail/Update.java b/src/main/java/com/graywolf336/jail/Update.java
index aaf2a69..390e2bf 100644
--- a/src/main/java/com/graywolf336/jail/Update.java
+++ b/src/main/java/com/graywolf336/jail/Update.java
@@ -164,7 +164,11 @@ public class Update {
return this.needed;
}
- /** Returns the new version. */
+ /**
+ * Returns the new version.
+ *
+ * @return The string name of the new version
+ */
public String getNewVersion() {
return this.version;
}
diff --git a/src/main/java/com/graywolf336/jail/Util.java b/src/main/java/com/graywolf336/jail/Util.java
index d571c42..0cc11de 100644
--- a/src/main/java/com/graywolf336/jail/Util.java
+++ b/src/main/java/com/graywolf336/jail/Util.java
@@ -57,7 +57,7 @@ public class Util {
/**
* Checks if two numbers are inside a point, or something.
*
- *
+ *
*
* @param loc The location.
* @param first The first point
@@ -363,7 +363,7 @@ public class Util {
*
* A method to serialize an {@link ItemStack} array to Base64 String.
*
- *
+ *
*
* Based off of {@link #toBase64(Inventory)}.
*
@@ -395,7 +395,7 @@ public class Util {
/**
* A method to serialize an inventory to Base64 string.
*
- *
+ *
*
* Special thanks to Comphenix in the Bukkit forums or also known
* as aadnk on GitHub. Original Source
@@ -429,7 +429,7 @@ public class Util {
*
* A method to get an {@link Inventory} from an encoded, Base64, string.
*
- *
+ *
*
* Special thanks to Comphenix in the Bukkit forums or also known
* as aadnk on GitHub.
@@ -463,7 +463,7 @@ public class Util {
/**
* Gets an array of ItemStacks from Base64 string.
*
- *
+ *
*
* Base off of {@link #fromBase64(String)}.
*
diff --git a/src/main/java/com/graywolf336/jail/beans/CreationPlayer.java b/src/main/java/com/graywolf336/jail/beans/CreationPlayer.java
index 7cc53a5..b63c341 100644
--- a/src/main/java/com/graywolf336/jail/beans/CreationPlayer.java
+++ b/src/main/java/com/graywolf336/jail/beans/CreationPlayer.java
@@ -46,12 +46,20 @@ public class CreationPlayer {
this.step = 1;
}
- /** Gets the name of the jail. */
+ /**
+ * Gets the name of the jail.
+ *
+ * @return the name of the jail the player is creating
+ */
public String getJailName() {
return this.jailName;
}
- /** Gets the name of the cell. */
+ /**
+ * Gets the name of the cell.
+ *
+ * @return the name of the cell the player is creating
+ */
public String getCellName() {
return this.cellName;
}
@@ -105,47 +113,75 @@ public class CreationPlayer {
this.step++;
}
- /** Sets the first corner with the given location. */
+ /**
+ * Sets the first corner with the given location.
+ *
+ * @param loc the location of the first corner
+ */
public void setCornerOne(Location loc) {
this.x1 = loc.getBlockX();
this.y1 = loc.getBlockY();
this.z1 = loc.getBlockZ();
}
- /** Sets the first corner with the given x, y, and z. */
+ /**
+ * Sets the first corner with the given x, y, and z.
+ *
+ * @param x coordinate of the first corner's x
+ * @param y coordinate of the first corner's x
+ * @param z coordinate of the first corner's x
+ */
public void setCornerOne(int x, int y, int z) {
this.x1 = x;
this.y1 = y;
this.z1 = z;
}
- /** Returns the first corner coords an array of int. 0 = x, 1 = y, 2 = z */
+ /**
+ * Returns the first corner coords an array of int. 0 = x, 1 = y, 2 = z
+ *
+ * @return the first corner coords
+ */
public int[] getCornerOne() {
- int[] t = {x1, y1, z1};
- return t;
+ return new int[] {x1, y1, z1};
}
- /** Sets the second corner with the given location. */
+ /**
+ * Sets the second corner with the given location.
+ *
+ * @param loc The second corner's location
+ */
public void setCornerTwo(Location loc) {
this.x2 = loc.getBlockX();
this.y2 = loc.getBlockY();
this.z2 = loc.getBlockZ();
}
- /** Sets the second corner with the given x, y, and z. */
+ /** Sets the second corner with the given x, y, and z.
+ *
+ * @param x coordinate of the second corner's x
+ * @param y coordinate of the second corner's x
+ * @param z coordinate of the second corner's x
+ */
public void setCornerTwo(int x, int y, int z) {
this.x2 = x;
this.y2 = y;
this.z2 = z;
}
- /** Returns the second corner coords an array of int. 0 = x, 1 = y, 2 = z */
+ /** Returns the second corner coords an array of int. 0 = x, 1 = y, 2 = z
+ *
+ * @return the first corner coords
+ */
public int[] getCornerTwo() {
- int[] t = {x2, y2, z2};
- return t;
+ return new int[] {x2, y2, z2};
}
- /** Sets the teleport in coords from the given location. */
+ /**
+ * Sets the teleport in coords from the given location.
+ *
+ * @param location the in location
+ */
public void setTeleportIn(Location location) {
this.inWorld = location.getWorld().getName();
this.inX = location.getX();
@@ -155,7 +191,16 @@ public class CreationPlayer {
this.inPitch = location.getPitch();
}
- /** Sets the teleport in coords from the given params. */
+ /**
+ * Sets the teleport in coords from the given params.
+ *
+ * @param world the name of the world
+ * @param x the coordinate for x
+ * @param y the coordinate for y
+ * @param z the coordinate for z
+ * @param yaw the yaw of the teleport in
+ * @param pitch the pitch of the teleport in
+ */
public void setTeleportIn(String world, double x, double y, double z, float yaw, float pitch) {
this.inWorld = world;
this.inX = x;
@@ -165,17 +210,29 @@ public class CreationPlayer {
this.inPitch = pitch;
}
- /** Gets the teleport in location in a {@link Location}. */
+ /**
+ * Gets the teleport in location in a {@link Location}.
+ *
+ * @return the teleport in {@link Location}
+ */
public Location getTeleportIn() {
return new Location(Bukkit.getWorld(inWorld), inX, inY, inZ, inYaw, inPitch);
}
- /** Gets the teleport in location in a {@link SimpleLocation}. */
+ /**
+ * Gets the teleport in location in a {@link SimpleLocation}.
+ *
+ * @return the {@link SimpleLocation} for the teleportin
+ */
public SimpleLocation getTeleportInSL() {
return new SimpleLocation(inWorld, inX, inY, inZ, inYaw, inPitch);
}
- /** Sets the teleport free coords from the given location. */
+ /**
+ * Sets the teleport free coords from the given location.
+ *
+ * @param location Sets the teleport free {@link Location}
+ */
public void setTeleportFree(Location location) {
this.freeWorld = location.getWorld().getName();
this.freeX = location.getX();
@@ -185,7 +242,16 @@ public class CreationPlayer {
this.freePitch = location.getPitch();
}
- /** Sets the teleport in coords from the given params. */
+ /**
+ * Sets the teleport free coords from the given params.
+ *
+ * @param world the name of the world
+ * @param x the coordinate for x
+ * @param y the coordinate for y
+ * @param z the coordinate for z
+ * @param yaw the yaw of the teleport free
+ * @param pitch the pitch of the teleport free
+ */
public void setTeleportFree(String world, double x, double y, double z, float yaw, float pitch) {
this.freeWorld = world;
this.freeX = x;
@@ -195,32 +261,56 @@ public class CreationPlayer {
this.freePitch = pitch;
}
- /** Gets the teleport free location in a {@link Location}. */
+ /**
+ * Gets the teleport free location in a {@link Location}.
+ *
+ * @return the teleport free {@link Location}
+ */
public Location getTeleportFree() {
return new Location(Bukkit.getWorld(freeWorld), freeX, freeY, freeZ, freeYaw, freePitch);
}
- /** Gets the teleport free location in a {@link SimpleLocation}. */
+ /**
+ * Gets the teleport free location in a {@link SimpleLocation}.
+ *
+ * @return the teleport free {@link SimpleLocation}
+ */
public SimpleLocation getTeleportFreeSL() {
return new SimpleLocation(freeWorld, freeX, freeY, freeZ, freeYaw, freePitch);
}
- /** Adds a sign to this cell. */
+ /**
+ * Adds a sign to this cell.
+ *
+ * @param sign the {@link SimpleLocation} of the sign to add
+ */
public void addSign(SimpleLocation sign) {
this.signs.add(sign);
}
- /** Returns all the signs, null if none (usually null when a jail is being created). */
+ /**
+ * Returns all the signs, null if none (usually null when a jail is being created).
+ *
+ * @return all of the signs, null if none.
+ */
public HashSet
*
* See here for reference: http://dev.bukkit.org/bukkit-plugins/jail/tickets/415/
*/
diff --git a/src/main/java/com/graywolf336/jail/events/JailPluginReloadedEvent.java b/src/main/java/com/graywolf336/jail/events/JailPluginReloadedEvent.java
index b4acfbd..4153453 100644
--- a/src/main/java/com/graywolf336/jail/events/JailPluginReloadedEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/JailPluginReloadedEvent.java
@@ -8,7 +8,7 @@ import com.graywolf336.jail.JailMain;
/**
* Event thrown after the plugin is reloaded, internal usage only.
*
- *
*
* This event is called right after the plugin and mostly everything has reloaded.
* We listen to this event for updating various items in classes which are only
diff --git a/src/main/java/com/graywolf336/jail/events/OfflinePrisonerJailedEvent.java b/src/main/java/com/graywolf336/jail/events/OfflinePrisonerJailedEvent.java
index 2d73fe2..968736e 100644
--- a/src/main/java/com/graywolf336/jail/events/OfflinePrisonerJailedEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/OfflinePrisonerJailedEvent.java
@@ -10,7 +10,7 @@ import com.graywolf336.jail.interfaces.ICell;
/**
* Event thrown when a prisoner is offline put will be put into jail next time they come online.
*
- *
*
* This event is called before everything for the jailing takes place, as the player is offline.
* This event is called for informative purposes, see {@link PrePrisonerJailedEvent}
diff --git a/src/main/java/com/graywolf336/jail/events/PrePrisonerJailedByJailStickEvent.java b/src/main/java/com/graywolf336/jail/events/PrePrisonerJailedByJailStickEvent.java
index f2deb78..0e1b457 100644
--- a/src/main/java/com/graywolf336/jail/events/PrePrisonerJailedByJailStickEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/PrePrisonerJailedByJailStickEvent.java
@@ -14,7 +14,7 @@ import com.graywolf336.jail.interfaces.ICell;
/**
* Event thrown before we a player is jailed by someone hitting them with a {@link Stick jail stick}.
*
- *
*
* This event is called right before we actually jail a player, and is cancellable.
*
diff --git a/src/main/java/com/graywolf336/jail/events/PrePrisonerJailedEvent.java b/src/main/java/com/graywolf336/jail/events/PrePrisonerJailedEvent.java
index 8f06651..4852d9c 100644
--- a/src/main/java/com/graywolf336/jail/events/PrePrisonerJailedEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/PrePrisonerJailedEvent.java
@@ -13,7 +13,7 @@ import com.graywolf336.jail.interfaces.ICell;
/**
* Event thrown before we are jailing a player, both offline and online players.
*
- *
*
* This event is called right before we actually jail a player, and is cancellable, whether the player is offline or online, getPlayer() will always return null if isOnline() return false.
*
diff --git a/src/main/java/com/graywolf336/jail/events/PrePrisonerReleasedEvent.java b/src/main/java/com/graywolf336/jail/events/PrePrisonerReleasedEvent.java
index 812d433..3a9a34c 100644
--- a/src/main/java/com/graywolf336/jail/events/PrePrisonerReleasedEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/PrePrisonerReleasedEvent.java
@@ -11,7 +11,7 @@ import com.graywolf336.jail.interfaces.ICell;
/**
* Event thrown after a prisoner is released.
*
- *
*
* This event is called before everything for the releasing takes place.
* This event is called for informative purposes, see {@link PrisonerReleasedEvent}
diff --git a/src/main/java/com/graywolf336/jail/events/PrePrisonerTransferredEvent.java b/src/main/java/com/graywolf336/jail/events/PrePrisonerTransferredEvent.java
index 51146d3..49db5ed 100644
--- a/src/main/java/com/graywolf336/jail/events/PrePrisonerTransferredEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/PrePrisonerTransferredEvent.java
@@ -12,7 +12,7 @@ import com.graywolf336.jail.beans.Prisoner;
/**
* Event thrown before we transfer a prisoner, both offline and online prisoner.
*
- *
*
* This event is called right before we actually transfer a prisoner, and is cancellable, whether the prisoner is offline or online, getPlayer() will always return null if isOnline() return false.
*
diff --git a/src/main/java/com/graywolf336/jail/events/PrisonerJailedEvent.java b/src/main/java/com/graywolf336/jail/events/PrisonerJailedEvent.java
index 0430a40..7aef62c 100644
--- a/src/main/java/com/graywolf336/jail/events/PrisonerJailedEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/PrisonerJailedEvent.java
@@ -11,7 +11,7 @@ import com.graywolf336.jail.beans.Prisoner;
/**
* Event thrown after a prisoner is put into jail.
*
- *
*
* This event is called after everything for the jailing takes place.
* This event is called for informative purposes, see {@link PrePrisonerJailedEvent}
diff --git a/src/main/java/com/graywolf336/jail/events/PrisonerReleasedEvent.java b/src/main/java/com/graywolf336/jail/events/PrisonerReleasedEvent.java
index d638687..2d0b85f 100644
--- a/src/main/java/com/graywolf336/jail/events/PrisonerReleasedEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/PrisonerReleasedEvent.java
@@ -11,7 +11,7 @@ import com.graywolf336.jail.beans.Prisoner;
/**
* Event thrown after a prisoner is released.
*
- *
*
* This event is called after everything for the releasing takes place.
* This event is called for informative purposes, see {@link PrePrisonerReleasedEvent}
diff --git a/src/main/java/com/graywolf336/jail/events/PrisonerTransferredEvent.java b/src/main/java/com/graywolf336/jail/events/PrisonerTransferredEvent.java
index 98d9adb..8d109aa 100644
--- a/src/main/java/com/graywolf336/jail/events/PrisonerTransferredEvent.java
+++ b/src/main/java/com/graywolf336/jail/events/PrisonerTransferredEvent.java
@@ -11,7 +11,7 @@ import com.graywolf336.jail.beans.Prisoner;
/**
* Event thrown after we transfer a prisoner, both an offline and an online prisoner.
*
- *
*
* This event is called after we transfer the prisoner whether the prisoner is offline or online, getPlayer() will always return null if isOnline() return false.
*
diff --git a/src/main/java/com/graywolf336/jail/interfaces/ICell.java b/src/main/java/com/graywolf336/jail/interfaces/ICell.java
index ec03356..a4e036a 100644
--- a/src/main/java/com/graywolf336/jail/interfaces/ICell.java
+++ b/src/main/java/com/graywolf336/jail/interfaces/ICell.java
@@ -25,7 +25,11 @@ public interface ICell {
*/
public String getName();
- /** Sets the prisoner in this cell. */
+ /**
+ * Sets the prisoner in this cell.
+ *
+ * @param prisoner the {@link Prisoner} to set
+ */
public void setPrisoner(Prisoner prisoner);
/**
@@ -45,10 +49,18 @@ public interface ICell {
*/
public boolean hasPrisoner();
- /** Adds all the given signs to the cell. */
+ /**
+ * Adds all the given signs to the cell.
+ *
+ * @param signs all of the signs to add
+ */
public void addAllSigns(HashSet
*
* These listeners add and remove prisoner cache objects to the cache,
* this way we gain performance for servers which have a high amount
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *