Fix jdoc errors

This commit is contained in:
boy0001 2015-03-13 18:02:48 +11:00
parent cf33fe69a8
commit e887cf8aec
18 changed files with 82 additions and 128 deletions

View File

@ -42,6 +42,7 @@
<version>2.10.1</version> <version>2.10.1</version>
<configuration> <configuration>
<show>public</show> <show>public</show>
<useStandardDocletOptions>false</useStandardDocletOptions>
</configuration> </configuration>
</plugin> </plugin>
<plugin> <plugin>

View File

@ -197,7 +197,7 @@ public class Kim {
* @param at the index of the char value. The first character is at 0. * @param at the index of the char value. The first character is at 0.
* *
* @throws JSONException if at does not point to a valid character. * @throws JSONException if at does not point to a valid character.
* @returns a Unicode character between 0 and 0x10FFFF. * @return a Unicode character between 0 and 0x10FFFF.
*/ */
public int characterAt(final int at) throws JSONException { public int characterAt(final int at) throws JSONException {
final int c = get(at); final int c = get(at);
@ -239,7 +239,7 @@ public class Kim {
* *
* @param obj the other kim with which to compare. * @param obj the other kim with which to compare.
* *
* @returns true if this and obj are both kim objects containing identical byte sequences. * @return true if this and obj are both kim objects containing identical byte sequences.
*/ */
@Override @Override
public boolean equals(final Object obj) { public boolean equals(final Object obj) {

View File

@ -283,7 +283,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* @return PlotManager * @return PlotManager
* *
* @see com.intellectualcrafters.plot.object.PlotManager * @see com.intellectualcrafters.plot.object.PlotManager
* @see PlotSquared#getPlotManager(org.bukkit.World) * @see PlotSquared#getPlotManager(String)
*/ */
public PlotManager getPlotManager(final World world) { public PlotManager getPlotManager(final World world) {
return PlotSquared.getPlotManager(world.getName()); return PlotSquared.getPlotManager(world.getName());
@ -312,7 +312,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return PlotWorld class for that world ! will return null if not a plot world world * @return PlotWorld class for that world ! will return null if not a plot world world
* *
* @see PlotSquared#getWorldSettings(org.bukkit.World) * @see PlotSquared#getPlotWorld(String)
* @see com.intellectualcrafters.plot.object.PlotWorld * @see com.intellectualcrafters.plot.object.PlotWorld
*/ */
public PlotWorld getWorldSettings(final World world) { public PlotWorld getWorldSettings(final World world) {
@ -326,7 +326,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return PlotWorld class for that world ! will return null if not a plot world world * @return PlotWorld class for that world ! will return null if not a plot world world
* *
* @see PlotSquared#getWorldSettings(String) * @see PlotSquared#getPlotWorld(String)
* @see com.intellectualcrafters.plot.object.PlotWorld * @see com.intellectualcrafters.plot.object.PlotWorld
*/ */
public PlotWorld getWorldSettings(final String world) { public PlotWorld getWorldSettings(final String world) {
@ -339,7 +339,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* @param player Player that will receive the message * @param player Player that will receive the message
* @param c (Caption) * @param c (Caption)
* *
* @see com.intellectualcrafters.plot.util.PlayerFunctions#sendMessage(org.bukkit.entity.Player, * @see com.intellectualcrafters.plot.util.MainUtil#sendMessage(PlotPlayer, C, String...)
* com.intellectualcrafters.plot.config.C, String...) * com.intellectualcrafters.plot.config.C, String...)
*/ */
public void sendMessage(final Player player, final C c) { public void sendMessage(final Player player, final C c) {
@ -352,7 +352,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* @param player Player that will receive the message * @param player Player that will receive the message
* @param string The message * @param string The message
* *
* @see com.intellectualcrafters.plot.util.PlayerFunctions#sendMessage(org.bukkit.entity.Player, String) * @see com.intellectualcrafters.plot.util.MainUtil#sendMessage(PlotPlayer, String)
*/ */
public void sendMessage(final Player player, final String string) { public void sendMessage(final Player player, final String string) {
MainUtil.sendMessage(BukkitUtil.getPlayer(player), string); MainUtil.sendMessage(BukkitUtil.getPlayer(player), string);
@ -363,7 +363,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @param msg Message that should be sent to the console * @param msg Message that should be sent to the console
* *
* @see PlotSquared#sendConsoleSenderMessage(String) * @see MainUtil#sendConsoleMessage(String)
*/ */
public void sendConsoleMessage(final String msg) { public void sendConsoleMessage(final String msg) {
MainUtil.sendConsoleMessage(msg); MainUtil.sendConsoleMessage(msg);
@ -414,7 +414,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return plot, null if ID is wrong * @return plot, null if ID is wrong
* *
* @see MainUtil#getPlot(org.bukkit.World, com.intellectualcrafters.plot.object.PlotId) * @see MainUtil#getPlot(String, com.intellectualcrafters.plot.object.PlotId)
* @see com.intellectualcrafters.plot.object.Plot * @see com.intellectualcrafters.plot.object.Plot
*/ */
public Plot getPlot(final World world, final int x, final int z) { public Plot getPlot(final World world, final int x, final int z) {
@ -428,7 +428,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return plot if found, otherwise it creates a temporary plot- * @return plot if found, otherwise it creates a temporary plot-
* *
* @see MainUtil#getCurrentPlot(org.bukkit.Location) * @see MainUtil#getPlot(com.intellectualcrafters.plot.object.Location)
* @see com.intellectualcrafters.plot.object.Plot * @see com.intellectualcrafters.plot.object.Plot
*/ */
public Plot getPlot(final Location l) { public Plot getPlot(final Location l) {
@ -456,7 +456,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return true if player has a plot, false if not. * @return true if player has a plot, false if not.
* *
* @see #getPlots(org.bukkit.World, org.bukkit.entity.Player, boolean) * @see #getPlots(World, Player, boolean)
*/ */
public boolean hasPlot(final World world, final Player player) { public boolean hasPlot(final World world, final Player player) {
return (getPlots(world, player, true) != null) && (getPlots(world, player, true).length > 0); return (getPlots(world, player, true) != null) && (getPlots(world, player, true).length > 0);
@ -493,7 +493,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return Plot[] - array of plot objects in world * @return Plot[] - array of plot objects in world
* *
* @see PlotSquared#getWorldPlots(org.bukkit.World) * @see PlotSquared#getPlots(String)
* @see com.intellectualcrafters.plot.object.Plot * @see com.intellectualcrafters.plot.object.Plot
*/ */
public Plot[] getPlots(final World world) { public Plot[] getPlots(final World world) {
@ -520,7 +520,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return boolean (if plot world or not) * @return boolean (if plot world or not)
* *
* @see com.intellectualcrafters.plot.PlotSquared#isPlotWorld(org.bukkit.World) * @see com.intellectualcrafters.plot.PlotSquared#isPlotWorld(String)
*/ */
public boolean isPlotWorld(final World world) { public boolean isPlotWorld(final World world) {
return PlotSquared.isPlotWorld(world.getName()); return PlotSquared.isPlotWorld(world.getName());
@ -533,13 +533,12 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return [0] = bottomLc, [1] = topLoc, [2] = home * @return [0] = bottomLc, [1] = topLoc, [2] = home
* *
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotBottomLoc(org.bukkit.World, * @see com.intellectualcrafters.plot.util.MainUtil#getPlotBottomLoc(String,
* com.intellectualcrafters.plot.object.PlotId) * com.intellectualcrafters.plot.object.PlotId)
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotTopLoc(org.bukkit.World, * @see com.intellectualcrafters.plot.util.MainUtil#getPlotTopLoc(String,
* com.intellectualcrafters.plot.object.PlotId) * com.intellectualcrafters.plot.object.PlotId)
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotHome(org.bukkit.World, * @see com.intellectualcrafters.plot.util.MainUtil#getPlotHome(String,
* com.intellectualcrafters.plot.object.Plot) * com.intellectualcrafters.plot.object.Plot)
* @see com.intellectualcrafters.plot.object.PlotHomePosition
* @see com.intellectualcrafters.plot.object.Plot * @see com.intellectualcrafters.plot.object.Plot
*/ */
public Location[] getLocations(final Plot p) { public Location[] getLocations(final Plot p) {
@ -553,9 +552,8 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return plot bottom location * @return plot bottom location
* *
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotHome(org.bukkit.World, * @see com.intellectualcrafters.plot.util.MainUtil#getPlotHome(String,
* com.intellectualcrafters.plot.object.Plot) * com.intellectualcrafters.plot.object.Plot)
* @see com.intellectualcrafters.plot.object.PlotHomePosition
* @see com.intellectualcrafters.plot.object.Plot * @see com.intellectualcrafters.plot.object.Plot
*/ */
public Location getHomeLocation(final Plot p) { public Location getHomeLocation(final Plot p) {
@ -569,7 +567,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return plot bottom location * @return plot bottom location
* *
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotBottomLoc(org.bukkit.World, * @see com.intellectualcrafters.plot.util.MainUtil#getPlotBottomLoc(String,
* com.intellectualcrafters.plot.object.PlotId) * com.intellectualcrafters.plot.object.PlotId)
* @see com.intellectualcrafters.plot.object.Plot * @see com.intellectualcrafters.plot.object.Plot
*/ */
@ -584,7 +582,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return plot top location * @return plot top location
* *
* @see MainUtil#getPlotTopLoc(org.bukkit.World, com.intellectualcrafters.plot.object.PlotId) * @see MainUtil#getPlotTopLoc(String, com.intellectualcrafters.plot.object.PlotId)
* @see com.intellectualcrafters.plot.object.Plot * @see com.intellectualcrafters.plot.object.Plot
*/ */
public Location getTopLocation(final Plot p) { public Location getTopLocation(final Plot p) {
@ -598,7 +596,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return true if the player is in a plot, false if not- * @return true if the player is in a plot, false if not-
* *
* @see com.intellectualcrafters.plot.util.PlayerFunctions#isInPlot(org.bukkit.entity.Player) * @see com.intellectualcrafters.plot.util.MainUtil#getPlot(com.intellectualcrafters.plot.object.Location)
*/ */
public boolean isInPlot(final Player player) { public boolean isInPlot(final Player player) {
return MainUtil.getPlot(BukkitUtil.getLocation(player)) != null; return MainUtil.getPlot(BukkitUtil.getLocation(player)) != null;
@ -635,8 +633,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return the number of plots the player has * @return the number of plots the player has
* *
* @see com.intellectualcrafters.plot.util.PlayerFunctions#getPlayerPlotCount(org.bukkit.World, * @see com.intellectualcrafters.plot.util.MainUtil#getPlayerPlotCount(String, PlotPlayer)
* org.bukkit.entity.Player)
*/ */
public int getPlayerPlotCount(final World world, final Player player) { public int getPlayerPlotCount(final World world, final Player player) {
return MainUtil.getPlayerPlotCount(world.getName(), BukkitUtil.getPlayer(player)); return MainUtil.getPlayerPlotCount(world.getName(), BukkitUtil.getPlayer(player));
@ -650,7 +647,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return a set containing the players plots * @return a set containing the players plots
* *
* @see com.intellectualcrafters.plot.util.PlayerFunctions#getPlayerPlots(org.bukkit.World, * @see com.intellectualcrafters.plot.PlotSquared#getPlots(String, PlotPlayer)
* org.bukkit.entity.Player) * org.bukkit.entity.Player)
* @see com.intellectualcrafters.plot.object.Plot * @see com.intellectualcrafters.plot.object.Plot
*/ */
@ -665,7 +662,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper;
* *
* @return the number of allowed plots * @return the number of allowed plots
* *
* @see com.intellectualcrafters.plot.util.PlayerFunctions#getAllowedPlots(org.bukkit.entity.Player) * @see com.intellectualcrafters.plot.util.MainUtil#getAllowedPlots(PlotPlayer, int)
*/ */
public int getAllowedPlots(final Player player) { public int getAllowedPlots(final Player player) {
PlotPlayer pp = BukkitUtil.getPlayer(player); PlotPlayer pp = BukkitUtil.getPlayer(player);

View File

@ -144,8 +144,7 @@ public abstract class SubCommand {
* @param c Caption * @param c Caption
* @param args Arguments (%s's) * @param args Arguments (%s's)
* *
* @see com.intellectualcrafters.plot.util.bukkit.BukkitPlayerFunctions#sendMessage(org.bukkit.entity.Player, * @see com.intellectualcrafters.plot.util.MainUtil#sendMessage(PlotPlayer, C, String...)
* com.intellectualcrafters.plot.config.C, String...)
*/ */
public boolean sendMessage(final PlotPlayer plr, final C c, final String... args) { public boolean sendMessage(final PlotPlayer plr, final C c, final String... args) {
MainUtil.sendMessage(plr, c, args); MainUtil.sendMessage(plr, c, args);

View File

@ -115,8 +115,7 @@ public interface AbstractDB {
* Get the id of a given plot cluster * Get the id of a given plot cluster
* *
* @param world Which the plot is located in * @param world Which the plot is located in
* @param pos1 bottom Plot ID * @param id cluster id
* @param pos2 top Plot ID
* *
* @return Integer = Cluster Entry Id * @return Integer = Cluster Entry Id
*/ */
@ -160,7 +159,6 @@ public interface AbstractDB {
/** /**
* Set cluster flags * Set cluster flags
* *
* @param world World in which the plot is located
* @param cluster PlotCluster Object * @param cluster PlotCluster Object
* @param flags flags to set (flag[]) * @param flags flags to set (flag[])
*/ */
@ -183,7 +181,7 @@ public interface AbstractDB {
* Purgle a plot * Purgle a plot
* *
* @param world World in which the plot is located * @param world World in which the plot is located
* @param id Plot ID * @param uniqueIds list of plot id (db) to be purged
*/ */
public void purgeIds(final String world, final Set<Integer> uniqueIds); public void purgeIds(final String world, final Set<Integer> uniqueIds);
@ -219,7 +217,7 @@ public interface AbstractDB {
/** /**
* *
* @param id * @param id
* @return * @return HashMap<String, Object>
*/ */
public HashMap<String, Object> getClusterSettings(final int id); public HashMap<String, Object> getClusterSettings(final int id);
@ -276,13 +274,13 @@ public interface AbstractDB {
/** /**
* @param plot Plot Object * @param plot Plot Object
* @param player Player that should be added * @param uuid Player uuid
*/ */
public void removeDenied(final String world, final Plot plot, final UUID uuid); public void removeDenied(final String world, final Plot plot, final UUID uuid);
/** /**
* @param plot Plot Object * @param plot Plot Object
* @param player Player that should be added * @param uuid Player uuid that should be added
*/ */
public void setDenied(final String world, final Plot plot, final UUID uuid); public void setDenied(final String world, final Plot plot, final UUID uuid);

View File

@ -198,9 +198,9 @@ public class DBFunc {
} }
/** /**
* @param id
* *
* @return * @param id
* @return HashMap<String, Object>
*/ */
public static HashMap<String, Object> getSettings(final int id) { public static HashMap<String, Object> getSettings(final int id) {
return dbManager.getSettings(id); return dbManager.getSettings(id);
@ -231,7 +231,7 @@ public class DBFunc {
/** /**
* @param plot * @param plot
* @param player * @param uuid
*/ */
public static void removeHelper(final String world, final Plot plot, final UUID uuid) { public static void removeHelper(final String world, final Plot plot, final UUID uuid) {
dbManager.removeHelper(world, plot, uuid); dbManager.removeHelper(world, plot, uuid);
@ -239,7 +239,7 @@ public class DBFunc {
/** /**
* @param cluster * @param cluster
* @param player * @param uuid
*/ */
public static void removeHelper(final PlotCluster cluster, final UUID uuid) { public static void removeHelper(final PlotCluster cluster, final UUID uuid) {
dbManager.removeHelper(cluster, uuid); dbManager.removeHelper(cluster, uuid);
@ -248,14 +248,12 @@ public class DBFunc {
/** /**
* @param world * @param world
* @param cluster * @param cluster
* @param name
*/ */
public static void createCluster(final String world, final PlotCluster cluster) { public static void createCluster(final String world, final PlotCluster cluster) {
dbManager.createCluster(cluster); dbManager.createCluster(cluster);
} }
/** /**
* @param world
* @param current * @param current
* @param resize * @param resize
*/ */
@ -265,7 +263,7 @@ public class DBFunc {
/** /**
* @param plot * @param plot
* @param player * @param uuid
*/ */
public static void removeTrusted(final String world, final Plot plot, final UUID uuid) { public static void removeTrusted(final String world, final Plot plot, final UUID uuid) {
dbManager.removeTrusted(world, plot, uuid); dbManager.removeTrusted(world, plot, uuid);
@ -273,8 +271,7 @@ public class DBFunc {
/** /**
* *
* @param world * @param cluster
* @param plot
* @param uuid * @param uuid
*/ */
public static void removeInvited(final PlotCluster cluster, final UUID uuid) { public static void removeInvited(final PlotCluster cluster, final UUID uuid) {
@ -282,8 +279,9 @@ public class DBFunc {
} }
/** /**
* @param world
* @param plot * @param plot
* @param player * @param uuid
*/ */
public static void setHelper(final String world, final Plot plot, final UUID uuid) { public static void setHelper(final String world, final Plot plot, final UUID uuid) {
dbManager.setHelper(world, plot, uuid); dbManager.setHelper(world, plot, uuid);
@ -294,8 +292,9 @@ public class DBFunc {
} }
/** /**
* @param world
* @param plot * @param plot
* @param player * @param uuid
*/ */
public static void setTrusted(final String world, final Plot plot, final UUID uuid) { public static void setTrusted(final String world, final Plot plot, final UUID uuid) {
dbManager.setTrusted(world, plot, uuid); dbManager.setTrusted(world, plot, uuid);
@ -306,16 +305,18 @@ public class DBFunc {
} }
/** /**
* @param world
* @param plot * @param plot
* @param player * @param uuid
*/ */
public static void removeDenied(final String world, final Plot plot, final UUID uuid) { public static void removeDenied(final String world, final Plot plot, final UUID uuid) {
dbManager.removeDenied(world, plot, uuid); dbManager.removeDenied(world, plot, uuid);
} }
/** /**
* @param world
* @param plot * @param plot
* @param player * @param uuid
*/ */
public static void setDenied(final String world, final Plot plot, final UUID uuid) { public static void setDenied(final String world, final Plot plot, final UUID uuid) {
dbManager.setDenied(world, plot, uuid); dbManager.setDenied(world, plot, uuid);

View File

@ -45,7 +45,6 @@ public class MySQL extends Database {
/** /**
* Creates a new MySQL instance * Creates a new MySQL instance
* *
* @param plugin Plugin instance
* @param hostname Name of the host * @param hostname Name of the host
* @param port Port number * @param port Port number
* @param database Database name * @param database Database name

View File

@ -233,7 +233,7 @@ public class SQLManager implements AbstractDB {
/** /**
* Create a plot * Create a plot
* *
* @param plots * @param mylist list of plots to be created
*/ */
@Override @Override
public void createPlots(final ArrayList<Plot> mylist) { public void createPlots(final ArrayList<Plot> mylist) {
@ -874,10 +874,6 @@ public class SQLManager implements AbstractDB {
}); });
} }
/**
* @param plot
* @param alias
*/
@Override @Override
public void setAlias(final String world, final Plot plot, final String alias) { public void setAlias(final String world, final Plot plot, final String alias) {
plot.settings.setAlias(alias); plot.settings.setAlias(alias);
@ -972,10 +968,6 @@ public class SQLManager implements AbstractDB {
} }
} }
/**
* @param plot
* @param position
*/
@Override @Override
public void setPosition(final String world, final Plot plot, final String position) { public void setPosition(final String world, final Plot plot, final String position) {
TaskManager.runTaskAsync(new Runnable() { TaskManager.runTaskAsync(new Runnable() {
@ -996,11 +988,6 @@ public class SQLManager implements AbstractDB {
}); });
} }
/**
* @param id
*
* @return
*/
@Override @Override
public HashMap<String, Object> getSettings(final int id) { public HashMap<String, Object> getSettings(final int id) {
final HashMap<String, Object> h = new HashMap<String, Object>(); final HashMap<String, Object> h = new HashMap<String, Object>();
@ -1130,10 +1117,6 @@ public class SQLManager implements AbstractDB {
}); });
} }
/**
* @param plot
* @param player
*/
@Override @Override
public void removeHelper(final String world, final Plot plot, final UUID uuid) { public void removeHelper(final String world, final Plot plot, final UUID uuid) {
TaskManager.runTaskAsync(new Runnable() { TaskManager.runTaskAsync(new Runnable() {
@ -1153,10 +1136,6 @@ public class SQLManager implements AbstractDB {
}); });
} }
/**
* @param plot
* @param player
*/
@Override @Override
public void removeTrusted(final String world, final Plot plot, final UUID uuid) { public void removeTrusted(final String world, final Plot plot, final UUID uuid) {
TaskManager.runTaskAsync(new Runnable() { TaskManager.runTaskAsync(new Runnable() {
@ -1176,10 +1155,6 @@ public class SQLManager implements AbstractDB {
}); });
} }
/**
* @param plot
* @param player
*/
@Override @Override
public void setHelper(final String world, final Plot plot, final UUID uuid) { public void setHelper(final String world, final Plot plot, final UUID uuid) {
TaskManager.runTaskAsync(new Runnable() { TaskManager.runTaskAsync(new Runnable() {
@ -1217,10 +1192,6 @@ public class SQLManager implements AbstractDB {
}); });
} }
/**
* @param plot
* @param player
*/
@Override @Override
public void setTrusted(final String world, final Plot plot, final UUID uuid) { public void setTrusted(final String world, final Plot plot, final UUID uuid) {
TaskManager.runTaskAsync(new Runnable() { TaskManager.runTaskAsync(new Runnable() {
@ -1240,10 +1211,6 @@ public class SQLManager implements AbstractDB {
}); });
} }
/**
* @param plot
* @param player
*/
@Override @Override
public void removeDenied(final String world, final Plot plot, final UUID uuid) { public void removeDenied(final String world, final Plot plot, final UUID uuid) {
TaskManager.runTaskAsync(new Runnable() { TaskManager.runTaskAsync(new Runnable() {
@ -1263,10 +1230,6 @@ public class SQLManager implements AbstractDB {
}); });
} }
/**
* @param plot
* @param player
*/
@Override @Override
public void setDenied(final String world, final Plot plot, final UUID uuid) { public void setDenied(final String world, final Plot plot, final UUID uuid) {
TaskManager.runTaskAsync(new Runnable() { TaskManager.runTaskAsync(new Runnable() {

View File

@ -43,7 +43,6 @@ public class SQLite extends Database {
/** /**
* Creates a new SQLite instance * Creates a new SQLite instance
* *
* @param plugin Plugin instance
* @param dbLocation Location of the Database (Must end in .db) * @param dbLocation Location of the Database (Must end in .db)
*/ */
public SQLite(final PlotSquared plotsquared, final String dbLocation) { public SQLite(final PlotSquared plotsquared, final String dbLocation) {

View File

@ -53,9 +53,9 @@ public class FlagManager {
/** /**
* Register an AbstractFlag with PlotSquared * Register an AbstractFlag with PlotSquared
* *
* @param flag Flag to register * @param af Flag to register
* *
* @return success? * @return boolean success
*/ */
public static boolean addFlag(final AbstractFlag af) { public static boolean addFlag(final AbstractFlag af) {
PlotSquared.log(C.PREFIX.s() + "&8 - Adding flag: &7" + af); PlotSquared.log(C.PREFIX.s() + "&8 - Adding flag: &7" + af);
@ -99,7 +99,7 @@ public class FlagManager {
* Get the value of a flag for a plot (respects flag defaults) * Get the value of a flag for a plot (respects flag defaults)
* @param plot * @param plot
* @param flag * @param flag
* @return * @return Flag
*/ */
public static Flag getPlotFlag(final Plot plot, final String flag) { public static Flag getPlotFlag(final Plot plot, final String flag) {
return getSettingFlag(plot.world, plot.settings, flag); return getSettingFlag(plot.world, plot.settings, flag);
@ -120,7 +120,7 @@ public class FlagManager {
* Get the value of a flag for a plot (ignores flag defaults) * Get the value of a flag for a plot (ignores flag defaults)
* @param plot * @param plot
* @param flag * @param flag
* @return * @return Flag
*/ */
public static Flag getPlotFlagAbs(final Plot plot, final String flag) { public static Flag getPlotFlagAbs(final Plot plot, final String flag) {
return getSettingFlagAbs(plot.settings, flag); return getSettingFlagAbs(plot.settings, flag);
@ -171,7 +171,7 @@ public class FlagManager {
/** /**
* *
* @param plot * @param plot
* @return * @return Set<Flag>
*/ */
public static Set<Flag> getPlotFlags(final Plot plot) { public static Set<Flag> getPlotFlags(final Plot plot) {
return getSettingFlags(plot.world, plot.settings); return getSettingFlags(plot.world, plot.settings);

View File

@ -142,7 +142,7 @@ public class Plot implements Cloneable {
/** /**
* Check if the player is either the owner or on the helpers list * Check if the player is either the owner or on the helpers list
* *
* @param player * @param uuid
* *
* @return true if the player is added as a helper or is the owner * @return true if the player is added as a helper or is the owner
*/ */
@ -153,9 +153,9 @@ public class Plot implements Cloneable {
/** /**
* Should the player be allowed to enter? * Should the player be allowed to enter?
* *
* @param player * @param uuid
* *
* @return false if the player is allowed to enter * @return boolean false if the player is allowed to enter
*/ */
public boolean isDenied(final UUID uuid) { public boolean isDenied(final UUID uuid) {
return (this.denied != null) && ((this.denied.contains(DBFunc.everyone) && !this.isAdded(uuid)) || (!this.isAdded(uuid) && this.denied.contains(uuid))); return (this.denied != null) && ((this.denied.contains(DBFunc.everyone) && !this.isAdded(uuid)) || (!this.isAdded(uuid) && this.denied.contains(uuid)));
@ -171,7 +171,7 @@ public class Plot implements Cloneable {
/** /**
* Set the owner * Set the owner
* *
* @param player * @param uuid
*/ */
public void setOwner(final UUID uuid) { public void setOwner(final UUID uuid) {
this.owner = uuid; this.owner = uuid;
@ -187,7 +187,7 @@ public class Plot implements Cloneable {
/** /**
* Get a clone of the plot * Get a clone of the plot
* *
* @return * @return Plot
*/ */
@Override @Override
public Object clone() throws CloneNotSupportedException { public Object clone() throws CloneNotSupportedException {

View File

@ -82,7 +82,7 @@ public class MainUtil {
* *
* @param plr * @param plr
* *
* @return * @return int plot count
*/ */
public static int getPlayerPlotCount(final String world, final PlotPlayer plr) { public static int getPlayerPlotCount(final String world, final PlotPlayer plr) {
final UUID uuid = plr.getUUID(); final UUID uuid = plr.getUUID();
@ -188,7 +188,7 @@ public class MainUtil {
* @param id * @param id
* @param direction * @param direction
* *
* @return * @return PlotId relative
*/ */
public static PlotId getPlotIdRelative(final PlotId id, final int direction) { public static PlotId getPlotIdRelative(final PlotId id, final int direction) {
switch (direction) { switch (direction) {
@ -485,8 +485,9 @@ public class MainUtil {
/** /**
* Clear a plot and associated sections: [sign, entities, border] * Clear a plot and associated sections: [sign, entities, border]
* *
* @param requester
* @param plot * @param plot
* @param isDelete
* @param whenDone
*/ */
public static boolean clearAsPlayer(final Plot plot, final boolean isDelete, final Runnable whenDone) { public static boolean clearAsPlayer(final Plot plot, final boolean isDelete, final Runnable whenDone) {
if (runners.containsKey(plot)) { if (runners.containsKey(plot)) {
@ -658,7 +659,7 @@ public class MainUtil {
* *
* @return Plot Home Location * @return Plot Home Location
* *
* @see #getPlotHome(org.bukkit.World, com.intellectualcrafters.plot.object.PlotId) * @see #getPlotHome(String, Plot)
*/ */
public static Location getPlotHome(final String w, final Plot plot) { public static Location getPlotHome(final String w, final Plot plot) {
return getPlotHome(w, plot.id); return getPlotHome(w, plot.id);
@ -709,7 +710,7 @@ public class MainUtil {
* @param world * @param world
* @param id * @param id
* *
* @return * @return Location top
*/ */
public static Location getPlotTopLocAbs(final String world, final PlotId id) { public static Location getPlotTopLocAbs(final String world, final PlotId id) {
final PlotWorld plotworld = PlotSquared.getPlotWorld(world); final PlotWorld plotworld = PlotSquared.getPlotWorld(world);
@ -724,7 +725,7 @@ public class MainUtil {
* @param world * @param world
* @param id * @param id
* *
* @return * @return Location bottom
*/ */
public static Location getPlotBottomLocAbs(final String world, final PlotId id) { public static Location getPlotBottomLocAbs(final String world, final PlotId id) {
final PlotWorld plotworld = PlotSquared.getPlotWorld(world); final PlotWorld plotworld = PlotSquared.getPlotWorld(world);
@ -738,7 +739,7 @@ public class MainUtil {
* @param world * @param world
* @param id * @param id
* *
* @return * @return int width of plot
*/ */
public static int getPlotWidth(final String world, final PlotId id) { public static int getPlotWidth(final String world, final PlotId id) {
return getPlotTopLoc(world, id).getX() - getPlotBottomLoc(world, id).getX(); return getPlotTopLoc(world, id).getX() - getPlotBottomLoc(world, id).getX();
@ -751,7 +752,7 @@ public class MainUtil {
* @param world * @param world
* @param id * @param id
* *
* @return * @return Location top of mega plot
*/ */
public static Location getPlotTopLoc(final String world, PlotId id) { public static Location getPlotTopLoc(final String world, PlotId id) {
final Plot plot = PlotSquared.getPlots(world).get(id); final Plot plot = PlotSquared.getPlots(world).get(id);
@ -770,7 +771,7 @@ public class MainUtil {
* @param world * @param world
* @param id * @param id
* *
* @return * @return Location bottom of mega plot
*/ */
public static Location getPlotBottomLoc(final String world, PlotId id) { public static Location getPlotBottomLoc(final String world, PlotId id) {
final Plot plot = PlotSquared.getPlots(world).get(id); final Plot plot = PlotSquared.getPlots(world).get(id);
@ -995,7 +996,7 @@ public class MainUtil {
* @param plr Player to recieve message * @param plr Player to recieve message
* @param c Caption to send * @param c Caption to send
* *
* @return * @return boolean success
*/ */
public static boolean sendMessage(final PlotPlayer plr, final C c, final String... args) { public static boolean sendMessage(final PlotPlayer plr, final C c, final String... args) {
if (c.s().length() > 1) { if (c.s().length() > 1) {
@ -1070,7 +1071,7 @@ public class MainUtil {
/** /**
* Returns the plot at a location (mega plots are not considered, all plots are treated as small plots) * Returns the plot at a location (mega plots are not considered, all plots are treated as small plots)
* @param loc * @param loc
* @return * @return PlotId underlying plot id of loc
*/ */
public static PlotId getPlotAbs(final Location loc) { public static PlotId getPlotAbs(final Location loc) {
final String world = loc.getWorld(); final String world = loc.getWorld();
@ -1085,7 +1086,7 @@ public class MainUtil {
/** /**
* Returns the plot id at a location (mega plots are considered) * Returns the plot id at a location (mega plots are considered)
* @param loc * @param loc
* @return * @return PlotId PlotId observed id
*/ */
public static PlotId getPlotId(final Location loc) { public static PlotId getPlotId(final Location loc) {
final String world = loc.getWorld(); final String world = loc.getWorld();
@ -1107,7 +1108,7 @@ public class MainUtil {
* Get the maximum number of plots a player is allowed * Get the maximum number of plots a player is allowed
* *
* @param p * @param p
* @return * @return int
*/ */
public static int getAllowedPlots(final PlotPlayer p, final int current) { public static int getAllowedPlots(final PlotPlayer p, final int current) {
return Permissions.hasPermissionRange(p, "plots.plot", Settings.MAX_PLOTS, current); return Permissions.hasPermissionRange(p, "plots.plot", Settings.MAX_PLOTS, current);

View File

@ -34,11 +34,12 @@ public abstract class SchematicHandler {
/** /**
* Paste a schematic * Paste a schematic
* *
* @param location origin * @param schematic the schematic object to paste
* @param schematic schematic to paste
* @param plot plot to paste in * @param plot plot to paste in
* @param x_offset offset x to paste it from plot origin
* @param z_offset offset z to paste it from plot origin
* *
* @return true if succeeded * @return boolean true if succeeded
*/ */
public boolean paste(final Schematic schematic, final Plot plot, final int x_offset, final int z_offset) { public boolean paste(final Schematic schematic, final Plot plot, final int x_offset, final int z_offset) {
if (schematic == null) { if (schematic == null) {

View File

@ -76,7 +76,7 @@ public class BukkitPlayerFunctions {
* @param world * @param world
* @param plotIds * @param plotIds
* *
* @return * @return boolean
*/ */
public static boolean mergePlots(final Player plr, final String world, final ArrayList<PlotId> plotIds) { public static boolean mergePlots(final Player plr, final String world, final ArrayList<PlotId> plotIds) {
final PlotWorld plotworld = PlotSquared.getPlotWorld(world); final PlotWorld plotworld = PlotSquared.getPlotWorld(world);
@ -109,7 +109,7 @@ public class BukkitPlayerFunctions {
/** /**
* @param player player * @param player player
* *
* @return * @return boolean
*/ */
public static boolean isInPlot(final Player player) { public static boolean isInPlot(final Player player) {
return getCurrentPlot(player) != null; return getCurrentPlot(player) != null;
@ -138,7 +138,7 @@ public class BukkitPlayerFunctions {
* *
* @param player * @param player
* *
* @return * @return boolean
*/ */
public static Plot getCurrentPlot(final Player player) { public static Plot getCurrentPlot(final Player player) {
if (!PlotSquared.isPlotWorld(player.getWorld().getName())) { if (!PlotSquared.isPlotWorld(player.getWorld().getName())) {
@ -160,7 +160,7 @@ public class BukkitPlayerFunctions {
* *
* @param plr * @param plr
* *
* @return * @return boolean
*/ */
public static Set<Plot> getPlayerPlots(final String world, final Player plr) { public static Set<Plot> getPlayerPlots(final String world, final Player plr) {
final Set<Plot> p = PlotSquared.getPlots(world, plr.getName()); final Set<Plot> p = PlotSquared.getPlots(world, plr.getName());

View File

@ -128,7 +128,7 @@ public class Metrics {
* *
* @param input * @param input
* *
* @return * @return byte[] the file as a byte array
*/ */
public static byte[] gzip(final String input) { public static byte[] gzip(final String input) {
final ByteArrayOutputStream baos = new ByteArrayOutputStream(); final ByteArrayOutputStream baos = new ByteArrayOutputStream();
@ -185,7 +185,7 @@ public class Metrics {
* *
* @param text * @param text
* *
* @return * @return String
*/ */
private static String escapeJSON(final String text) { private static String escapeJSON(final String text) {
final StringBuilder builder = new StringBuilder(); final StringBuilder builder = new StringBuilder();

View File

@ -68,7 +68,6 @@ public class SetBlockFast extends BukkitSetBlockManager {
* @param blockId Block ID * @param blockId Block ID
* @param data Block Data Value * @param data Block Data Value
* *
* @return true
*/ */
@Override @Override
public void set(final org.bukkit.World world, final int x, final int y, final int z, final int blockId, final byte data) { public void set(final org.bukkit.World world, final int x, final int y, final int z, final int blockId, final byte data) {
@ -81,7 +80,7 @@ public class SetBlockFast extends BukkitSetBlockManager {
/** /**
* Update chunks * Update chunks
* *
* @param player Player whose chunks we're updating * @param chunks list of chunks to update
*/ */
@Override @Override
public void update(final List<Chunk> chunks) { public void update(final List<Chunk> chunks) {

View File

@ -74,10 +74,8 @@ public class SetBlockFast_1_8 extends BukkitSetBlockManager {
* @param x X Coordinate * @param x X Coordinate
* @param y Y Coordinate * @param y Y Coordinate
* @param z Z Coordinate * @param z Z Coordinate
* @param blockId Block ID * @param id Block ID
* @param data Block Data Value * @param data Block Data Value
*
* @return true
*/ */
@SuppressWarnings("deprecation") @SuppressWarnings("deprecation")
@Override @Override
@ -286,7 +284,7 @@ public class SetBlockFast_1_8 extends BukkitSetBlockManager {
/** /**
* Update chunks * Update chunks
* *
* @param player Player whose chunks we're updating * @param chunks chunks to be updated
*/ */
@Override @Override
public void update(final List<Chunk> chunks) { public void update(final List<Chunk> chunks) {

View File

@ -31,8 +31,6 @@ public class BukkitTranslation {
/** /**
* Get the universal parent based on the plugin data folder * Get the universal parent based on the plugin data folder
* *
* @param plugin to check
*
* @return parent folder * @return parent folder
*/ */
public static File getParent() { public static File getParent() {