com.xeiam.xchange.dto.meta

Class ExchangeMetaData

java.lang.Object

com.xeiam.xchange.dto.meta.ExchangeMetaData

Direct Known Subclasses:

ANXMetaData

public class ExchangeMetaData
extends Object

This class is loaded during creation of the Exchange and is intended to hold both data that is readily available from an HTTP API request at an exchange extended by semi-static data that is not available from an HTTP API, but is still important information to have. Examples include currency pairs, max polling rates, scaling factors, etc.

This class is used only in the API by the classes that merge metadata stored in custom JSON file and online info from the remote exchange.

Constructor Summary

Constructors

Constructor and Description
ExchangeMetaData(Map<CurrencyPair,MarketMetaData> currencyPairs, Map<String,CurrencyMetaData> currency, Set<RateLimit> publicRateLimits, Set<RateLimit> privateRateLimits, Boolean shareRateLimits)

Method Summary

Modifier and Type	Method and Description
Map<String,CurrencyMetaData>	getCurrencyMetaDataMap()
Map<CurrencyPair,MarketMetaData>	getMarketMetaDataMap()
static Long	getPollDelayMillis(Set<RateLimit> rateLimits)
Set<RateLimit>	getPrivateRateLimits()
Set<RateLimit>	getPublicRateLimits()
boolean	isShareRateLimits()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExchangeMetaData

public ExchangeMetaData(Map<CurrencyPair,MarketMetaData> currencyPairs,
                        Map<String,CurrencyMetaData> currency,
                        Set<RateLimit> publicRateLimits,
                        Set<RateLimit> privateRateLimits,
                        Boolean shareRateLimits)

Parameters:

currencyPairs - Map of CurrencyPair -> MarketMetaData

currency - Map of currency -> CurrencyMetaData

Method Detail

getMarketMetaDataMap

public Map<CurrencyPair,MarketMetaData> getMarketMetaDataMap()

getCurrencyMetaDataMap

public Map<String,CurrencyMetaData> getCurrencyMetaDataMap()

getPublicRateLimits

public Set<RateLimit> getPublicRateLimits()

getPrivateRateLimits

public Set<RateLimit> getPrivateRateLimits()

isShareRateLimits

public boolean isShareRateLimits()

getPollDelayMillis

public static Long getPollDelayMillis(Set<RateLimit> rateLimits)

Returns:

minimum number of milliseconds required between any two remote calls, assuming the client makes consecutive calls without any bursts or breaks for an infinite period of time. Returns null if the rateLimits collection is null or empty

toString

public String toString()

Overrides:

toString in class Object