CustomEconomyCache

package com.itzrozzadev.customeconomy.api;

/**
 * Everything Here Will Is Used to Chance the Value
 * of Player's Information Stored in the data.db File
 * <p>
 * Stored Info:
 * -> Balance
 * -> Tokens
 */

public interface CustomEconomyCache {
    /**
     * Gets Balance of Specified Player
     *
     * @return Balance of Specified Player
     */
    double getBalance();

    /**
     * Gets Tokens of Specified Player
     *
     * @return Tokens of Specified Player
     */
    double getTokens();

    /**
     * Sets Players Balance to What Ever You Want
     *
     * @param setBalanceTo Value That the Player's Balance Will be Set to
     */
    void setBalance(final double setBalanceTo);

    /**
     * Subtract an Amount from Players Balance
     *
     * @param subtractBy Value That Will be Subtracted From Player's Balance
     */
    void subBalance(final double subtractBy);

    /**
     * Add an Amount to Players Balance
     *
     * @param addBy Value That Will be Added to Player's Balance
     */
    void addBalance(final double addBy);

    /**
     * Sets Players Tokens to What Ever You Want
     *
     * @param setTokensTo Value That the Player's Tokens Will be Set to
     */
    void setTokens(final double setTokensTo);

    /**
     * Subtract an Amount from Players Balance
     *
     * @param subtractBy Value That Will be Subtracted From Player's Tokens
     */
    void subTokens(final double subtractBy);

    /**
     * Subtract an Amount from Players Balance
     *
     * @param addBy Value That Will be Added to Player's Tokens
     */
    void addTokens(final double addBy);


}