com.xeiam.xchange.ripple.service.polling

Class RippleMarketDataService

java.lang.Object

com.xeiam.xchange.service.BaseExchangeService

com.xeiam.xchange.ripple.service.polling.RippleBasePollingService

com.xeiam.xchange.ripple.service.polling.RippleMarketDataServiceRaw

com.xeiam.xchange.ripple.service.polling.RippleMarketDataService

All Implemented Interfaces:

BasePollingService, PollingMarketDataService

public class RippleMarketDataService
extends RippleMarketDataServiceRaw
implements PollingMarketDataService

Field Summary

Fields inherited from class com.xeiam.xchange.ripple.service.polling.RippleBasePollingService

rippleAuthenticated, ripplePublic

Fields inherited from class com.xeiam.xchange.service.BaseExchangeService

exchange

Constructor Summary

Constructors

Constructor and Description
RippleMarketDataService(Exchange exchange)

Method Summary

Modifier and Type	Method and Description
OrderBook	getOrderBook(CurrencyPair currencyPair, Object... args) If the base currency is not XRP then the returned orders' additional data map contains a value for RippleExchange.DATA_BASE_COUNTERPARTY, similarly if the counter currency is not XRP then RippleExchange.DATA_COUNTER_COUNTERPARTY is populated.
Ticker	getTicker(CurrencyPair currencyPair, Object... args) Get a ticker representing the current exchange rate
Trades	getTrades(CurrencyPair currencyPair, Object... args) Get the trades recently performed by the exchange

Methods inherited from class com.xeiam.xchange.ripple.service.polling.RippleMarketDataServiceRaw

getRippleOrderBook

Methods inherited from class com.xeiam.xchange.service.BaseExchangeService

getExchangeSymbols, verifyOrder, verifyOrder, verifyOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xeiam.xchange.service.polling.BasePollingService

getExchangeSymbols

Constructor Detail

RippleMarketDataService

public RippleMarketDataService(Exchange exchange)

Method Detail

getOrderBook

public OrderBook getOrderBook(CurrencyPair currencyPair,
                              Object... args)
                       throws IOException

If the base currency is not XRP then the returned orders' additional data map contains a value for RippleExchange.DATA_BASE_COUNTERPARTY, similarly if the counter currency is not XRP then RippleExchange.DATA_COUNTER_COUNTERPARTY is populated.

Specified by:

getOrderBook in interface PollingMarketDataService

Parameters:

currencyPair - the base/counter currency pair

args - a RippleMarketDataParams object needs to be supplied

Returns:

The OrderBook, null if some sort of error occurred. Implementers should log the error.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

getTicker

public Ticker getTicker(CurrencyPair currencyPair,
                        Object... args)
                 throws ExchangeException,
                        NotAvailableFromExchangeException,
                        NotYetImplementedForExchangeException,
                        IOException

Description copied from interface: PollingMarketDataService

Get a ticker representing the current exchange rate

Specified by:

getTicker in interface PollingMarketDataService

Returns:

The Ticker, null if some sort of error occurred. Implementers should log the error.

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

NotAvailableFromExchangeException - - Indication that the exchange does not support the requested function or data

NotYetImplementedForExchangeException - - Indication that the exchange supports the requested function or data, but it has not yet been implemented

IOException - - Indication that a networking error occurred while fetching JSON data

getTrades

public Trades getTrades(CurrencyPair currencyPair,
                        Object... args)
                 throws ExchangeException,
                        NotAvailableFromExchangeException,
                        NotYetImplementedForExchangeException,
                        IOException

Description copied from interface: PollingMarketDataService

Get the trades recently performed by the exchange

Specified by:

getTrades in interface PollingMarketDataService

args - Optional arguments. Exchange-specific

Returns:

The Trades, null if some sort of error occurred. Implementers should log the error.

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

NotAvailableFromExchangeException - - Indication that the exchange does not support the requested function or data

NotYetImplementedForExchangeException - - Indication that the exchange supports the requested function or data, but it has not yet been implemented

IOException - - Indication that a networking error occurred while fetching JSON data