From 86ea8ec02c0caf5b856810d3f174d69d211a5d9f Mon Sep 17 00:00:00 2001 From: Rsl1122 Date: Mon, 2 Oct 2017 21:52:13 +0300 Subject: [PATCH] Updated Javadoc --- .../main/java/com/djrapitops/plan/Plan.java | 2 - .../plan/ServerSpecificSettings.java | 2 +- .../plan/command/commands/AnalyzeCommand.java | 6 +- .../com/djrapitops/plan/data/Session.java | 4 +- .../djrapitops/plan/database/Database.java | 6 +- .../plan/database/databases/SQLDB.java | 30 +++------- .../plan/database/databases/SQLiteDB.java | 4 -- .../plan/database/sql/TableSqlParser.java | 2 +- .../plan/database/tables/ActionsTable.java | 6 +- .../plan/database/tables/CommandUseTable.java | 11 +--- .../plan/database/tables/IPsTable.java | 3 - .../plan/database/tables/KillsTable.java | 13 +---- .../plan/database/tables/NicknamesTable.java | 3 - .../plan/database/tables/ServerTable.java | 8 +-- .../plan/database/tables/SessionsTable.java | 41 ++++++-------- .../plan/database/tables/TPSTable.java | 22 ++++---- .../plan/database/tables/Table.java | 55 ++++++++----------- .../plan/database/tables/UserInfoTable.java | 5 +- .../plan/database/tables/UsersTable.java | 34 +++++------- .../plan/database/tables/VersionTable.java | 13 ++--- .../tables/move/BatchOperationTable.java | 4 +- .../plan/systems/cache/DataCache.java | 8 ++- .../info/BukkitInformationManager.java | 2 +- .../info/server/BukkitServerInfoManager.java | 4 +- .../systems/info/server/ServerInfoFile.java | 2 +- .../djrapitops/plan/systems/queue/Queue.java | 2 +- .../systems/webserver/ResponseHandler.java | 2 - .../plan/systems/webserver/WebServer.java | 3 - .../response/AnalysisPageResponse.java | 4 +- .../webserver/webapi/WebAPIManager.java | 2 +- .../RequestInspectPluginsTabBukkitWebAPI.java | 2 +- .../bungee/PostInspectPluginsTabWebAPI.java | 2 +- .../bungee/RequestPluginsTabWebAPI.java | 2 +- .../djrapitops/plan/utilities/Benchmark.java | 10 +++- .../plan/utilities/FormatUtils.java | 42 +++++++------- .../plan/utilities/ManageUtils.java | 2 - .../djrapitops/plan/utilities/MiscUtils.java | 10 ++-- .../plan/utilities/analysis/Analysis.java | 8 ++- .../utilities/analysis/AnalysisUtils.java | 46 ---------------- .../utilities/analysis/ExportUtility.java | 22 -------- .../utilities/comparators/MapComparator.java | 19 ++++--- .../comparators/StringLengthComparator.java | 2 +- .../plan/utilities/file/dump/Hastebin.java | 7 ++- .../plan/utilities/html/HtmlStructure.java | 24 +++----- .../plan/utilities/html/HtmlUtils.java | 22 +++++--- .../html/graphs/WorldLoadGraphCreator.java | 2 +- .../html/graphs/WorldPieCreator.java | 2 +- .../plan/utilities/uuid/UUIDUtility.java | 24 ++++---- 48 files changed, 210 insertions(+), 341 deletions(-) diff --git a/Plan/src/main/java/com/djrapitops/plan/Plan.java b/Plan/src/main/java/com/djrapitops/plan/Plan.java index ece736f89..45f23a80f 100644 --- a/Plan/src/main/java/com/djrapitops/plan/Plan.java +++ b/Plan/src/main/java/com/djrapitops/plan/Plan.java @@ -328,8 +328,6 @@ public class Plan extends BukkitPlugin implements IPlan { * Initializes the database according to settings in the config. *

* If database connection can not be established plugin is disabled. - * - * @return true if init was successful, false if not. */ private void initDatabase() throws DatabaseInitException { databases = new HashSet<>(); diff --git a/Plan/src/main/java/com/djrapitops/plan/ServerSpecificSettings.java b/Plan/src/main/java/com/djrapitops/plan/ServerSpecificSettings.java index 70845b88a..4cbcdae96 100644 --- a/Plan/src/main/java/com/djrapitops/plan/ServerSpecificSettings.java +++ b/Plan/src/main/java/com/djrapitops/plan/ServerSpecificSettings.java @@ -58,7 +58,7 @@ public class ServerSpecificSettings { } config.set(path, value); Log.debug(" " + path + ": " + value); - } catch (NullPointerException e) { + } catch (NullPointerException ignored) { } changedSomething = true; } diff --git a/Plan/src/main/java/com/djrapitops/plan/command/commands/AnalyzeCommand.java b/Plan/src/main/java/com/djrapitops/plan/command/commands/AnalyzeCommand.java index 466aeacab..a682ff2d8 100644 --- a/Plan/src/main/java/com/djrapitops/plan/command/commands/AnalyzeCommand.java +++ b/Plan/src/main/java/com/djrapitops/plan/command/commands/AnalyzeCommand.java @@ -53,8 +53,8 @@ public class AnalyzeCommand extends SubCommand { } Plan plugin = Plan.getInstance(); Optional serverName = plugin.getDB().getServerTable().getServerName(serverUUID); - if (serverName.isPresent()) { - String target = "/server/" + serverName.get(); + serverName.ifPresent(name -> { + String target = "/server/" + name; String url = plugin.getInfoManager().getLinkTo(target); String message = Locale.get(Msg.CMD_INFO_LINK).toString(); @@ -70,7 +70,7 @@ public class AnalyzeCommand extends SubCommand { } sender.sendMessage(Locale.get(Msg.CMD_CONSTANT_FOOTER).toString()); } - } + }); } @Override diff --git a/Plan/src/main/java/com/djrapitops/plan/data/Session.java b/Plan/src/main/java/com/djrapitops/plan/data/Session.java index 6f42a4706..af1bc5cc8 100644 --- a/Plan/src/main/java/com/djrapitops/plan/data/Session.java +++ b/Plan/src/main/java/com/djrapitops/plan/data/Session.java @@ -13,8 +13,8 @@ import java.util.Objects; *

* Includes: *

*

