net.milkbowl.vault.economy

Class AbstractEconomy

java.lang.Object

net.milkbowl.vault.economy.AbstractEconomy

All Implemented Interfaces:

Economy

public abstract class AbstractEconomy
extends Object
implements Economy

Constructor Summary

Constructors

Constructor and Description
AbstractEconomy()

Method Summary

Methods

Modifier and Type	Method and Description
EconomyResponse	createBank(String name, org.bukkit.OfflinePlayer player) Creates a bank account with the specified name and the player as the owner
boolean	createPlayerAccount(org.bukkit.OfflinePlayer player) Attempts to create a player account for the given player
boolean	createPlayerAccount(org.bukkit.OfflinePlayer player, String worldName) Attempts to create a player account for the given player on the specified world IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
EconomyResponse	depositPlayer(org.bukkit.OfflinePlayer player, double amount) Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS
EconomyResponse	depositPlayer(org.bukkit.OfflinePlayer player, String worldName, double amount) Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
double	getBalance(org.bukkit.OfflinePlayer player) Gets balance of a player
double	getBalance(org.bukkit.OfflinePlayer player, String world) Gets balance of a player on the specified world.
boolean	has(org.bukkit.OfflinePlayer player, double amount) Checks if the player account has the amount - DO NOT USE NEGATIVE AMOUNTS
boolean	has(org.bukkit.OfflinePlayer player, String worldName, double amount) Checks if the player account has the amount in a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
boolean	hasAccount(org.bukkit.OfflinePlayer player) Checks if this player has an account on the server yet This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
boolean	hasAccount(org.bukkit.OfflinePlayer player, String worldName) Checks if this player has an account on the server yet on the given world This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
EconomyResponse	isBankMember(String name, org.bukkit.OfflinePlayer player) Check if the player is a member of the bank account
EconomyResponse	isBankOwner(String name, org.bukkit.OfflinePlayer player) Check if a player is the owner of a bank account
EconomyResponse	withdrawPlayer(org.bukkit.OfflinePlayer player, double amount) Withdraw an amount from a player - DO NOT USE NEGATIVE AMOUNTS
EconomyResponse	withdrawPlayer(org.bukkit.OfflinePlayer player, String worldName, double amount) Withdraw an amount from a player on a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.milkbowl.vault.economy.Economy

bankBalance, bankDeposit, bankHas, bankWithdraw, createBank, createPlayerAccount, createPlayerAccount, currencyNamePlural, currencyNameSingular, deleteBank, depositPlayer, depositPlayer, format, fractionalDigits, getBalance, getBalance, getBanks, getName, has, has, hasAccount, hasAccount, hasBankSupport, isBankMember, isBankOwner, isEnabled, withdrawPlayer, withdrawPlayer

Constructor Detail

AbstractEconomy

public AbstractEconomy()

Method Detail

hasAccount

public boolean hasAccount(org.bukkit.OfflinePlayer player)

Description copied from interface: Economy

Checks if this player has an account on the server yet This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server

Specified by:

hasAccount in interface Economy

Parameters:

player - to check

Returns:

if the player has an account

hasAccount

public boolean hasAccount(org.bukkit.OfflinePlayer player,
                 String worldName)

Description copied from interface: Economy

Checks if this player has an account on the server yet on the given world This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server

Specified by:

hasAccount in interface Economy

Parameters:

player - to check in the world

worldName - world-specific account

Returns:

if the player has an account

getBalance

public double getBalance(org.bukkit.OfflinePlayer player)

Description copied from interface: Economy

Gets balance of a player

Specified by:

getBalance in interface Economy

Parameters:

player - of the player

Returns:

Amount currently held in players account

getBalance

public double getBalance(org.bukkit.OfflinePlayer player,
                String world)

Description copied from interface: Economy

Gets balance of a player on the specified world. IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.

Specified by:

getBalance in interface Economy

Parameters:

player - to check

world - name of the world

Returns:

Amount currently held in players account

has

public boolean has(org.bukkit.OfflinePlayer player,
          double amount)

Description copied from interface: Economy

Checks if the player account has the amount - DO NOT USE NEGATIVE AMOUNTS

Specified by:

has in interface Economy

Parameters:

player - to check

amount - to check for

Returns:

True if player has amount, False else wise

has

public boolean has(org.bukkit.OfflinePlayer player,
          String worldName,
          double amount)

Description copied from interface: Economy

Checks if the player account has the amount in a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.

Specified by:

has in interface Economy

Parameters:

player - to check

worldName - to check with

amount - to check for

Returns:

True if player has amount, False else wise

withdrawPlayer

public EconomyResponse withdrawPlayer(org.bukkit.OfflinePlayer player,
                             double amount)

Description copied from interface: Economy

Withdraw an amount from a player - DO NOT USE NEGATIVE AMOUNTS

Specified by:

withdrawPlayer in interface Economy

Parameters:

player - to withdraw from

amount - Amount to withdraw

Returns:

Detailed response of transaction

withdrawPlayer

public EconomyResponse withdrawPlayer(org.bukkit.OfflinePlayer player,
                             String worldName,
                             double amount)

Description copied from interface: Economy

Withdraw an amount from a player on a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.

Specified by:

withdrawPlayer in interface Economy

Parameters:

player - to withdraw from

worldName - - name of the world

amount - Amount to withdraw

Returns:

Detailed response of transaction

depositPlayer

public EconomyResponse depositPlayer(org.bukkit.OfflinePlayer player,
                            double amount)

Description copied from interface: Economy

Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS

Specified by:

depositPlayer in interface Economy

Parameters:

player - to deposit to

amount - Amount to deposit

Returns:

Detailed response of transaction

depositPlayer

public EconomyResponse depositPlayer(org.bukkit.OfflinePlayer player,
                            String worldName,
                            double amount)

Description copied from interface: Economy

Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.

Specified by:

depositPlayer in interface Economy

Parameters:

player - to deposit to

worldName - name of the world

amount - Amount to deposit

Returns:

Detailed response of transaction

createBank

public EconomyResponse createBank(String name,
                         org.bukkit.OfflinePlayer player)

Description copied from interface: Economy

Creates a bank account with the specified name and the player as the owner

Specified by:

createBank in interface Economy

Parameters:

name - of account

player - the account should be linked to

Returns:

EconomyResponse Object

isBankOwner

public EconomyResponse isBankOwner(String name,
                          org.bukkit.OfflinePlayer player)

Description copied from interface: Economy

Check if a player is the owner of a bank account

Specified by:

isBankOwner in interface Economy

Parameters:

name - of the account

player - to check for ownership

Returns:

EconomyResponse Object

isBankMember

public EconomyResponse isBankMember(String name,
                           org.bukkit.OfflinePlayer player)

Description copied from interface: Economy

Check if the player is a member of the bank account

Specified by:

isBankMember in interface Economy

Parameters:

name - of the account

player - to check membership

Returns:

EconomyResponse Object

createPlayerAccount

public boolean createPlayerAccount(org.bukkit.OfflinePlayer player)

Description copied from interface: Economy

Attempts to create a player account for the given player

Specified by:

createPlayerAccount in interface Economy

Parameters:

player - OfflinePlayer

Returns:

if the account creation was successful

createPlayerAccount

public boolean createPlayerAccount(org.bukkit.OfflinePlayer player,
                          String worldName)

Description copied from interface: Economy

Attempts to create a player account for the given player on the specified world IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.

Specified by:

createPlayerAccount in interface Economy

Parameters:

player - OfflinePlayer

worldName - String name of the world

Returns:

if the account creation was successful