com.xeiam.xchange.dto.account

Class AccountInfo

java.lang.Object

com.xeiam.xchange.dto.account.AccountInfo

public final class AccountInfo
extends Object

DTO representing account information

Account information is associated with the current balances in various currencies held on the exchange.

Constructor Summary

Constructors

Constructor and Description
AccountInfo(String username, BigDecimal tradingFee, Iterable<Wallet> wallets) Constructs an AccountInfo.
AccountInfo(String username, BigDecimal tradingFee, List<Wallet> wallets) Deprecated. Use AccountInfo(String, BigDecimal, Map) instead, this constructor will be deleted in XChange 4.0.0.
AccountInfo(String username, BigDecimal tradingFee, Map<String,Wallet> wallets) Constructs an AccountInfo.
AccountInfo(String username, Iterable<Wallet> wallets)
AccountInfo(String username, List<Wallet> wallets) Deprecated. Use AccountInfo(String, Map) instead, this constructor will be deleted in XChange 4.0.0.
AccountInfo(String username, Map<String,Wallet> wallets)

Method Summary

Modifier and Type	Method and Description
BigDecimal	getBalance(String currency) Deprecated. Use getWallet(String) instead.
BigDecimal	getTradingFee() Returns the current trading fee
String	getUsername()
Wallet	getWallet(String currency) Returns the wallet of the specified currency.
List<Wallet>	getWallets()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountInfo

@Deprecated
public AccountInfo(String username,
                               List<Wallet> wallets)

Deprecated. Use AccountInfo(String, Map) instead, this constructor will be deleted in XChange 4.0.0.

Constructor

Parameters:

username - The user name

wallets - The available wallets

AccountInfo

public AccountInfo(String username,
                   Iterable<Wallet> wallets)

See Also:

AccountInfo(String, BigDecimal, Iterable).

AccountInfo

public AccountInfo(String username,
                   Map<String,Wallet> wallets)

See Also:

AccountInfo(String, BigDecimal, Map).

AccountInfo

@Deprecated
public AccountInfo(String username,
                               BigDecimal tradingFee,
                               List<Wallet> wallets)

Deprecated. Use AccountInfo(String, BigDecimal, Map) instead, this constructor will be deleted in XChange 4.0.0.

Constructor

Parameters:

username - The user name

tradingFee - the trading fee

wallets - The available wallets

AccountInfo

public AccountInfo(String username,
                   BigDecimal tradingFee,
                   Iterable<Wallet> wallets)

Constructs an AccountInfo.

Parameters:

username - the user name.

tradingFee - the trading fee.

wallets - the wallets, the currencies of the wallets should not be duplicated.

AccountInfo

public AccountInfo(String username,
                   BigDecimal tradingFee,
                   Map<String,Wallet> wallets)

Constructs an AccountInfo.

Parameters:

username - the user name.

tradingFee - the trading fee.

wallets - the wallets, key is Currencies.

Method Detail

getUsername

public String getUsername()

Returns:

The user name

getTradingFee

public BigDecimal getTradingFee()

Returns the current trading fee

Returns:

The trading fee

getWallets

public List<Wallet> getWallets()

Returns:

The available wallets (balance and currency)

getWallet

public Wallet getWallet(String currency)

Returns the wallet of the specified currency.

Parameters:

currency - one of the Currencies.

Returns:

the wallet of the specified currency, or a zero balance wallet if no wallet with such currency.

getBalance

@Deprecated
public BigDecimal getBalance(String currency)

Deprecated. Use getWallet(String) instead.

Utility method to locate an exchange balance in the given currency

Parameters:

currency - A valid currency unit (e.g. CurrencyUnit.USD or CurrencyUnit.of("BTC"))

Returns:

The balance, or zero if not found

toString

public String toString()

Overrides:

toString in class Object