com.greatmancode.craftconomy3.account

Class Account

java.lang.Object

com.greatmancode.craftconomy3.account.Account

public class Account
extends java.lang.Object

Represents a economy account.

Constructor Summary

Constructors

Constructor and Description
Account(java.lang.String name, boolean bankAccount, boolean infiniteMoney, boolean ignoreACL) Load a account.

Method Summary

Modifier and Type	Method and Description
double	deposit(double amount, java.lang.String world, java.lang.String currencyName) Deprecated. use deposit(double, String, String, com.greatmancode.craftconomy3.Cause, String)
double	deposit(double amount, java.lang.String world, java.lang.String currencyName, Cause cause, java.lang.String causeReason) Adds a certain amount of money in the account
static double	format(double value) Format the value to be something less problematic.
AccountACL	getAccountACL() Get the account ACL.
java.lang.String	getAccountName() Returns the account name.
java.util.List<Balance>	getAllBalance() Get the whole account balance
java.util.List<Balance>	getAllWorldBalance(java.lang.String world) Get the whole account balance in a certain world / world group
double	getBalance(java.lang.String world, java.lang.String currencyName) Get's the player balance.
static java.lang.String	getWorldGroupOfPlayerCurrentlyIn(java.lang.String playerName) Retrieve the world group of the player
boolean	hasEnough(double amount, java.lang.String worldName, java.lang.String currencyName) Checks if we have enough money in a certain balance
boolean	hasInfiniteMoney() Checks if the account have infinite money
boolean	ignoreACL() Check if the ACL is ignored for a bank account.
boolean	isBankAccount() Checks if this account is a bank account
double	set(double amount, java.lang.String world, java.lang.String currencyName) Deprecated. use set(double, String, String, com.greatmancode.craftconomy3.Cause, String)
double	set(double amount, java.lang.String world, java.lang.String currencyName, Cause cause, java.lang.String causeReason) set a certain amount of money in the account
void	setIgnoreACL(boolean ignore) Sets if a account should ignore his ACL.
void	setInfiniteMoney(boolean infinite) Sets the account to have infinite money.
double	withdraw(double amount, java.lang.String world, java.lang.String currencyName) Deprecated. use withdraw(double, String, String, com.greatmancode.craftconomy3.Cause, String)
double	withdraw(double amount, java.lang.String world, java.lang.String currencyName, Cause cause, java.lang.String causeReason) withdraw a certain amount of money in the account

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Account

public Account(java.lang.String name,
               boolean bankAccount,
               boolean infiniteMoney,
               boolean ignoreACL)

Load a account. Creates one if it doesn't exist.

Parameters:

name - The account name

bankAccount - If the account is a bank account

infiniteMoney - If the account have no money limit

ignoreACL - If the account ignore it's ACL values (Bank only)

Method Detail

getAccountName

public java.lang.String getAccountName()

Returns the account name.

Returns:

The account name

isBankAccount

public boolean isBankAccount()

Checks if this account is a bank account

Returns:

True if this account is a bank account, else false

getAccountACL

public AccountACL getAccountACL()

Get the account ACL. Only used with a bank account

Returns:

The account ACL if it's a bank account, else null

getAllBalance

public java.util.List<Balance> getAllBalance()

Get the whole account balance

Returns:

A list of all account balance

getAllWorldBalance

public java.util.List<Balance> getAllWorldBalance(java.lang.String world)

Get the whole account balance in a certain world / world group

Parameters:

world - The world / world group to search in

Returns:

A list of Balance

getBalance

public double getBalance(java.lang.String world,
                         java.lang.String currencyName)

Get's the player balance. Sends double.MIN_NORMAL in case of a error

Parameters:

world - The world / world group to search in

currencyName - The currency Name

Returns:

The balance. If the account has infinite money. Double.MAX_VALUE is returned.

deposit

@Deprecated
public double deposit(double amount,
                                  java.lang.String world,
                                  java.lang.String currencyName)

Deprecated. use deposit(double, String, String, com.greatmancode.craftconomy3.Cause, String)

