formatted source code

src/me/teridax/jcash/Logging.java

@@ -41,6 +41,7 @@ public final class Logging {
 
     /**
      * Add a console log handler writing to the applications stderr
+     *
      * @param level the level to set the handler to
      */
     private static void createConsoleLogger(Level level) {
@@ -54,6 +55,7 @@ public final class Logging {
      * The file will be located in a folder directly besides the application
      * with the name LOG_FOLDER_NAME. The name will follow the format DATE_TIME_FORMAT plus "log" as
      * file extension.
+     *
      * @param level the log level to set the handler to
      */
     private static void createFileLogger(Level level) {

src/me/teridax/jcash/Main.java

@@ -8,7 +8,7 @@ import me.teridax.jcash.lang.Locales;
 
 import javax.swing.*;
 import java.util.Objects;
-import java.util.logging.*;
+import java.util.logging.Level;
 
 import static javax.swing.JOptionPane.ERROR_MESSAGE;
 import static javax.swing.JOptionPane.showMessageDialog;
@@ -87,6 +87,7 @@ public final class Main {
 
     /**
      * Get the main singleton instance of this program
+     *
      * @return the singleton instance of this class
      */
     public static Main getInstance() {
@@ -96,6 +97,7 @@ public final class Main {
     /**
      * Attempts to create a new instance of the singleton class Main.
      * This method throws an exception if the class is already instantiated.
+     *
      * @throws IllegalStateException if the class is already instantiated
      */
     public static void instance() {

src/me/teridax/jcash/banking/Bank.java

@@ -34,6 +34,23 @@ public final class Bank {
         this.accounts = new HashMap<>();
     }
 
+    /**
+     * Validates the given BLZ. If the blz is not valid an exception is thrown.
+     *
+     * @param maybeBlz a string to be tested for being a blz
+     * @return returns the correctly formatted blz
+     * @throws IllegalArgumentException if the supplied argument is not a valid blz
+     */
+    public static String validateBlz(String maybeBlz) throws IllegalArgumentException {
+        var pattern = Pattern.compile("[\\w-_]+");
+        var matcher = pattern.matcher(maybeBlz);
+
+        if (matcher.find())
+            return matcher.group();
+
+        throw new IllegalArgumentException("not a valid BLZ: " + maybeBlz);
+    }
+
     public String getBlz() {
         return blz;
     }
@@ -46,6 +63,7 @@ public final class Bank {
      * Add a new account and its associated owner to this bank.
      * If the owner is already present the account is added to the existing owner.
      * If the account is already present for the owner the old account gets overwritten.
+     *
      * @param owner   the owner of the account
      * @param account the account of the owner
      */
@@ -70,6 +88,7 @@ public final class Bank {
 
     /**
      * Retrieve all accounts owned by the specific owner.
+     *
      * @param owner the owner for which accounts are to be retrieved
      * @return all accounts owned by the owner and managed by this bank
      */
@@ -77,24 +96,9 @@ public final class Bank {
         return accounts.get(owner).toArray(Account[]::new);
     }
 
-    /**
-     * Validates the given BLZ. If the blz is not valid an exception is thrown.
-     * @param maybeBlz a string to be tested for being a blz
-     * @return returns the correctly formatted blz
-     * @throws IllegalArgumentException if the supplied argument is not a valid blz
-     */
-    public static String validateBlz(String maybeBlz) throws IllegalArgumentException {
-        var pattern = Pattern.compile("[\\w-_]+");
-        var matcher = pattern.matcher(maybeBlz);
-
-        if (matcher.find())
-            return matcher.group();
-
-        throw new IllegalArgumentException("not a valid BLZ: " + maybeBlz);
-    }
-
     /**
      * Return a profile of the specified international bank account number.
+     *
      * @param iban the number to create a profile for
      * @return the profile for the iban account
      */

src/me/teridax/jcash/banking/accounts/Account.java

@@ -34,6 +34,7 @@ public abstract class Account {
     /**
      * Parses a row of a fixed amount of columns into an account.
      * This function will attempt to create an instance of two classes which inherit from Account.
+     *
      * @param columns array of 6 strings
      * @return either an instance of {@link SavingsAccount} or an instance of {@link CurrentAccount}
      * @throws IllegalArgumentException if the account type cannot be determined or the provided data is invalid
@@ -90,6 +91,7 @@ public abstract class Account {
     /**
      * Returns true if the parameter is an instance of class {@link Account} and both their
      * ibans are equal.
+     *
      * @param obj the obj to compare to
      * @return true if the parameter is an instance of class {@link Account} and their ibans match
      */
@@ -105,6 +107,7 @@ public abstract class Account {
      * Returns a description of the account in form a string.
      * This method is not equal to {@link #toString()} but is intended to be
      * a method used to retrieve a formatted representation for guis.
+     *
      * @return a basic description of the account in form a string
      */
     public String getDescription() {
@@ -113,6 +116,7 @@ public abstract class Account {
 
     /**
      * Add a non-negative value onto the balance of this account.
+     *
      * @param amount the amount of value to add
      * @throws IllegalArgumentException if amount is negative
      */
@@ -133,6 +137,7 @@ public abstract class Account {
     /**
      * Takeoff a certain amount of money from this accounts balance.
      * Saturates the result if the value to subtract is greater than the balance present.
+     *
      * @param amount the amount of money to subtract from the accounts balance
      * @throws IllegalArgumentException if amount is greater than the balance present
      */

src/me/teridax/jcash/banking/accounts/CurrentAccount.java

@@ -25,6 +25,7 @@ public final class CurrentAccount extends Account {
     /**
      * Takeoff a certain amount of money from this accounts balance.
      * Saturates the result if the value to subtract is greater than the balance present.
+     *
      * @param amount the amount of money to subtract from the accounts balance
      * @throws IllegalArgumentException if amount is smaller than 0 or the overflow is greater than the overdraft.
      */

src/me/teridax/jcash/banking/accounts/Owner.java

@@ -34,6 +34,7 @@ public final class Owner {
 
     /**
      * Create a new instance of this class parsed from the columns.
+     *
      * @param columns the fields of this class as strings
      * @return an instance of this class
      * @throws IllegalArgumentException if the supplied columns is invalid

src/me/teridax/jcash/banking/management/BankingManagementSystem.java

@@ -36,6 +36,7 @@ public final class BankingManagementSystem {
     /**
      * Utility method for retrieving the tail of a string array.
      * This method return all items which follow the n-th index denoted by index.
+     *
      * @param array the array to take the tail of
      * @param index the amount trailing indices to skip
      * @return an array containing the last elements of the supplied array
@@ -66,9 +67,10 @@ public final class BankingManagementSystem {
      * </ol>
      * The file can contain a header line which gets skipped when reading.
      * Note that the first line is always skipped and the name of every column is not checked in any way.
+     *
      * @param file the file to parse
-     * @throws IllegalArgumentException if the file cannot be read or the containing data is invalid
      * @return a valid BMS
+     * @throws IllegalArgumentException if the file cannot be read or the containing data is invalid
      */
     public static BankingManagementSystem loadFromCsv(Path file) throws IllegalArgumentException {
         LOGGER.fine("parsing banking management system from file: " + Objects.toString(file, "null"));
@@ -123,6 +125,7 @@ public final class BankingManagementSystem {
 
     /**
      * Return a bank with the given blz.
+     *
      * @param blz the blz to search bank of
      * @return the bank with this blz or none
      */

src/me/teridax/jcash/banking/management/Profile.java

@@ -23,14 +23,14 @@ public class Profile {
      * The bank that manages every account referenced by this profile
      */
     private final Bank bank;
-    /**
-     * Primary or currently selected account.
-     */
-    private Account primaryAccount;
     /**
      * All other account registered at a specific bank for the specified owner
      */
     private final Account[] accounts;
+    /**
+     * Primary or currently selected account.
+     */
+    private Account primaryAccount;
 
     public Profile(Owner owner, Bank bank, Account account, Account[] accounts) {
         if (!Arrays.asList(accounts).contains(account)) {
@@ -48,21 +48,10 @@ public class Profile {
         return primaryAccount;
     }
 
-    public Owner getOwner() {
-        return owner;
-    }
-
-    public Bank getBank() {
-        return bank;
-    }
-
-    public Account[] getAccounts() {
-        return accounts;
-    }
-
     /**
      * Set the primary account of this profile based on a descriptive text.
      * This method may not change anything if no account can be found with a matching description
+     *
      * @param description the description to find a matching account for
      */
     public void setPrimaryAccount(String description) {
@@ -74,4 +63,16 @@ public class Profile {
         }
         Logging.LOGGER.warning("Account " + description + " not found in associated account list");
     }
+
+    public Owner getOwner() {
+        return owner;
+    }
+
+    public Bank getBank() {
+        return bank;
+    }
+
+    public Account[] getAccounts() {
+        return accounts;
+    }
 }

src/me/teridax/jcash/decode/StringDecoder.java

@@ -21,6 +21,7 @@ public class StringDecoder {
      * Attempts to convert the given string into a double value representing a percentage.
      * The output value will be in the range [0, 100]. Strings formatted without a percentage
      * symbol will be assumed to be normalized and thus multiplied by 100 to retrieve the result in percent.
+     *
      * @param number the string to convert
      * @return the double value
      * @throws IllegalArgumentException when the format is invalid
@@ -55,6 +56,7 @@ public class StringDecoder {
 
     /**
      * Attempts to convert the given string into a currency value.
+     *
      * @param currency the string to convert
      * @return the double value
      * @throws IllegalArgumentException when the format is invalid
@@ -76,6 +78,7 @@ public class StringDecoder {
     /**
      * Attempts to convert the given string into universally unique number.
      * This function does not check for duplicates. The number must be a positive integer.
+     *
      * @param number the string to convert
      * @return the integer serial number
      * @throws IllegalArgumentException when the format is invalid
@@ -103,6 +106,7 @@ public class StringDecoder {
     /**
      * Attempts to convert the given string into a name.
      * This method performs validation and trimming.
+     *
      * @param name the string to convert
      * @return the qualified name
      * @throws IllegalArgumentException when the format is invalid
@@ -124,6 +128,7 @@ public class StringDecoder {
 
     /**
      * Attempts to convert the given string into a street and an optional house address.
+     *
      * @param street the string to convert
      * @return the address name
      * @throws IllegalArgumentException when the format is invalid

src/me/teridax/jcash/gui/Loader.java

@@ -20,11 +20,13 @@ public class Loader {
      */
     private static final FileNameExtensionFilter FILE_FILTER = new FileNameExtensionFilter(translate("Comma separated value spreadsheet"), "csv", "CSV");
 
-    private Loader() {}
+    private Loader() {
+    }
 
     /**
      * Load a BMS from a csv file. Opens up a dialog which prompts the user to select a single file.
      * Once the file is selected this function will try to parse the contents to a BMS and return the instance.
+     *
      * @return a valid BMS instance loaded from a file
      * @throws IllegalStateException When either no file is selected or the selected files content is invalid
      */

src/me/teridax/jcash/gui/Utils.java

@@ -12,6 +12,7 @@ public class Utils {
     /**
      * Add a new row of components to the specified target component.
      * This will add label to the right side of the next row and the specified component to the left.
+     *
      * @param constraints the constraint to use. Must be non-null
      * @param target      the base component to add a row to
      * @param comp        the component to add to the left side
@@ -36,6 +37,7 @@ public class Utils {
     /**
      * Add a new row of components to the specified target component.
      * This will add label to the right side of the next row and the specified component to the left.
+     *
      * @param constraints the constraint to use. Must be non-null
      * @param target      the base component to add a row to
      * @param comp        the component to add to the left side

src/me/teridax/jcash/gui/login/AccountSelectionListener.java

@@ -11,6 +11,7 @@ public interface AccountSelectionListener {
     /**
      * Run when a new account is selected.
      * The selected account is set as the primary account of the profile
+     *
      * @param account the profile for the selected account
      */
     void onAccountSelected(Profile account);

src/me/teridax/jcash/gui/login/LoginData.java

@@ -19,6 +19,7 @@ public class LoginData {
 
     /**
      * authenticate the specified account with the provided pin.
+     *
      * @param blz  the bank identifier
      * @param iban the account identifier
      * @param pin  the pin for the account to authenticate with

src/me/teridax/jcash/gui/transfer/TransferData.java

@@ -14,6 +14,7 @@ public class TransferData {
 
     /**
      * Transfers a certain amount of money to the specified account of the specified bank
+     *
      * @param amount     the amount to transfer
      * @param blz        the bank that manages the account
      * @param ibanString the internal bank account number to transfer money to

src/me/teridax/jcash/lang/Locales.java

@@ -16,6 +16,7 @@ public class Locales {
      * Sets the default locale to use for the application instance.
      * This will instruct the translator to use the default locale as well as
      * Java swing components.
+     *
      * @param language the locale to use for language
      * @param country  the locale to use for country
      */

src/me/teridax/jcash/lang/Translator.java

@@ -8,11 +8,6 @@ import java.util.stream.Collectors;
 
 public final class Translator {
 
-    /**
-     * Precomputed index of the locale used to statically translate a phrase
-     */
-    private static int localeTranslationIndex = 0;
-
     /**
      * List of all supported locales in the format: language_country. Examples: en_EN, fr_FR
      * The index inside the list is directly related to the index of the translation array inside the list translations.
@@ -23,6 +18,10 @@ public final class Translator {
      * Index 0 of the translation is equivalent to the key itself since locale 0 is always en_EN.
      */
     private static final Map<String, String[]> translations = new HashMap<>();
+    /**
+     * Precomputed index of the locale used to statically translate a phrase
+     */
+    private static int localeTranslationIndex = 0;
 
     static {
         // read language file and parse
@@ -64,6 +63,7 @@ public final class Translator {
     /**
      * Translates the given phrase into the corresponding phrase of the selected locale of the translator.
      * If no translation is found or no locale is defined for the translator this function will return the given phrase.
+     *
      * @param phrase the text to translate
      * @return the translated phrase, or the phrase itself in case no translation can be found
      */
@@ -81,6 +81,7 @@ public final class Translator {
 
     /**
      * Returns an array of all available locales for this translator
+     *
      * @return an array of all available locales for this translator
      */
     public static String[] availableLocales() {
@@ -90,6 +91,7 @@ public final class Translator {
     /**
      * Map the given locale string to an index indicating which array location to choose when fetching a result from
      * the translation map.
+     *
      * @param locale the locale string
      * @return a matching index of the locale
      * @throws IllegalArgumentException if the given locale is not part of the available locales
@@ -107,6 +109,7 @@ public final class Translator {
     /**
      * Sets the default locale to use when translating.
      * The locale must have the format language_COUNTRY like en_EN
+     *
      * @param locale the locale to use when translating
      * @return if the specified locale can be used by the translator
      */