cat.nyaa.nyaacore.component.ISystemBalance Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rpgitems Show documentation

The legacy RPGItems continues. (fork)

There is a newer version: 3.12.2

package cat.nyaa.nyaacore.component;

import org.bukkit.plugin.java.JavaPlugin;

/**
 * The idea of "system balance" is introduced in HamsterEconomyHelper,
 * which says, all fees charged by the system shall be returned to players.
 * 
 * So a central ledger is necessary for tracking these transactions.
 * 
 * See https://github.com/NyaaCat/HamsterEcoHelper/blob/master/src/main/java/cat/nyaa/HamsterEcoHelper/balance/BalanceAPI.java
 */
public interface ISystemBalance extends IComponent {
    /**
     * How much is the system balance
     */
    double getBalance();

    /**
     * Force set the balance
     *
     * @param balance  new balance
     * @param operator (optional) the plugin initiated this transaction. Can be null.
     */
    void setBalance(double balance, JavaPlugin operator);

    /**
     * withdraw money from system balance
     * allowing the remaining amount to be negative
     *
     * @param amount   how much money should be withdrawn
     * @param operator (optional) the plugin initiated this transaction. Can be null.
     * @return system balance after the transaction
     */
    double withdrawAllowDebt(double amount, JavaPlugin operator);

    /**
     * deposit money into system balance
     *
     * @param amount   how much money should be deposit
     * @param operator (optional) the plugin initiated this transaction. Can be null.
     * @return system balance after the transaction
     */
    double deposit(double amount, JavaPlugin operator);

    /**
     * check if the system balance has enough amount of money
     *
     * @param amount amount of money
     * @return true if system balance has that much of money, false otherwise
     */
    default boolean hasEnoughBalance(double amount) {
        return getBalance() >= amount;
    }

    default double withdrawAllowDebt(double amount) {
        return withdrawAllowDebt(amount, null);
    }

    default double withdraw(double amount, JavaPlugin operator) {
        if (!hasEnoughBalance(amount)) throw new IllegalArgumentException();
        return withdrawAllowDebt(amount, operator);
    }

    default double withdraw(double amount) {
        if (!hasEnoughBalance(amount)) throw new IllegalArgumentException();
        return withdrawAllowDebt(amount, null);
    }

    default double deposit(double amount) {
        return deposit(amount, null);
    }
}