Package org.knowm.xchange.dto.meta

Class ExchangeMetaData

java.lang.Object

org.knowm.xchange.dto.meta.ExchangeMetaData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DsxMetaData, HitbtcMetaData

public class ExchangeMetaData
extends Object
implements Serializable

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. For more info see: https://github.com/timmolter/XChange/wiki/Design-Notes

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExchangeMetaData(Map<CurrencyPair,CurrencyPairMetaData> currencyPairs, Map<Currency,CurrencyMetaData> currency, Map<FuturesContract,DerivativeMetaData> futures, Map<OptionsContract,DerivativeMetaData> options, RateLimit[] publicRateLimits, RateLimit[] privateRateLimits, Boolean shareRateLimits)
ExchangeMetaData(Map<CurrencyPair,CurrencyPairMetaData> currencyPairs, Map<Currency,CurrencyMetaData> currency, RateLimit[] publicRateLimits, RateLimit[] privateRateLimits, Boolean shareRateLimits)	Constructor

Method Summary

Modifier and Type	Method	Description
Map<Currency,CurrencyMetaData>	getCurrencies()
Map<CurrencyPair,CurrencyPairMetaData>	getCurrencyPairs()
Map<FuturesContract,DerivativeMetaData>	getFutures()
Map<OptionsContract,DerivativeMetaData>	getOptions()
static Long	getPollDelayMillis(RateLimit[] rateLimits)
RateLimit[]	getPrivateRateLimits()
RateLimit[]	getPublicRateLimits()
boolean	isShareRateLimits()
String	toJSONString()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ExchangeMetaData

public ExchangeMetaData(Map<CurrencyPair,CurrencyPairMetaData> currencyPairs,
Map<Currency,CurrencyMetaData> currency,
RateLimit[] publicRateLimits,
RateLimit[] privateRateLimits,
Boolean shareRateLimits)

Constructor

Parameters:

currencyPairs - Map of CurrencyPair -> CurrencyPairMetaData

currency - Map of currency -> CurrencyMetaData

ExchangeMetaData

public ExchangeMetaData(Map<CurrencyPair,CurrencyPairMetaData> currencyPairs,
Map<Currency,CurrencyMetaData> currency,
Map<FuturesContract,DerivativeMetaData> futures,
Map<OptionsContract,DerivativeMetaData> options,
RateLimit[] publicRateLimits,
RateLimit[] privateRateLimits,
Boolean shareRateLimits)

Method Details

getPollDelayMillis

public static Long getPollDelayMillis(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

getCurrencyPairs

public Map<CurrencyPair,CurrencyPairMetaData> getCurrencyPairs()

getCurrencies

public Map<Currency,CurrencyMetaData> getCurrencies()

getFutures

public Map<FuturesContract,DerivativeMetaData> getFutures()

getOptions

public Map<OptionsContract,DerivativeMetaData> getOptions()

getPublicRateLimits

public RateLimit[] getPublicRateLimits()

getPrivateRateLimits

public RateLimit[] getPrivateRateLimits()

isShareRateLimits

public boolean isShareRateLimits()

toJSONString

public String toJSONString()

toString

public String toString()

Overrides:

toString in class Object