diff --git a/Plan/src/main/java/com/djrapitops/plan/database/Database.java b/Plan/src/main/java/com/djrapitops/plan/database/Database.java index bdfa2e85f..994a7af27 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/Database.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/Database.java @@ -118,10 +118,8 @@ public abstract class Database { /** * Initiates the database. - *

- * Default method returns false. * - * @return Was the initiation successful? + * @throws DatabaseInitException if SQLException or other exception occurs. */ public void init() throws DatabaseInitException { } @@ -175,7 +173,7 @@ public abstract class Database { public abstract void setVersion(int version) throws SQLException; /** - * Closes the database & it's resources. + * Closes the database and it's resources. * * @throws SQLException If a database error occurs. */ diff --git a/Plan/src/main/java/com/djrapitops/plan/database/databases/SQLDB.java b/Plan/src/main/java/com/djrapitops/plan/database/databases/SQLDB.java index 8b0018194..c44e50c9a 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/databases/SQLDB.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/databases/SQLDB.java @@ -18,7 +18,7 @@ import java.sql.SQLException; import java.util.UUID; /** - * Class containing main logic for different data related save & load functionality. + * Class containing main logic for different data related save and load functionality. * * @author Rsl1122 * @since 2.0.0 @@ -29,9 +29,6 @@ public abstract class SQLDB extends Database { private boolean open = false; private ITask dbCleanTask; - /** - * @param plugin - */ public SQLDB(IPlan plugin) { super(plugin); usingMySQL = getName().equals("MySQL"); @@ -62,7 +59,7 @@ public abstract class SQLDB extends Database { * Converts Unsaved Bukkit player files to database data. * Cleans the database. * - * @return Was the Initialization successful. + * @throws DatabaseInitException if Database fails to initiate. */ @Override public void init() throws DatabaseInitException { @@ -140,8 +137,6 @@ public abstract class SQLDB extends Database { * Creates the tables that contain data. *

* Updates table columns to latest schema. - * - * @return true if successful. */ private void createTables() throws DatabaseInitException { Benchmark.start("Create tables"); @@ -152,7 +147,9 @@ public abstract class SQLDB extends Database { } /** - * @return + * Get all tables in a good order. + * + * @return Table array. */ public Table[] getAllTables() { return new Table[]{ @@ -164,7 +161,7 @@ public abstract class SQLDB extends Database { } /** - * Get all tables except securityTable for removal of user data. + * Get all tables for removal of data. * * @return Tables in the order the data should be removed in. */ @@ -184,7 +181,9 @@ public abstract class SQLDB extends Database { public abstract void setupDataSource() throws DatabaseInitException; /** - * @throws SQLException + * Closes the SQLDB + * + * @throws SQLException DB Error */ @Override public void close() throws SQLException { @@ -205,10 +204,6 @@ public abstract class SQLDB extends Database { return versionTable.getVersion(); } - /** - * @param version - * @throws SQLException - */ @Override public void setVersion(int version) throws SQLException { versionTable.setVersion(version); @@ -219,10 +214,6 @@ public abstract class SQLDB extends Database { return versionTable.isNewDatabase(); } - /** - * @param uuid - * @return - */ @Override public boolean wasSeenBefore(UUID uuid) { if (uuid == null) { @@ -267,9 +258,6 @@ public abstract class SQLDB extends Database { Log.info("Clean complete."); } - /** - * @return - */ @Override public void removeAllData() throws SQLException { setStatus("Clearing all data"); diff --git a/Plan/src/main/java/com/djrapitops/plan/database/databases/SQLiteDB.java b/Plan/src/main/java/com/djrapitops/plan/database/databases/SQLiteDB.java index c8af425d9..33529559a 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/databases/SQLiteDB.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/databases/SQLiteDB.java @@ -22,10 +22,6 @@ public class SQLiteDB extends SQLDB { this(plugin, "database"); } - /** - * @param plugin - * @param dbName - */ public SQLiteDB(Plan plugin, String dbName) { super(plugin); this.dbName = dbName; diff --git a/Plan/src/main/java/com/djrapitops/plan/database/sql/TableSqlParser.java b/Plan/src/main/java/com/djrapitops/plan/database/sql/TableSqlParser.java index 6c2f2367d..ccf130ce8 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/sql/TableSqlParser.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/sql/TableSqlParser.java @@ -1,7 +1,7 @@ package main.java.com.djrapitops.plan.database.sql; /** - * SqlParser Class for parsing table creation, removal & modification statements. + * SqlParser Class for parsing table creation, removal and modification statements. * * @author Rsl1122 * @since 3.7.0 diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/ActionsTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/ActionsTable.java index 3541040f3..6e8707420 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/ActionsTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/ActionsTable.java @@ -94,9 +94,9 @@ public class ActionsTable extends UserIDTable { /** * Used to get all Actions done by a user on this server. * - * @param uuid - * @return - * @throws SQLException + * @param uuid UUID of the player + * @return List of actions done by the player. Does not include the kills. + * @throws SQLException DB Error */ public List getActions(UUID uuid) throws SQLException { List actions = new ArrayList<>(); diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/CommandUseTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/CommandUseTable.java index 385b3554c..4f03c9c85 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/CommandUseTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/CommandUseTable.java @@ -29,10 +29,6 @@ public class CommandUseTable extends Table { private final ServerTable serverTable; private String insertStatement; - /** - * @param db - * @param usingMySQL - */ public CommandUseTable(SQLDB db, boolean usingMySQL) { super("plan_commandusages", db, usingMySQL); serverTable = db.getServerTable(); @@ -43,9 +39,6 @@ public class CommandUseTable extends Table { + ") VALUES (?, ?, " + serverTable.statementSelectServerID + ")"; } - /** - * @return - */ @Override public void createTable() throws DBCreateTableException { ServerTable serverTable = db.getServerTable(); @@ -64,7 +57,7 @@ public class CommandUseTable extends Table { * Used to get all commands used in this server. * * @return command - times used Map - * @throws SQLException + * @throws SQLException DB Error */ public Map getCommandUse() throws SQLException { return getCommandUse(Plan.getServerUUID()); @@ -75,7 +68,7 @@ public class CommandUseTable extends Table { * * @param serverUUID UUID of the server. * @return command - times used Map - * @throws SQLException + * @throws SQLException DB Error */ public Map getCommandUse(UUID serverUUID) throws SQLException { Map commandUse = new HashMap<>(); diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/IPsTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/IPsTable.java index 23204bdcd..24e4cdcca 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/IPsTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/IPsTable.java @@ -37,9 +37,6 @@ public class IPsTable extends UserIDTable { + "?, ?)"; } - /** - * @return if the table was created successfully - */ @Override public void createTable() throws DBCreateTableException { createTable(TableSqlParser.createTable(tableName) diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/KillsTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/KillsTable.java index 842f7b135..085f14482 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/KillsTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/KillsTable.java @@ -30,10 +30,6 @@ public class KillsTable extends UserIDTable { private final SessionsTable sessionsTable; private String insertStatement; - /** - * @param db - * @param usingMySQL - */ public KillsTable(SQLDB db, boolean usingMySQL) { super("plan_kills", db, usingMySQL); sessionsTable = db.getSessionsTable(); @@ -49,9 +45,6 @@ public class KillsTable extends UserIDTable { + "?, ?, ?)"; } - /** - * @return - */ @Override public void createTable() throws DBCreateTableException { createTable(TableSqlParser.createTable(tableName) @@ -154,7 +147,7 @@ public class KillsTable extends UserIDTable { public Map> getPlayerKills(UUID serverUUID) throws SQLException { PreparedStatement statement = null; ResultSet set = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { String usersVictimIDColumn = usersTable + "." + usersTable.getColumnID(); String usersKillerIDColumn = "a." + usersTable.getColumnID(); String usersVictimUUIDColumn = usersTable + "." + usersTable.getColumnUUID() + " as victim_uuid"; @@ -206,7 +199,7 @@ public class KillsTable extends UserIDTable { return; } PreparedStatement statement = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { statement = connection.prepareStatement(insertStatement); String[] gms = GMTimes.getGMKeyArray(); for (UUID serverUUID : allSessions.keySet()) { @@ -240,7 +233,7 @@ public class KillsTable extends UserIDTable { public Map> getAllPlayerKillsBySessionID() throws SQLException { PreparedStatement statement = null; ResultSet set = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { String usersIDColumn = usersTable + "." + usersTable.getColumnID(); String usersUUIDColumn = usersTable + "." + usersTable.getColumnUUID() + " as victim_uuid"; statement = connection.prepareStatement("SELECT " + diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/NicknamesTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/NicknamesTable.java index d20cd60f5..2ed7e30a9 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/NicknamesTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/NicknamesTable.java @@ -41,9 +41,6 @@ public class NicknamesTable extends UserIDTable { "?)"; } - /** - * @return if the table was created successfully - */ @Override public void createTable() throws DBCreateTableException { createTable(TableSqlParser.createTable(tableName) diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/ServerTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/ServerTable.java index c29d5eb04..cdea92cf3 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/ServerTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/ServerTable.java @@ -108,7 +108,7 @@ public class ServerTable extends Table { * * @param info Info to instert (All variables should be present. * @throws IllegalStateException if one of the ServerInfo variables is null - * @throws SQLException + * @throws SQLException DB Error */ private void saveNewServerInfo(ServerInfo info) throws SQLException { UUID uuid = info.getUuid(); @@ -137,7 +137,7 @@ public class ServerTable extends Table { * * @param serverUUID UUID of the server. * @return ID or or empty optional. - * @throws SQLException + * @throws SQLException DB Error */ public Optional getServerID(UUID serverUUID) throws SQLException { PreparedStatement statement = null; @@ -164,7 +164,7 @@ public class ServerTable extends Table { * * @param serverUUID UUID of the server. * @return Name or empty optional. - * @throws SQLException + * @throws SQLException DB Error */ public Optional getServerName(UUID serverUUID) throws SQLException { PreparedStatement statement = null; @@ -209,7 +209,7 @@ public class ServerTable extends Table { * Used to get BungeeCord WebServer info if present. * * @return information about Bungee server. - * @throws SQLException + * @throws SQLException DB Error */ public Optional getBungeeInfo() throws SQLException { PreparedStatement statement = null; diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/SessionsTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/SessionsTable.java index a1d23f1c2..8e23f7029 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/SessionsTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/SessionsTable.java @@ -32,10 +32,6 @@ public class SessionsTable extends UserIDTable { private final ServerTable serverTable; private String insertStatement; - /** - * @param db - * @param usingMySQL - */ public SessionsTable(SQLDB db, boolean usingMySQL) { super("plan_sessions", db, usingMySQL); serverTable = db.getServerTable(); @@ -52,9 +48,6 @@ public class SessionsTable extends UserIDTable { + serverTable.statementSelectServerID + ")"; } - /** - * @return - */ @Override public void createTable() throws DBCreateTableException { createTable(TableSqlParser.createTable(this.tableName) @@ -79,7 +72,7 @@ public class SessionsTable extends UserIDTable { * * @param uuid UUID of the player. * @param session Session of the player that has ended ({@code endSession} has been called) - * @throws SQLException + * @throws SQLException DB Error */ public void saveSession(UUID uuid, Session session) throws SQLException { saveSessionInformation(uuid, session); @@ -99,7 +92,7 @@ public class SessionsTable extends UserIDTable { * * @param uuid UUID of the player. * @param session Session of the player that has ended ({@code endSession} has been called) - * @throws SQLException + * @throws SQLException DB Error */ private void saveSessionInformation(UUID uuid, Session session) throws SQLException { PreparedStatement statement = null; @@ -156,7 +149,7 @@ public class SessionsTable extends UserIDTable { * * @param uuid UUID of the player * @return Map with Sessions that don't contain Kills or WorldTimes. - * @throws SQLException + * @throws SQLException DB Error */ private Map> getSessionInformation(UUID uuid) throws SQLException { Map serverNames = serverTable.getServerNames(); @@ -205,7 +198,7 @@ public class SessionsTable extends UserIDTable { * * @param uuid UUID of the player. * @return Milliseconds played on THIS server. 0 if player or server not found. - * @throws SQLException + * @throws SQLException DB Error */ public long getPlaytime(UUID uuid) throws SQLException { return getPlaytime(uuid, Plan.getServerUUID()); @@ -217,7 +210,7 @@ public class SessionsTable extends UserIDTable { * @param uuid UUID of the player. * @param afterDate Epoch ms (Playtime after this date is calculated) * @return Milliseconds played on THIS server. 0 if player or server not found. - * @throws SQLException + * @throws SQLException DB Error */ public long getPlaytime(UUID uuid, long afterDate) throws SQLException { return getPlaytime(uuid, Plan.getServerUUID(), afterDate); @@ -229,7 +222,7 @@ public class SessionsTable extends UserIDTable { * @param uuid UUID of the player. * @param serverUUID UUID of the server. @see ServerTable * @return Milliseconds played on the server. 0 if player or server not found. - * @throws SQLException + * @throws SQLException DB Error */ public long getPlaytime(UUID uuid, UUID serverUUID) throws SQLException { return getPlaytime(uuid, serverUUID, 0L); @@ -242,7 +235,7 @@ public class SessionsTable extends UserIDTable { * @param serverUUID UUID of the server. @see ServerTable * @param afterDate Epoch ms (Playtime after this date is calculated) * @return Milliseconds played after given epoch ms on the server. 0 if player or server not found. - * @throws SQLException + * @throws SQLException DB Error */ public long getPlaytime(UUID uuid, UUID serverUUID, long afterDate) throws SQLException { PreparedStatement statement = null; @@ -272,7 +265,7 @@ public class SessionsTable extends UserIDTable { * * @param uuid UUID of the Player. * @return key - ServerName, value ms played - * @throws SQLException + * @throws SQLException DB Error */ public Map getPlaytimeByServer(UUID uuid) throws SQLException { return getPlaytimeByServer(uuid, 0L); @@ -284,7 +277,7 @@ public class SessionsTable extends UserIDTable { * @param uuid UUID of the Player. * @param afterDate Epoch ms (Playtime after this date is calculated) * @return key - ServerName, value ms played - * @throws SQLException + * @throws SQLException DB Error */ public Map getPlaytimeByServer(UUID uuid, long afterDate) throws SQLException { Map serverNames = serverTable.getServerNames(); @@ -317,7 +310,7 @@ public class SessionsTable extends UserIDTable { * Used to get the Total Playtime of THIS Server. * * @return Milliseconds played on the server. 0 if server not found. - * @throws SQLException + * @throws SQLException DB Error */ public long getPlaytimeOfServer() throws SQLException { return getPlaytimeOfServer(Plan.getServerUUID()); @@ -328,7 +321,7 @@ public class SessionsTable extends UserIDTable { * * @param serverUUID UUID of the server. * @return Milliseconds played on the server. 0 if server not found. - * @throws SQLException + * @throws SQLException DB Error */ public long getPlaytimeOfServer(UUID serverUUID) throws SQLException { return getPlaytimeOfServer(serverUUID, 0L); @@ -339,7 +332,7 @@ public class SessionsTable extends UserIDTable { * * @param afterDate Epoch ms (Playtime after this date is calculated) * @return Milliseconds played after given epoch ms on the server. 0 if server not found. - * @throws SQLException + * @throws SQLException DB Error */ public long getPlaytimeOfServer(long afterDate) throws SQLException { return getPlaytimeOfServer(Plan.getServerUUID(), afterDate); @@ -351,7 +344,7 @@ public class SessionsTable extends UserIDTable { * @param serverUUID UUID of the server. * @param afterDate Epoch ms (Playtime after this date is calculated) * @return Milliseconds played after given epoch ms on the server. 0 if server not found. - * @throws SQLException + * @throws SQLException DB Error */ public long getPlaytimeOfServer(UUID serverUUID, long afterDate) throws SQLException { PreparedStatement statement = null; @@ -380,7 +373,7 @@ public class SessionsTable extends UserIDTable { * * @param uuid UUID of the player. * @return How many sessions player has. 0 if player or server not found. - * @throws SQLException + * @throws SQLException DB Error */ public int getSessionCount(UUID uuid) throws SQLException { return getSessionCount(uuid, 0L); @@ -392,7 +385,7 @@ public class SessionsTable extends UserIDTable { * @param uuid UUID of the player. * @param afterDate Epoch ms (Session count after this date is calculated) * @return How many sessions player has. 0 if player or server not found. - * @throws SQLException + * @throws SQLException DB Error */ public int getSessionCount(UUID uuid, long afterDate) throws SQLException { return getSessionCount(uuid, Plan.getServerUUID(), afterDate); @@ -404,7 +397,7 @@ public class SessionsTable extends UserIDTable { * @param uuid UUID of the player. * @param serverUUID UUID of the server. * @return How many sessions player has. 0 if player or server not found. - * @throws SQLException + * @throws SQLException DB Error */ public int getSessionCount(UUID uuid, UUID serverUUID) throws SQLException { return getSessionCount(uuid, serverUUID, 0L); @@ -417,7 +410,7 @@ public class SessionsTable extends UserIDTable { * @param serverUUID UUID of the server. * @param afterDate Epoch ms (Session count after this date is calculated) * @return How many sessions player has. 0 if player or server not found. - * @throws SQLException + * @throws SQLException DB Error */ public int getSessionCount(UUID uuid, UUID serverUUID, long afterDate) throws SQLException { PreparedStatement statement = null; diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/TPSTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/TPSTable.java index c6f0dfa81..d1faf3e38 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/TPSTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/TPSTable.java @@ -38,10 +38,6 @@ public class TPSTable extends Table { private final ServerTable serverTable; private String insertStatement; - /** - * @param db - * @param usingMySQL - */ public TPSTable(SQLDB db, boolean usingMySQL) { super("plan_tps", db, usingMySQL); serverTable = db.getServerTable(); @@ -83,7 +79,7 @@ public class TPSTable extends Table { List data = new ArrayList<>(); PreparedStatement statement = null; ResultSet set = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { statement = connection.prepareStatement(Select.all(tableName) .where(columnServerID + "=" + serverTable.statementSelectServerID) .toString()); @@ -109,7 +105,7 @@ public class TPSTable extends Table { public void insertTPS(TPS tps) throws SQLException { PreparedStatement statement = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { statement = connection.prepareStatement(insertStatement); statement.setString(1, Plan.getServerUUID().toString()); @@ -129,7 +125,9 @@ public class TPSTable extends Table { } /** - * @throws SQLException + * Clean the TPS Table of old data. + * + * @throws SQLException DB Error */ public void clean() throws SQLException { Optional allTimePeak = getAllTimePeak(); @@ -138,7 +136,7 @@ public class TPSTable extends Table { p = allTimePeak.get().getPlayers(); } PreparedStatement statement = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { statement = connection.prepareStatement("DELETE FROM " + tableName + " WHERE (" + columnDate + " getPeakPlayerCount(UUID serverUUID, long afterDate) throws SQLException { PreparedStatement statement = null; ResultSet set = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { statement = connection.prepareStatement(Select.all(tableName) .where(columnServerID + "=" + serverTable.statementSelectServerID) .and(columnPlayers + "= (SELECT MAX(" + columnPlayers + ") FROM " + tableName + ")") @@ -199,7 +197,7 @@ public class TPSTable extends Table { public Map> getAllTPS() throws SQLException { PreparedStatement statement = null; ResultSet set = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { String serverIDColumn = serverTable + "." + serverTable.getColumnID(); String serverUUIDColumn = serverTable + "." + serverTable.getColumnUUID() + " as s_uuid"; statement = connection.prepareStatement("SELECT " + @@ -244,7 +242,7 @@ public class TPSTable extends Table { return; } PreparedStatement statement = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { statement = connection.prepareStatement(insertStatement); // Every Server @@ -275,7 +273,7 @@ public class TPSTable extends Table { public List getNetworkOnlineData() throws SQLException { PreparedStatement statement = null; ResultSet set = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { statement = connection.prepareStatement("SELECT " + columnDate + ", " + "SUM(" + columnPlayers + ") as players" + diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/Table.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/Table.java index 2b70b2136..14c01c091 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/Table.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/Table.java @@ -3,16 +3,12 @@ package main.java.com.djrapitops.plan.database.tables; import com.djrapitops.plugin.utilities.Verify; import com.google.common.base.Objects; import main.java.com.djrapitops.plan.api.exceptions.DBCreateTableException; -import main.java.com.djrapitops.plan.database.Container; -import main.java.com.djrapitops.plan.database.DBUtils; import main.java.com.djrapitops.plan.database.databases.SQLDB; import main.java.com.djrapitops.plan.utilities.MiscUtils; import java.sql.Connection; import java.sql.SQLException; import java.sql.Statement; -import java.util.List; -import java.util.Map; /** * @author Rsl1122 @@ -35,9 +31,11 @@ public abstract class Table { protected final boolean usingMySQL; /** - * @param name - * @param db - * @param usingMySQL + * Constructor. + * + * @param name Name of the table in the db. + * @param db Database to use. + * @param usingMySQL Is the database using MySQL? */ public Table(String name, SQLDB db, boolean usingMySQL) { this.tableName = name; @@ -45,9 +43,6 @@ public abstract class Table { this.usingMySQL = usingMySQL; } - /** - * @return - */ public abstract void createTable() throws DBCreateTableException; protected void createTable(String sql) throws DBCreateTableException { @@ -59,29 +54,35 @@ public abstract class Table { } /** - * @return - * @throws SQLException + * Used to get a new Connection to the Database. + * + * @return SQL Connection + * @throws SQLException DB Error */ protected Connection getConnection() throws SQLException { return db.getConnection(); } /** - * @return - * @throws SQLException + * Get the Database Schema version from VersionTable. + * + * @return Database Schema version. + * @throws SQLException DB Error */ public int getVersion() throws SQLException { return db.getVersion(); } /** - * @param statementString - * @return - * @throws SQLException + * Executes an SQL Statement + * + * @param statementString Statement to execute + * @return What execute returns. + * @throws SQLException DB error */ protected boolean execute(String statementString) throws SQLException { Statement statement = null; - try (Connection connection = getConnection()){ + try (Connection connection = getConnection()) { statement = connection.createStatement(); boolean b = statement.execute(statementString); commit(connection); @@ -108,35 +109,25 @@ public abstract class Table { } /** - * @param toClose + * Closes DB elements. + * + * @param toClose All elements to close. */ protected void close(AutoCloseable... toClose) { MiscUtils.close(toClose); } - /** - * @return - */ public String getTableName() { return tableName; } /** - * @return + * Removes all data from the table. */ public void removeAllData() throws SQLException { execute("DELETE FROM " + tableName); } - /** - * @param - * @param objects - * @return - */ - protected List>> splitIntoBatches(Map> objects) { - return DBUtils.splitIntoBatchesId(objects); - } - protected void addColumns(String... columnInfo) { for (int i = 0; i < columnInfo.length; i++) { columnInfo[i] = "ALTER TABLE " + tableName + " ADD " + (usingMySQL ? "" : "COLUMN ") + columnInfo[i]; diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/UserInfoTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/UserInfoTable.java index 607d67fb1..c75f0be4e 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/UserInfoTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/UserInfoTable.java @@ -89,10 +89,7 @@ public class UserInfoTable extends UserIDTable { .toString()); statement.setString(1, uuid.toString()); set = statement.executeQuery(); - if (set.next()) { - return set.getInt("c") >= 1; - } - return false; + return set.next() && set.getInt("c") >= 1; } finally { close(set, statement); } diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/UsersTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/UsersTable.java index d9ac2bb53..bfa8881a8 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/UsersTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/UsersTable.java @@ -25,10 +25,6 @@ public class UsersTable extends UserIDTable { private final String columnTimesKicked = "times_kicked"; private String insertStatement; - /** - * @param db - * @param usingMySQL - */ public UsersTable(SQLDB db, boolean usingMySQL) { super("plan_users", db, usingMySQL); statementSelectID = "(" + Select.from(tableName, tableName + "." + columnID).where(columnUUID + "=?").toString() + ")"; @@ -38,9 +34,6 @@ public class UsersTable extends UserIDTable { columnName); } - /** - * @return - */ @Override public void createTable() throws DBCreateTableException { createTable(TableSqlParser.createTable(tableName) @@ -79,8 +72,10 @@ public class UsersTable extends UserIDTable { } /** + * Remove a user from Users Table. + * * @param uuid the UUID of the user that should be removed. - * @return if the removal was successful. + * @throws SQLException DB Error */ @Override public void removeUser(UUID uuid) throws SQLException { @@ -111,18 +106,20 @@ public class UsersTable extends UserIDTable { } /** - * @param playername - * @return - * @throws SQLException + * Get UUID of a player. + * + * @param playerName Name of a player + * @return UUID of the player + * @throws SQLException DB Error */ - public UUID getUuidOf(String playername) throws SQLException { + public UUID getUuidOf(String playerName) throws SQLException { PreparedStatement statement = null; ResultSet set = null; try (Connection connection = getConnection()) { statement = connection.prepareStatement(Select.from(tableName, columnUUID) .where("UPPER(" + columnName + ")=UPPER(?)") .toString()); - statement.setString(1, playername); + statement.setString(1, playerName); set = statement.executeQuery(); if (set.next()) { String uuidS = set.getString(columnUUID); @@ -156,7 +153,7 @@ public class UsersTable extends UserIDTable { * @param uuid UUID of the player. * @param registered Register date. * @param name Name of the player. - * @throws SQLException + * @throws SQLException DB Error * @throws IllegalArgumentException If uuid or name are null. */ public void registerUser(UUID uuid, long registered, String name) throws SQLException { @@ -185,10 +182,7 @@ public class UsersTable extends UserIDTable { .toString()); statement.setString(1, uuid.toString()); set = statement.executeQuery(); - if (set.next()) { - return set.getInt("c") >= 1; - } - return false; + return set.next() && set.getInt("c") >= 1; } finally { close(set, statement); } @@ -308,8 +302,8 @@ public class UsersTable extends UserIDTable { * This method is for batch operations, and should not be used to add information of users. * Use UserInfoTable instead. * - * @param users - * @throws SQLException + * @param users Users to insert + * @throws SQLException DB Error */ public void insertUsers(Map users) throws SQLException { if (Verify.isEmpty(users)) { diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/VersionTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/VersionTable.java index b1489579c..d554b0291 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/VersionTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/VersionTable.java @@ -16,17 +16,10 @@ import java.sql.SQLException; */ public class VersionTable extends Table { - /** - * @param db - * @param usingMySQL - */ public VersionTable(SQLDB db, boolean usingMySQL) { super("plan_version", db, usingMySQL); } - /** - * @return - */ @Override public void createTable() throws DBCreateTableException { createTable(TableSqlParser.createTable(tableName) @@ -77,8 +70,10 @@ public class VersionTable extends Table { } /** - * @param version - * @throws SQLException + * Set the DB Schema version + * + * @param version DB Schema version + * @throws SQLException DB Error */ public void setVersion(int version) throws SQLException { removeAllData(); diff --git a/Plan/src/main/java/com/djrapitops/plan/database/tables/move/BatchOperationTable.java b/Plan/src/main/java/com/djrapitops/plan/database/tables/move/BatchOperationTable.java index cba75aad6..b193fbd43 100644 --- a/Plan/src/main/java/com/djrapitops/plan/database/tables/move/BatchOperationTable.java +++ b/Plan/src/main/java/com/djrapitops/plan/database/tables/move/BatchOperationTable.java @@ -32,7 +32,7 @@ import java.util.UUID; *

* clearTable methods can be used to clear the table beforehand. *

- * Server & User tables should be copied first. + * Server and User tables should be copied first. * * @author Rsl1122 * @since 4.0.0 @@ -42,7 +42,7 @@ public class BatchOperationTable extends Table { /** * Constructor, call to access copy functionality. * - * @param database + * @param database Database to copy things from * @throws IllegalStateException if database.init has not been called. * @throws ClassCastException if database is not SQLDB. */ diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/cache/DataCache.java b/Plan/src/main/java/com/djrapitops/plan/systems/cache/DataCache.java index dc654f983..23e236fd3 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/cache/DataCache.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/cache/DataCache.java @@ -14,7 +14,7 @@ import java.util.*; *

* * @author Rsl1122 @@ -114,8 +114,10 @@ public class DataCache extends SessionCache { } /** - * @param uuid - * @return + * Check if a session is player's first session on the server. + * + * @param uuid UUID of the player + * @return true / false */ public boolean isFirstSession(UUID uuid) { return firstSessionInformation.containsKey(uuid); diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/info/BukkitInformationManager.java b/Plan/src/main/java/com/djrapitops/plan/systems/info/BukkitInformationManager.java index 90be5a21e..060c75c70 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/info/BukkitInformationManager.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/info/BukkitInformationManager.java @@ -318,7 +318,7 @@ public class BukkitInformationManager extends InformationManager { if (usingAnotherWebServer) { try { getWebAPI().getAPI(PostNetworkPageContentWebAPI.class).sendNetworkContent(webServerAddress, HtmlStructure.createServerContainer(plugin)); - } catch (WebAPIException e) { + } catch (WebAPIException ignored) { } } } diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/info/server/BukkitServerInfoManager.java b/Plan/src/main/java/com/djrapitops/plan/systems/info/server/BukkitServerInfoManager.java index 1bbdc7300..217816310 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/info/server/BukkitServerInfoManager.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/info/server/BukkitServerInfoManager.java @@ -124,8 +124,8 @@ public class BukkitServerInfoManager { /** * Saves Bungee connection information to local file on Bukkit servers. * - * @param address - * @throws IOException + * @param address Address to save + * @throws IOException If ServerInfo file can not be written to. */ public void saveBungeeConnectionAddress(String address) throws IOException { serverInfoFile.saveInfo(serverInfo, new ServerInfo(-1, null, "Bungee", address, -1)); diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/info/server/ServerInfoFile.java b/Plan/src/main/java/com/djrapitops/plan/systems/info/server/ServerInfoFile.java index 58891a330..1fd934b00 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/info/server/ServerInfoFile.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/info/server/ServerInfoFile.java @@ -20,7 +20,7 @@ import java.util.UUID; /** * Manages local server info file. *

- * ServerInfo.yml contains current server's ID, UUID & Bungee WebServer connection information. + * ServerInfo.yml contains current server's ID, UUID and Bungee WebServer connection information. * It * * @author Rsl1122 diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/queue/Queue.java b/Plan/src/main/java/com/djrapitops/plan/systems/queue/Queue.java index 887fed7fa..26796f34d 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/queue/Queue.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/queue/Queue.java @@ -34,7 +34,7 @@ public abstract class Queue { } /** - * Used to stop the queue processing & get the unprocessed objects. + * Used to stop the queue processing and get the unprocessed objects. * * @return List of unprocessed objects. */ diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/ResponseHandler.java b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/ResponseHandler.java index 8cc7dffed..a99e72479 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/ResponseHandler.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/ResponseHandler.java @@ -27,14 +27,12 @@ import java.util.UUID; public class ResponseHandler extends APIResponseHandler { private final IPlan plugin; - private final WebServer webServer; private final boolean usingHttps; public ResponseHandler(IPlan plugin, WebServer webServer) { super(webServer.getWebAPI()); this.plugin = plugin; - this.webServer = webServer; this.usingHttps = webServer.isUsingHTTPS(); } diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/WebServer.java b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/WebServer.java index da586d960..bdfc776c0 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/WebServer.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/WebServer.java @@ -43,9 +43,6 @@ public class WebServer { private boolean usingHttps = false; - /** - * @param plugin - */ public WebServer(IPlan plugin) { this.plugin = plugin; this.port = Settings.WEBSERVER_PORT.getNumber(); diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/response/AnalysisPageResponse.java b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/response/AnalysisPageResponse.java index 4bf724549..b4f41114f 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/response/AnalysisPageResponse.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/response/AnalysisPageResponse.java @@ -13,7 +13,9 @@ import main.java.com.djrapitops.plan.systems.info.InformationManager; public class AnalysisPageResponse extends Response { /** - * @param informationManager + * Constructor. + * + * @param informationManager InformationManager to use for getting the Html * @throws NullPointerException if AnalysisData has not been cached after 1 second. */ public AnalysisPageResponse(InformationManager informationManager) { diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/WebAPIManager.java b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/WebAPIManager.java index 8d94025dc..3707fe071 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/WebAPIManager.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/WebAPIManager.java @@ -9,7 +9,7 @@ import main.java.com.djrapitops.plan.utilities.PassEncryptUtil; import java.util.*; /** - * @author Fuzzlemann & Rsl1122 + * @author Fuzzlemann and Rsl1122 */ public class WebAPIManager { diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bukkit/RequestInspectPluginsTabBukkitWebAPI.java b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bukkit/RequestInspectPluginsTabBukkitWebAPI.java index 3e423be14..d40755320 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bukkit/RequestInspectPluginsTabBukkitWebAPI.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bukkit/RequestInspectPluginsTabBukkitWebAPI.java @@ -17,7 +17,7 @@ import java.util.UUID; /** * WebAPI for requesting Inspect plugins tab contents from a Bukkit Server. *

- * Call: Bungee -> Bukkit + * Call: Bungee to Bukkit *

* Bad Requests: * - Called a Bungee Server diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bungee/PostInspectPluginsTabWebAPI.java b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bungee/PostInspectPluginsTabWebAPI.java index 3de307e9d..685dedadc 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bungee/PostInspectPluginsTabWebAPI.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bungee/PostInspectPluginsTabWebAPI.java @@ -16,7 +16,7 @@ import java.util.UUID; /** * WebAPI for posting Inspect page Plugins tab contents to the Bungee server. *

- * Call: Bukkit -> Bungee + * Call: Bukkit to Bungee *

* Bad Requests: * - Did not include uuid diff --git a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bungee/RequestPluginsTabWebAPI.java b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bungee/RequestPluginsTabWebAPI.java index ae3d6b2d7..a12f860f4 100644 --- a/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bungee/RequestPluginsTabWebAPI.java +++ b/Plan/src/main/java/com/djrapitops/plan/systems/webserver/webapi/bungee/RequestPluginsTabWebAPI.java @@ -22,7 +22,7 @@ import java.util.UUID; /** * WebAPI for requesting Bungee Server to request Plugins tab contents from every server. *

- * Call: Bukkit -> Bungee + * Call: Bukkit to Bungee *

* Bad Requests: * - Called a Bukkit Server diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/Benchmark.java b/Plan/src/main/java/com/djrapitops/plan/utilities/Benchmark.java index 173f89e10..938eeb1ce 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/Benchmark.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/Benchmark.java @@ -16,15 +16,19 @@ public class Benchmark { } /** - * @param source + * Start a benchmark. + * + * @param source Thing to bench. */ public static void start(String source) { getBenchUtil().start(source); } /** - * @param source - * @return + * End a benchmark. + * + * @param source Thing to stop benching. + * @return ms it took. */ public static long stop(String source) { long ms = getBenchUtil().stop(source); diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/FormatUtils.java b/Plan/src/main/java/com/djrapitops/plan/utilities/FormatUtils.java index 14465fdf4..9167565ee 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/FormatUtils.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/FormatUtils.java @@ -23,42 +23,34 @@ public class FormatUtils { } /** - * @param ms - * @return + * Format time amount according to the config settings. + * + * @param ms Milliseconds. + * @return String formatted with the config settings. */ public static String formatTimeAmount(long ms) { return formatMilliseconds(ms); } /** - * @param before - * @param after - * @return + * Format the time difference between an end point and a start point. + * + * @param before Epoch ms. + * @param after Epoch ms. + * @return String formatted with the config settings. */ public static String formatTimeAmountDifference(long before, long after) { return formatMilliseconds(Math.abs(after - before)); } - /** - * @param epochMs - * @return - */ public static String formatTimeStamp(long epochMs) { return FormattingUtils.formatTimeStamp(epochMs); } - /** - * @param epochMs - * @return - */ public static String formatTimeStampSecond(long epochMs) { return FormattingUtils.formatTimeStampSecond(epochMs); } - /** - * @param epochMs - * @return - */ public static String formatTimeStampYear(long epochMs) { return FormattingUtils.formatTimeStampYear(epochMs); } @@ -66,8 +58,8 @@ public class FormatUtils { /** * Removes letters from a string leaving only numbers and dots. * - * @param dataPoint - * @return + * @param dataPoint String to remove stuff from. + * @return String with the stuff removed. */ public static String removeLetters(String dataPoint) { return Format.create(dataPoint) @@ -78,8 +70,10 @@ public class FormatUtils { } /** - * @param dataPoint - * @return + * Removes numbers from a string leaving only letters. + * + * @param dataPoint String to remove stuff from. + * @return String with the stuff removed. */ public static String removeNumbers(String dataPoint) { return Format.create(dataPoint) @@ -176,8 +170,10 @@ public class FormatUtils { } /** - * @param d - * @return + * Remove extra decimals from the end of the double. + * + * @param d Double. + * @return String format of the double. */ public static String cutDecimals(double d) { return df.format(d); diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/ManageUtils.java b/Plan/src/main/java/com/djrapitops/plan/utilities/ManageUtils.java index 920dc823c..822f92384 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/ManageUtils.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/ManageUtils.java @@ -28,7 +28,6 @@ public class ManageUtils { * * @param dbName Name of database (mysql/sqlite) * @param copyFromDB Database you want to backup. - * @return success? */ public static void backup(String dbName, Database copyFromDB) throws DatabaseInitException, SQLException { Plan plugin = Plan.getInstance(); @@ -66,7 +65,6 @@ public class ManageUtils { * @param clearAndCopyToDB Database that will be cleared data will be copied * to. * @param copyFromDB Database where data will be copied from - * @return success? */ public static void clearAndCopy(Database clearAndCopyToDB, Database copyFromDB) throws SQLException { BatchOperationTable toDB = new BatchOperationTable(clearAndCopyToDB); diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/MiscUtils.java b/Plan/src/main/java/com/djrapitops/plan/utilities/MiscUtils.java index 5bc7e1196..b6022a234 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/MiscUtils.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/MiscUtils.java @@ -48,9 +48,11 @@ public class MiscUtils { } /** - * @param args - * @param sender - * @return + * Get a players name that matches the given arguments or name of the sender. + * + * @param args Arguments of command. + * @param sender Sender of command + * @return Player name. */ public static String getPlayerName(String[] args, ISender sender) { return getPlayerName(args, sender, Permissions.INSPECT_OTHER); @@ -61,7 +63,7 @@ public class MiscUtils { * * @param args Arguments of a command, must not be empty if console sender. * @param sender Command sender - * @param perm + * @param perm Permission to use when checking. No permission will notify user. * @return The name of the player (first argument or sender) */ public static String getPlayerName(String[] args, ISender sender, Permissions perm) { diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/Analysis.java b/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/Analysis.java index df980f33b..c2ea3dcf9 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/Analysis.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/Analysis.java @@ -97,8 +97,10 @@ public class Analysis { } /** + * Analyze data in the db about this server. + * * @param infoManager InformationManager of the plugin. - * @return + * @return Success? */ public boolean analyzeData(InformationManager infoManager, Database db) { try { @@ -210,7 +212,9 @@ public class Analysis { } /** - * @return + * Check whether or not analysis is being run. + * + * @return true / false (state) */ public boolean isAnalysisBeingRun() { return taskId != -1; diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/AnalysisUtils.java b/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/AnalysisUtils.java index 0a35662cd..7238fe6ae 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/AnalysisUtils.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/AnalysisUtils.java @@ -26,13 +26,6 @@ public class AnalysisUtils { throw new IllegalStateException("Utility class"); } - /** - * @param now - * @param lastPlayed - * @param playTime - * @param loginTimes - * @return - */ public static boolean isActive(long now, long lastPlayed, long playTime, int loginTimes) { int timeToActive = 10; long twoWeeks = 1209600000; @@ -41,12 +34,6 @@ public class AnalysisUtils { && playTime > 60 * timeToActive; } - /** - * @param registered - * @param scale - * @param now - * @return - */ public static long getNewPlayers(List registered, long scale, long now) { long newPlayers = 0; if (!registered.isEmpty()) { @@ -59,10 +46,6 @@ public class AnalysisUtils { return newPlayers; } - /** - * @param data - * @return - */ public static List transformSessionDataToLengths(Collection data) { return data.stream() .filter(Objects::nonNull) @@ -71,12 +54,6 @@ public class AnalysisUtils { .collect(Collectors.toList()); } - /** - * @param analysisType - * @param source - * @param uuids - * @return - */ public static String getTotal(AnalysisType analysisType, PluginData source, Collection uuids) { if (analysisType == null) { return source.parseContainer("Err ", "Null Analysistype. "); @@ -112,12 +89,6 @@ public class AnalysisUtils { .filter(value -> !value.equals(-1L)); } - /** - * @param analysisType - * @param source - * @param uuids - * @return - */ public static String getAverage(AnalysisType analysisType, PluginData source, Collection uuids) { if (analysisType == null) { return source.parseContainer("Err ", "Null Analysistype. "); @@ -150,12 +121,6 @@ public class AnalysisUtils { } } - /** - * @param analysisType - * @param source - * @param uuids - * @return - */ public static String getBooleanPercentage(AnalysisType analysisType, PluginData source, Collection uuids) { if (analysisType != AnalysisType.BOOLEAN_PERCENTAGE) { return source.parseContainer("Err ", "Wrong Analysistype specified: " + analysisType.name()); @@ -172,12 +137,6 @@ public class AnalysisUtils { } } - /** - * @param analysisType - * @param source - * @param uuids - * @return - */ public static String getBooleanTotal(AnalysisType analysisType, PluginData source, Collection uuids) { if (analysisType != AnalysisType.BOOLEAN_TOTAL) { return source.parseContainer("Err ", "Wrong Analysistype specified: " + analysisType.name()); @@ -224,11 +183,6 @@ public class AnalysisUtils { return uniqueJoins.size(); } - /** - * @param sessions - * @param scale - * @return - */ public static int getUniqueJoinsPerDay(Map> sessions, long scale) { Map> uniqueJoins = new HashMap<>(); long now = MiscUtils.getTime(); diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/ExportUtility.java b/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/ExportUtility.java index 4342ed2eb..40d2d7e9d 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/ExportUtility.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/analysis/ExportUtility.java @@ -8,7 +8,6 @@ import main.java.com.djrapitops.plan.data.UserInfo; import main.java.com.djrapitops.plan.systems.webserver.response.PlayersPageResponse; import java.io.File; -import java.io.FileNotFoundException; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Paths; @@ -28,9 +27,6 @@ public class ExportUtility { throw new IllegalStateException("Utility class"); } - /** - * @return - */ public static File getFolder() { String path = Settings.ANALYSIS_EXPORT_PATH.toString(); @@ -50,10 +46,6 @@ public class ExportUtility { return folder; } - /** - * @param analysisData - * @param playerNames - */ public static void export(AnalysisData analysisData, List playerNames) { if (!Settings.ANALYSIS_EXPORT.isTrue()) { return; @@ -84,20 +76,12 @@ public class ExportUtility { // } } - /** - * @param folder - * @return - */ public static File getPlayersFolder(File folder) { File playersFolder = new File(folder, "player"); playersFolder.mkdirs(); return playersFolder; } - /** - * @param userInfo - * @param playersFolder - */ public static void writeInspectHtml(UserInfo userInfo, File playersFolder, String playerHtml) { if (!Settings.ANALYSIS_EXPORT.isTrue()) { return; @@ -127,12 +111,6 @@ public class ExportUtility { // } } - /** - * @param analysisData - * @param serverFolder - * @throws FileNotFoundException - * @throws IOException - */ public static void writeAnalysisHtml(AnalysisData analysisData, File serverFolder) throws IOException { if (!Settings.ANALYSIS_EXPORT.isTrue()) { return; diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/comparators/MapComparator.java b/Plan/src/main/java/com/djrapitops/plan/utilities/comparators/MapComparator.java index 352fa9c77..4cc1ebfc9 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/comparators/MapComparator.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/comparators/MapComparator.java @@ -18,26 +18,29 @@ public class MapComparator { } /** - * Sorts a HashMap of String, Integer by the Values of the HashMap. + * Sorts a Map of String, Integer by the Values of the Map. * - * @param hashMap + * @param map Map to sort * @return List with String Array, where first value is the value and second * is the key. */ - public static List sortByValue(Map hashMap) { + public static List sortByValue(Map map) { List sortedList = new ArrayList<>(); - hashMap.keySet().forEach(key -> sortedList.add(new String[]{String.valueOf(hashMap.get(key)), key})); + map.keySet().forEach(key -> sortedList.add(new String[]{String.valueOf(map.get(key)), key})); sortedList.sort(Comparator.comparingInt(strings -> Integer.parseInt(strings[0]))); return sortedList; } /** - * @param hashMap - * @return + * Sorts a Map of String, Long by the Values of the Map. + * + * @param map Map to sort + * @return List with String Array, where first value is the value and second + * is the key. */ - public static List sortByValueLong(Map hashMap) { + public static List sortByValueLong(Map map) { List sortedList = new ArrayList<>(); - hashMap.keySet().forEach(key -> sortedList.add(new String[]{String.valueOf(hashMap.get(key)), key})); + map.keySet().forEach(key -> sortedList.add(new String[]{String.valueOf(map.get(key)), key})); sortedList.sort(Comparator.comparing(strings -> Long.valueOf(strings[0]))); return sortedList; } diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/comparators/StringLengthComparator.java b/Plan/src/main/java/com/djrapitops/plan/utilities/comparators/StringLengthComparator.java index 99bbc9e4e..721176d94 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/comparators/StringLengthComparator.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/comparators/StringLengthComparator.java @@ -3,7 +3,7 @@ package main.java.com.djrapitops.plan.utilities.comparators; import java.util.Comparator; /** - * Compares Strings & sorts them by length + * Compares Strings and sorts them by length * * @author Rsl1122 * @since 3.6.2 diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/file/dump/Hastebin.java b/Plan/src/main/java/com/djrapitops/plan/utilities/file/dump/Hastebin.java index ed8266088..82609dbda 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/file/dump/Hastebin.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/file/dump/Hastebin.java @@ -28,11 +28,12 @@ public class Hastebin { /** * Uploads the content safely to Hastebin. * Longer than allowed content is being uploaded too. - * - * @return The link to the Dump Log - * @implNote Splits the content into parts of 390.000 chars each, + *

+ * Splits the content into parts of 390.000 chars each, * uploads the parts in reverse order and adds the last link (if present) * at each end of the following part, that's why the redundancy of 10.000 chars exists. + * + * @return The link to the Dump Log * @see #split(String) */ public static String safeUpload(String content) { diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/html/HtmlStructure.java b/Plan/src/main/java/com/djrapitops/plan/utilities/html/HtmlStructure.java index 7acdb8b46..a73fbd6b9 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/html/HtmlStructure.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/html/HtmlStructure.java @@ -413,23 +413,15 @@ public class HtmlStructure { String serverName = plugin.getServerInfoManager().getServerName(); String address = "../server/" + serverName; - StringBuilder b = new StringBuilder("

"); - // Header - b.append("

") - .append(serverName) - .append("

"); - - // Online players - b.append("

").append(online).append("/").append(maxPlayers) - .append(" Players Online

"); - - // Footer - b.append("

Last Refresh: ").append(refresh).append("

"); - b.append("Analysis"); - - b.append("
").append("
"); - return b.toString(); + return "
" + "

" + + serverName + + "

" + + "

" + online + "/" + maxPlayers + + " Players Online

" + + "

Last Refresh: " + refresh + "

" + + "Analysis" + + "
"; } public static String parseOfflineServerContainer(String oldContent) { diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/html/HtmlUtils.java b/Plan/src/main/java/com/djrapitops/plan/utilities/html/HtmlUtils.java index 405963961..7829d2dd8 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/html/HtmlUtils.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/html/HtmlUtils.java @@ -23,9 +23,11 @@ public class HtmlUtils { } /** - * @param html - * @param replaceMap - * @return + * Replaces ${placeholder} placeholders. + * + * @param html Html to replace placeholders from + * @param replaceMap Placeholders and values + * @return Html with placeholders replaced */ public static String replacePlaceholders(String html, Map replaceMap) { StrSubstitutor sub = new StrSubstitutor(replaceMap); @@ -63,16 +65,20 @@ public class HtmlUtils { } /** - * @param string - * @return + * Attempts to remove XSS components. + * + * @param string String to remove XSS components from + * @return String but with the components removed */ public static String removeXSS(String string) { - return string.replace("", "").replace("", ""); + return string.replace("", "").replace("", "").replace("