Code clean up and javadoc fixes

README.md

@@ -32,7 +32,7 @@ The default player command is `bank` and it can be changed in the config.yml. So
 * `bank deposit <amount>` - deposit money into the island bank
 * `bank withdraw <amount>` - withdraw money from the island bank
 * `bank balance` - see your island bank balance
-* `bank statement` - see a fancy statement of deposits/withdrawals, etc. on you island bank account
+* `bank statement` - see a fancy statement of deposits/withdrawals, etc. on your island bank account
 
 ### Admin commands
 

src/main/java/world/bentobox/bank/Bank.java

@@ -85,7 +85,7 @@ public void onDisable() {
     /**
      * @return the settings
      */
-    public Settings getSettings() {
+    public @Nullable Settings getSettings() {
         return settings;
     }
 

src/main/java/world/bentobox/bank/BankManager.java

@@ -71,7 +71,7 @@ public void loadBalances() {
      */
     public CompletableFuture<BankResponse> deposit(User user, double amount, World world) {
         // Get player's account
-        Island island = addon.getIslands().getIsland(Util.getWorld(world), user);
+        Island island = addon.getIslands().getIsland(Objects.requireNonNull(Util.getWorld(world)), user);
         if (island == null) {
             return CompletableFuture.completedFuture(BankResponse.FAILURE_NO_ISLAND);
         }
@@ -122,7 +122,7 @@ private BankAccounts getAccount(String uuid) throws IOException {
      */
     public CompletableFuture<BankResponse> withdraw(User user, double amount, World world) {
         // Get player's island
-        Island island = addon.getIslands().getIsland(Util.getWorld(world), user);
+        Island island = addon.getIslands().getIsland(Objects.requireNonNull(Util.getWorld(world)), user);
         if (island == null) {
             return CompletableFuture.completedFuture(BankResponse.FAILURE_NO_ISLAND);
         }
@@ -176,7 +176,7 @@ public double getBalance(@Nullable Island island) {
      * @return balance. 0 if unknown
      */
     public double getBalance(User user, World world) {
-        return getBalance(addon.getIslands().getIsland(Util.getWorld(world), user));
+        return getBalance(addon.getIslands().getIsland(Objects.requireNonNull(Util.getWorld(world)), user));
     }
 
     /**
@@ -191,7 +191,7 @@ public List<AccountHistory> getHistory(Island island) {
                 String[] split = en.getValue().split(":");
                 if (split.length == 3) {
                     TxType type = Enums.getIfPresent(TxType.class, split[1]).or(TxType.UNKNOWN);
-                    return new AccountHistory(en.getKey(), split[0], Double.valueOf(split[2]), type);
+                    return new AccountHistory(en.getKey(), split[0], Double.parseDouble(split[2]), type);
                 }
                 return null;
             }).filter(Objects::nonNull).collect(Collectors.toList());

src/main/java/world/bentobox/bank/PhManager.java

@@ -2,6 +2,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 
 import org.bukkit.World;
 
@@ -20,7 +21,7 @@ public class PhManager {
     private final BankManager bankManager;
     private final Bank addon;
     private List<String> names = new ArrayList<>();
-    private List<String> balances = new ArrayList<>();
+    private final List<String> balances = new ArrayList<>();
     private long lastSorted = System.currentTimeMillis();
     private static final long CACHETIME = 10000;
 
@@ -47,7 +48,7 @@ protected boolean registerPlaceholders(GameModeAddon gm) {
                 gm.getDescription().getName().toLowerCase() + "_visited_island_balance", user -> getVisitedIslandBalance(gm, user));
 
         // Register Ranked Placeholders
-        for (int i = 1; i <= addon.getSettings().getRanksNumber(); i++) {
+        for (int i = 1; i <= Objects.requireNonNull(addon.getSettings()).getRanksNumber(); i++) {
             final int rank = i;
             // Name
             plugin.getPlaceholdersManager().registerPlaceholder(addon,
@@ -60,6 +61,7 @@ protected boolean registerPlaceholders(GameModeAddon gm) {
     }
 
     String getVisitedIslandBalance(GameModeAddon gm, User user) {
+        if (user == null || user.getLocation() == null) return "";
         if (!gm.inWorld(user.getWorld())) return addon.getVault().format(0D);
         return addon.getIslands().getIslandAt(user.getLocation())
                 .map(island -> addon.getVault().format(bankManager.getBalance(island)))
@@ -83,7 +85,7 @@ String getRankBalance(World world, int rank) {
 
     int checkCache(World world, int rank) {
         if (rank < 1) rank = 1;
-        if (rank > addon.getSettings().getRanksNumber()) rank = addon.getSettings().getRanksNumber();
+        if (rank > Objects.requireNonNull(addon.getSettings()).getRanksNumber()) rank = addon.getSettings().getRanksNumber();
         if (names.isEmpty() || (System.currentTimeMillis() - lastSorted) > CACHETIME) {
             // Clear the old top
             names.clear();

src/main/java/world/bentobox/bank/commands/AbstractBankCommand.java

@@ -1,6 +1,3 @@
-/**
- *
- */
 package world.bentobox.bank.commands;
 
 import java.util.Collections;
@@ -23,9 +20,6 @@
  */
 public abstract class AbstractBankCommand extends CompositeCommand {
 
-    protected AbstractBankCommand(Bank bank, CompositeCommand adminCmd, String adminCommand) {
-        super(bank, adminCmd, adminCommand);
-    }
     protected AbstractBankCommand(CompositeCommand parent, String string) {
         super(parent, string);
     }
@@ -68,7 +62,6 @@ protected enum RequestType {
     /**
      * @param user - user
      * @param args - args
-     * @param reqArgNum - required number of args
      * @return true if can execute, false if not
      */
     public boolean canAbstractExecute(User user, List<String> args, RequestType type) {

src/main/java/world/bentobox/bank/commands/admin/AdminCommand.java

@@ -16,10 +16,6 @@ public AdminCommand(Bank bank, CompositeCommand adminCmd, String adminCommand) {
         super(bank, adminCmd, adminCommand);
     }
 
-    public AdminCommand(CompositeCommand parent, String string) {
-        super(parent, string);
-    }
-
     @Override
     public void setup() {
         this.setPermission("bank.admin");

src/main/java/world/bentobox/bank/commands/admin/AdminStatementCommand.java

@@ -2,7 +2,6 @@
 
 import java.util.List;
 
-import world.bentobox.bank.Bank;
 import world.bentobox.bank.commands.user.tabs.StatementTab;
 import world.bentobox.bentobox.api.commands.CompositeCommand;
 import world.bentobox.bentobox.api.panels.builders.TabbedPanelBuilder;
@@ -39,8 +38,8 @@ public boolean execute(User user, String label, List<String> args) {
         new TabbedPanelBuilder()
         .user(user)
         .world(getWorld())
-        .tab(1, new StatementTab(((Bank)getAddon()), user, island, true))
-        .tab(2, new StatementTab(((Bank)getAddon()), user, island, false))
+        .tab(1, new StatementTab(getAddon(), user, island, true))
+        .tab(2, new StatementTab(getAddon(), user, island, false))
         .startingSlot(1)
         .size(54)
         .build().openPanel();

src/main/java/world/bentobox/bank/commands/user/BalTopCommand.java

@@ -2,7 +2,6 @@
 
 import java.util.List;
 
-import world.bentobox.bank.Bank;
 import world.bentobox.bank.commands.user.tabs.BalTopTab;
 import world.bentobox.bentobox.api.commands.CompositeCommand;
 import world.bentobox.bentobox.api.panels.builders.TabbedPanelBuilder;
@@ -48,8 +47,8 @@ public boolean execute(User user, String label, List<String> args) {
         new TabbedPanelBuilder()
         .user(user)
         .world(user.getWorld())
-        .tab(1, new BalTopTab(((Bank)getAddon()), getWorld(), user, true))
-        .tab(2, new BalTopTab(((Bank)getAddon()), getWorld(), user, false))
+        .tab(1, new BalTopTab(getAddon(), getWorld(), user, true))
+        .tab(2, new BalTopTab(getAddon(), getWorld(), user, false))
         .startingSlot(1)
         .size(54)
         .build().openPanel();

src/main/java/world/bentobox/bank/commands/user/StatementCommand.java

@@ -2,7 +2,6 @@
 
 import java.util.List;
 
-import world.bentobox.bank.Bank;
 import world.bentobox.bank.commands.AbstractBankCommand;
 import world.bentobox.bank.commands.user.tabs.StatementTab;
 import world.bentobox.bentobox.api.commands.CompositeCommand;
@@ -39,8 +38,8 @@ public boolean execute(User user, String label, List<String> args) {
         new TabbedPanelBuilder()
         .user(user)
         .world(user.getWorld())
-        .tab(1, new StatementTab(((Bank)getAddon()), user, island, true))
-        .tab(2, new StatementTab(((Bank)getAddon()), user, island, false))
+        .tab(1, new StatementTab(getAddon(), user, island, true))
+        .tab(2, new StatementTab(getAddon(), user, island, false))
         .startingSlot(1)
         .size(54)
         .build().openPanel();

src/main/java/world/bentobox/bank/commands/user/tabs/BalTopTab.java

@@ -27,7 +27,7 @@ public class BalTopTab implements Tab {
     private final boolean sort;
     private final Bank addon;
     private final World world;
-    private static final Comparator<Entry<String, Double>> comparator = (h1, h2) -> Double.compare(h1.getValue(), h2.getValue());
+    private static final Comparator<Entry<String, Double>> comparator = Comparator.comparingDouble(Entry::getValue);
 
 
     public BalTopTab(Bank addon, World world, User user, boolean sort) {
@@ -52,7 +52,7 @@ public String getName() {
     public List<@Nullable PanelItem> getPanelItems() {
         return addon.getBankManager().getBalances(world).entrySet().stream()
                 .sorted(sort ? comparator.reversed() : comparator)
-                .limit(addon.getSettings().getRanksNumber())
+                .limit(Objects.requireNonNull(addon.getSettings()).getRanksNumber())
                 .map(ah -> addon.getIslands().getIslandById(ah.getKey())
                         .filter(i -> i.getOwner() != null)
                         .map(island -> new PanelItemBuilder()

src/main/java/world/bentobox/bank/commands/user/tabs/MaterialText.java

@@ -3,8 +3,8 @@
 import org.bukkit.Material;
 
 public class MaterialText {
-    Material material;
-    String text;
+    final Material material;
+    final String text;
     /**
      * @param m - material
      * @param t - string

src/main/java/world/bentobox/bank/commands/user/tabs/StatementTab.java

@@ -32,7 +32,7 @@ public class StatementTab implements Tab {
     private final @Nullable Island island;
     private final boolean sort;
     private final Bank addon;
-    private static final Comparator<AccountHistory> comparator = (h1, h2) -> Long.compare(h1.getTimestamp(), h2.getTimestamp());
+    private static final Comparator<AccountHistory> comparator = Comparator.comparingLong(AccountHistory::getTimestamp);
 
     private static final Map<TxType, MaterialText> ICON_TEXT;
     static {
@@ -67,6 +67,7 @@ public String getName() {
 
     @Override
     public List<@Nullable PanelItem> getPanelItems() {
+        if (island == null) return Collections.emptyList();
         return addon.getBankManager().getHistory(island).stream()
                 .sorted(sort ? comparator.reversed() : comparator)
                 .map(ah -> {

src/main/java/world/bentobox/bank/data/AccountHistory.java

@@ -15,7 +15,7 @@ public class AccountHistory {
      * @param timestamp - time stamp
      * @param name - name of user making the change
      * @param amount - amount of change
-     * @type - type of change
+     * @param type - type of change
      */
     public AccountHistory(long timestamp, String name, double amount, TxType type) {
         super();

src/main/java/world/bentobox/bank/data/BankAccounts.java

@@ -25,7 +25,7 @@ public class BankAccounts implements DataObject {
     private double balance;
 
     @Expose
-    private Map<Long, String> history = new TreeMap<>();
+    private final Map<Long, String> history = new TreeMap<>();
 
     @Override
     public String getUniqueId() {
@@ -58,11 +58,4 @@ public Map<Long, String> getHistory() {
         return history;
     }
 
-    /**
-     * @param history the history to set
-     */
-    public void setHistory(Map<Long, String> history) {
-        this.history = history;
-    }
-
 }

src/test/java/world/bentobox/bank/BankManagerTest.java

@@ -93,10 +93,9 @@ public static void beforeClass() throws IllegalAccessException, InvocationTarget
     }
 
     /**
-     * @throws java.lang.Exception
      */
     @Before
-    public void setUp() throws Exception {
+    public void setUp() {
         when(bank.getPlugin()).thenReturn(plugin);
         // Set up plugin
         Whitebox.setInternalState(BentoBox.class, "instance", plugin);
@@ -123,7 +122,7 @@ public void setUp() throws Exception {
     }
 
     /**
-     * @throws java.lang.Exception
+     * @throws java.lang.Exception - exception
      */
     @After
     public void tearDown() throws Exception {
@@ -221,7 +220,7 @@ public void testGetHistory() {
     }
 
     /**
-     * Test method for {@link world.bentobox.bank.BankManager#getBalances()}.
+     * Test method for {@link world.bentobox.bank.BankManager#getBalances(World)}.
      */
     @Test
     public void testGetBalances() {

src/test/java/world/bentobox/bank/PhManagerTest.java

@@ -74,10 +74,9 @@ public class PhManagerTest {
 
 
     /**
-     * @throws java.lang.Exception
      */
     @Before
-    public void setUp() throws Exception {
+    public void setUp() {
 
         AddonDescription desc = new AddonDescription.Builder("main", "AcidIsland", "1.0.2").build();
         when(gm.getDescription()).thenReturn(desc);
@@ -87,7 +86,7 @@ public void setUp() throws Exception {
         when(user.getWorld()).thenReturn(world);
         when(gm.inWorld(eq(world))).thenReturn(true);
         VaultHook vh = mock(VaultHook.class);
-        when(vh.format(anyDouble())).thenAnswer(args -> "$" + String.valueOf(args.getArgument(0, Double.class)));
+        when(vh.format(anyDouble())).thenAnswer(args -> "$" + args.getArgument(0, Double.class));
         when(addon.getVault()).thenReturn(vh);
         when(addon.getIslands()).thenReturn(im);
         when(user.getLocation()).thenReturn(location);
@@ -199,7 +198,7 @@ public void testGetRankBalance() {
     }
 
     /**
-     * Test method for {@link world.bentobox.bank.PhManager#checkCache(int)}.
+     * Test method for {@link world.bentobox.bank.PhManager#checkCache(World, int)}.
      */
     @Test
     public void testCheckCache() {
@@ -208,7 +207,7 @@ public void testCheckCache() {
     }
 
     /**
-     * Test method for {@link world.bentobox.bank.PhManager#checkCache(int)}.
+     * Test method for {@link world.bentobox.bank.PhManager#checkCache(World, int)}.
      */
     @Test
     public void testCheckCacheWithBalances() {
@@ -228,12 +227,12 @@ public void testCheckCacheWithBalances() {
         when(bm.getBalances(world)).thenReturn(map);
         for (int i = 1; i < 11; i++) {
             pm.checkCache(world, i);
-            assertEquals(pm.getBalances().get(i-1), "$" + String.valueOf(map.get(pm.getNames().get(i-1))));
+            assertEquals(pm.getBalances().get(i-1), "$" + map.get(pm.getNames().get(i - 1)));
         }
     }
 
     /**
-     * Test method for {@link world.bentobox.bank.PhManager#checkCache(int)}.
+     * Test method for {@link world.bentobox.bank.PhManager#checkCache(World, int)}.
      */
     @Test
     public void testCheckCacheNoNamesChange() {
@@ -244,7 +243,7 @@ public void testCheckCacheNoNamesChange() {
     }
 
     /**
-     * Test method for {@link world.bentobox.bank.PhManager#checkCache(int)}.
+     * Test method for {@link world.bentobox.bank.PhManager#checkCache(World, int)}.
      */
     @Test
     public void testCheckCacheNoChange() {
@@ -257,7 +256,7 @@ public void testCheckCacheNoChange() {
     }
 
     /**
-     * Test method for {@link world.bentobox.bank.PhManager#checkCache(int)}.
+     * Test method for {@link world.bentobox.bank.PhManager#checkCache(World, int)}.
      */
     @Test
     public void testCheckCacheOutOfBounds() {