From fa5c7905da100d2e0992640fe4fb2f517a7c83dd Mon Sep 17 00:00:00 2001 From: Florian CUNY Date: Thu, 13 Dec 2018 10:10:05 +0100 Subject: [PATCH] Deprecated Island#showInfo() and Island#showMembers() that were using useless parameters Replaced them with equivalents only requiring an User as parameter. --- .../api/commands/admin/AdminInfoCommand.java | 4 +- .../admin/team/AdminTeamAddCommand.java | 2 +- .../admin/team/AdminTeamKickCommand.java | 2 +- .../commands/island/IslandInfoCommand.java | 4 +- .../island/team/IslandTeamCommand.java | 2 +- .../bentobox/database/objects/Island.java | 39 +++++++++++++++---- .../commands/admin/AdminInfoCommandTest.java | 6 +-- .../admin/team/AdminTeamAddCommandTest.java | 2 +- .../admin/team/AdminTeamKickCommandTest.java | 2 +- 9 files changed, 44 insertions(+), 19 deletions(-) diff --git a/src/main/java/world/bentobox/bentobox/api/commands/admin/AdminInfoCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/admin/AdminInfoCommand.java index b5888ef50..2581f4823 100644 --- a/src/main/java/world/bentobox/bentobox/api/commands/admin/AdminInfoCommand.java +++ b/src/main/java/world/bentobox/bentobox/api/commands/admin/AdminInfoCommand.java @@ -30,7 +30,7 @@ public class AdminInfoCommand extends CompositeCommand { } // If there are no args, then the player wants info on the island at this location if (args.isEmpty()) { - if (!getIslands().getIslandAt(user.getLocation()).map(i -> i.showInfo(getPlugin(), user, getWorld())).orElse(false)) { + if (!getIslands().getIslandAt(user.getLocation()).map(i -> i.showInfo(user)).orElse(false)) { user.sendMessage("commands.admin.info.no-island"); return false; } @@ -47,7 +47,7 @@ public class AdminInfoCommand extends CompositeCommand { return false; } // Show info for this player - getIslands().getIsland(getWorld(), targetUUID).showInfo(getPlugin(), user, getWorld()); + getIslands().getIsland(getWorld(), targetUUID).showInfo(user); return true; } } diff --git a/src/main/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamAddCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamAddCommand.java index f1090caaf..2f49306f5 100644 --- a/src/main/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamAddCommand.java +++ b/src/main/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamAddCommand.java @@ -44,7 +44,7 @@ public class AdminTeamAddCommand extends CompositeCommand { } if (getIslands().inTeam(getWorld(), ownerUUID) && !getIslands().getOwner(getWorld(), ownerUUID).equals(ownerUUID)) { user.sendMessage("commands.admin.team.add.name-not-owner", TextVariables.NAME, args.get(0)); - getIslands().getIsland(getWorld(), ownerUUID).showMembers(getPlugin(), user, getWorld()); + getIslands().getIsland(getWorld(), ownerUUID).showMembers(user); return false; } if (getIslands().inTeam(getWorld(), targetUUID)) { diff --git a/src/main/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamKickCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamKickCommand.java index 6981c7fa5..7a1f126a7 100644 --- a/src/main/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamKickCommand.java +++ b/src/main/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamKickCommand.java @@ -44,7 +44,7 @@ public class AdminTeamKickCommand extends CompositeCommand { } if (getIslands().getOwner(getWorld(), targetUUID).equals(targetUUID)) { user.sendMessage("commands.admin.team.kick.cannot-kick-owner"); - getIslands().getIsland(getWorld(), targetUUID).showMembers(getPlugin(), user, getWorld()); + getIslands().getIsland(getWorld(), targetUUID).showMembers(user); return false; } User.getInstance(targetUUID).sendMessage("commands.admin.team.kick.admin-kicked"); diff --git a/src/main/java/world/bentobox/bentobox/api/commands/island/IslandInfoCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/island/IslandInfoCommand.java index 052eb39f4..11bfa302a 100644 --- a/src/main/java/world/bentobox/bentobox/api/commands/island/IslandInfoCommand.java +++ b/src/main/java/world/bentobox/bentobox/api/commands/island/IslandInfoCommand.java @@ -33,7 +33,7 @@ public class IslandInfoCommand extends CompositeCommand { } // If there are no args, then the player wants info on the island at this location if (args.isEmpty()) { - if (!getIslands().getIslandAt(user.getLocation()).map(i -> i.showInfo(getPlugin(), user, getWorld())).orElse(false)) { + if (!getIslands().getIslandAt(user.getLocation()).map(i -> i.showInfo(user)).orElse(false)) { user.sendMessage("commands.admin.info.no-island"); return false; } @@ -50,7 +50,7 @@ public class IslandInfoCommand extends CompositeCommand { return false; } // Show info for this player - getIslands().getIsland(getWorld(), targetUUID).showInfo(getPlugin(), user, getWorld()); + getIslands().getIsland(getWorld(), targetUUID).showInfo(user); return true; } } diff --git a/src/main/java/world/bentobox/bentobox/api/commands/island/team/IslandTeamCommand.java b/src/main/java/world/bentobox/bentobox/api/commands/island/team/IslandTeamCommand.java index 37fccf736..479d24100 100644 --- a/src/main/java/world/bentobox/bentobox/api/commands/island/team/IslandTeamCommand.java +++ b/src/main/java/world/bentobox/bentobox/api/commands/island/team/IslandTeamCommand.java @@ -63,7 +63,7 @@ public class IslandTeamCommand extends CompositeCommand { } } // Show members of island - getIslands().getIsland(getWorld(), playerUUID).showMembers(getPlugin(), user, getWorld()); + getIslands().getIsland(getWorld(), playerUUID).showMembers(user); return true; } diff --git a/src/main/java/world/bentobox/bentobox/database/objects/Island.java b/src/main/java/world/bentobox/bentobox/database/objects/Island.java index f07a0befd..941d16411 100644 --- a/src/main/java/world/bentobox/bentobox/database/objects/Island.java +++ b/src/main/java/world/bentobox/bentobox/database/objects/Island.java @@ -595,8 +595,21 @@ public class Island implements DataObject { * @param user - the user who is receiving the info * @param world - world to check * @return true always + * + * @deprecated Renamed to {@link #showInfo(User)}. */ + @Deprecated public boolean showInfo(BentoBox plugin, User user, World world) { + return showInfo(user); + } + + /** + * Shows info of this island to this user. + * @param user the User who is requesting it + * @return always true + */ + public boolean showInfo(User user) { + BentoBox plugin = BentoBox.getInstance(); user.sendMessage("commands.admin.info.title"); if (owner == null) { user.sendMessage("commands.admin.info.unowned"); @@ -606,14 +619,14 @@ public class Island implements DataObject { // Fixes #getLastPlayed() returning 0 when it is the owner's first connection. long lastPlayed = (plugin.getServer().getOfflinePlayer(owner).getLastPlayed() != 0) ? plugin.getServer().getOfflinePlayer(owner).getLastPlayed() : plugin.getServer().getOfflinePlayer(owner).getFirstPlayed(); - user.sendMessage("commands.admin.info.last-login","[date]", new Date(lastPlayed).toString()); + user.sendMessage("commands.admin.info.last-login","[date]", new Date(lastPlayed).toString()); - user.sendMessage("commands.admin.info.deaths", "[number]", String.valueOf(plugin.getPlayers().getDeaths(world, owner))); - String resets = String.valueOf(plugin.getPlayers().getResets(world, owner)); - String total = plugin.getIWM().getResetLimit(world) < 0 ? "Unlimited" : String.valueOf(plugin.getIWM().getResetLimit(world)); - user.sendMessage("commands.admin.info.resets-left", "[number]", resets, "[total]", total); - // Show team members - showMembers(plugin, user, world); + user.sendMessage("commands.admin.info.deaths", "[number]", String.valueOf(plugin.getPlayers().getDeaths(world, owner))); + String resets = String.valueOf(plugin.getPlayers().getResets(world, owner)); + String total = plugin.getIWM().getResetLimit(world) < 0 ? "Unlimited" : String.valueOf(plugin.getIWM().getResetLimit(world)); + user.sendMessage("commands.admin.info.resets-left", "[number]", resets, "[total]", total); + // Show team members + showMembers(user); } Vector location = center.toVector(); user.sendMessage("commands.admin.info.island-location", "[xyz]", Util.xyz(location)); @@ -640,8 +653,20 @@ public class Island implements DataObject { * @param plugin - plugin * @param user - user who is requesting * @param world - world to check + * + * @deprecated Renamed to {@link #showMembers(User)}. */ + @Deprecated public void showMembers(BentoBox plugin, User user, World world) { + showMembers(user); + } + + /** + * Shows the members of this island to this user. + * @param user the User who is requesting it + */ + public void showMembers(User user) { + BentoBox plugin = BentoBox.getInstance(); user.sendMessage("commands.admin.info.team-members-title"); members.forEach((u, i) -> { if (owner.equals(u)) { diff --git a/src/test/java/world/bentobox/bentobox/api/commands/admin/AdminInfoCommandTest.java b/src/test/java/world/bentobox/bentobox/api/commands/admin/AdminInfoCommandTest.java index 17240ace1..eaac28d8d 100644 --- a/src/test/java/world/bentobox/bentobox/api/commands/admin/AdminInfoCommandTest.java +++ b/src/test/java/world/bentobox/bentobox/api/commands/admin/AdminInfoCommandTest.java @@ -166,7 +166,7 @@ public class AdminInfoCommandTest { Island is = mock(Island.class); when(im.getIsland(Mockito.any(), Mockito.eq(notUUID))).thenReturn(is); assertTrue(itl.execute(user, itl.getLabel(), Arrays.asList(name))); - Mockito.verify(is).showInfo(Mockito.eq(plugin), Mockito.eq(user), Mockito.any()); + Mockito.verify(is).showInfo(Mockito.eq(user)); } /** @@ -195,7 +195,7 @@ public class AdminInfoCommandTest { // Island has owner Island is = mock(Island.class); when(is.getOwner()).thenReturn(uuid); - when(is.showInfo(Mockito.any(), Mockito.any(), Mockito.any())).thenReturn(true); + when(is.showInfo(Mockito.any())).thenReturn(true); Optional opi = Optional.of(is); when(im.getIslandAt(Mockito.any())).thenReturn(opi); when(user.getLocation()).thenReturn(loc); @@ -203,6 +203,6 @@ public class AdminInfoCommandTest { assertTrue(itl.execute(user, itl.getLabel(), new ArrayList<>())); // Confirm other verifications - Mockito.verify(is).showInfo(Mockito.eq(plugin), Mockito.eq(user), Mockito.any()); + Mockito.verify(is).showInfo(Mockito.eq(user)); } } \ No newline at end of file diff --git a/src/test/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamAddCommandTest.java b/src/test/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamAddCommandTest.java index 1a1cf8b6d..7f0e231f3 100644 --- a/src/test/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamAddCommandTest.java +++ b/src/test/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamAddCommandTest.java @@ -211,7 +211,7 @@ public class AdminTeamAddCommandTest { assertFalse(itl.execute(user, itl.getLabel(), Arrays.asList(name))); Mockito.verify(user).sendMessage("commands.admin.team.add.name-not-owner", "[name]", "tastybento"); - Mockito.verify(island).showMembers(Mockito.eq(plugin), Mockito.any(), Mockito.any()); + Mockito.verify(island).showMembers(Mockito.any()); } /** diff --git a/src/test/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamKickCommandTest.java b/src/test/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamKickCommandTest.java index 5d96fc5e7..b050e53ea 100644 --- a/src/test/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamKickCommandTest.java +++ b/src/test/java/world/bentobox/bentobox/api/commands/admin/team/AdminTeamKickCommandTest.java @@ -166,7 +166,7 @@ public class AdminTeamKickCommandTest { AdminTeamKickCommand itl = new AdminTeamKickCommand(ac); assertFalse(itl.execute(user, itl.getLabel(), Arrays.asList(name))); Mockito.verify(user).sendMessage(Mockito.eq("commands.admin.team.kick.cannot-kick-owner")); - Mockito.verify(is).showMembers(Mockito.any(), Mockito.any(), Mockito.any()); + Mockito.verify(is).showMembers(Mockito.any()); } /**