Adds a certain amount of money in the account

Parameters:

amount - The amount of money to add

world - The World / World group we want to add money in

currencyName - The currency we want to add money in

Returns:

The new balance. If the account has infinite money. Double.MAX_VALUE is returned.

deposit

public double deposit(double amount,
                      java.lang.String world,
                      java.lang.String currencyName,
                      Cause cause,
                      java.lang.String causeReason)

Adds a certain amount of money in the account

Parameters:

amount - The amount of money to add

world - The World / World group we want to add money in

currencyName - The currency we want to add money in

cause - The cause of the change.

causeReason - The reason of the cause

Returns:

The new balance. If the account has infinite money. Double.MAX_VALUE is returned.

withdraw

@Deprecated
public double withdraw(double amount,
                                   java.lang.String world,
                                   java.lang.String currencyName)

Deprecated. use withdraw(double, String, String, com.greatmancode.craftconomy3.Cause, String)

withdraw a certain amount of money in the account

Parameters:

amount - The amount of money to withdraw

world - The World / World group we want to withdraw money from

currencyName - The currency we want to withdraw money from

Returns:

The new balance. If the account has infinite money. Double.MAX_VALUE is returned.

withdraw

public double withdraw(double amount,
                       java.lang.String world,
                       java.lang.String currencyName,
                       Cause cause,
                       java.lang.String causeReason)

withdraw a certain amount of money in the account

Parameters:

amount - The amount of money to withdraw

world - The World / World group we want to withdraw money from

currencyName - The currency we want to withdraw money from

cause - The cause of the change.

causeReason - The reason of the cause.

Returns:

The new balance. If the account has infinite money. Double.MAX_VALUE is returned.

set

@Deprecated
public double set(double amount,
                              java.lang.String world,
                              java.lang.String currencyName)

Deprecated. use set(double, String, String, com.greatmancode.craftconomy3.Cause, String)

set a certain amount of money in the account

Parameters:

amount - The amount of money to set

world - The World / World group we want to set money to

currencyName - The currency we want to set money to

Returns:

The new balance

set

public double set(double amount,
                  java.lang.String world,
                  java.lang.String currencyName,
                  Cause cause,
                  java.lang.String causeReason)

set a certain amount of money in the account

Parameters:

amount - The amount of money to set

world - The World group we want to set money to

currencyName - The currency we want to set money to

cause - The cause of the change.

causeReason - The reason of the cause.

Returns:

The new balance. If the account has infinite money. Double.MAX_VALUE is returned.

hasEnough

public boolean hasEnough(double amount,
                         java.lang.String worldName,
                         java.lang.String currencyName)

Checks if we have enough money in a certain balance

Parameters:

amount - The amount of money to check

worldName - The World / World group we want to check

currencyName - The currency we want to check

Returns:

True if there's enough money. Else false

getWorldGroupOfPlayerCurrentlyIn

public static java.lang.String getWorldGroupOfPlayerCurrentlyIn(java.lang.String playerName)

Retrieve the world group of the player

Parameters:

playerName - The player name

Returns:

The worldGroup of the player.

setInfiniteMoney

public void setInfiniteMoney(boolean infinite)

Sets the account to have infinite money.

Parameters:

infinite - True if the account should have infinite money. Else false.

hasInfiniteMoney

public boolean hasInfiniteMoney()

Checks if the account have infinite money

Returns:

True if the account have infinite money. Else false.

format

public static double format(double value)

Format the value to be something less problematic. Example: 50.00999999995 will become 50.00

Parameters:

value - The double to format

Returns:

The formatted double

ignoreACL

public boolean ignoreACL()

Check if the ACL is ignored for a bank account. That means that there will be no protection on the account and anybody can deposit/withdraw from it!

Returns:

True if the ACL is ignored else false.

setIgnoreACL

public void setIgnoreACL(boolean ignore)

Sets if a account should ignore his ACL. Only works on Bank accounts.

Parameters:

ignore - If the ACL is ignored or not