Package cryptos

Class CryptoData

java.lang.Object

cryptos.CryptoData

All Implemented Interfaces:

CryptoBase, CryptoBaseExchange

public final class CryptoData
extends java.lang.Object
implements CryptoBaseExchange

Wrapper class for RawData.

Since:

Cryptos4J v1.0

Author:

Matt - mcfadd

See Also:

RawData

Method Summary

Modifier and Type	Method	Description
java.lang.String	dataToString()	returns a string representation of the data retrieved from the CryptoCompare API
java.lang.String	getCurrencyFrom()	gets the fsym(s) parameter this object uses for the CryptoCompare API
java.lang.String	getCurrencyTo()	gets the tsym(s) parameter this object uses for the CryptoCompare API
ExchangeStreamer.exchanges	getExchange()	gets the e parameter this object uses for the CryptoCompare API
static CryptoData	getInstance(java.lang.String currencyTo, java.lang.String currencyFrom, ExchangeStreamer.exchanges exchange)	gets a new instance of CryptoData with the following parameters
RawData	getRawData()	returns RawData object equivalent to the 'RAW' json object returned by the Generate Custom Average end point.
java.net.URL	getURL()	gets the min-api.cryptocompare.com/data/generateAvg end point url with parameters currencyTo, currencyFrom, exchange, and apiKey (if any)
void	setCurrencyFrom(java.lang.String currencyFrom)	sets the fsym(s) parameter this object uses for the CryptoCompare API
void	setCurrencyTo(java.lang.String currencyTo)	sets the tsym(s) parameter this object uses for the CryptoCompare API
void	setExchange(ExchangeStreamer.exchanges exchange)	sets the e parameter this object uses for the CryptoCompare API
void	update()	updates url with parameters, then connects and updates this objects RawData aggregate with the returned json.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CryptoData getInstance(java.lang.String currencyTo,
                                     java.lang.String currencyFrom,
                                     ExchangeStreamer.exchanges exchange)

gets a new instance of CryptoData with the following parameters

Parameters:

currencyTo - currency symbol to convert to

currencyFrom - currency symbol to convert from

exchange - exchange to get data from

Returns:

new instance of CryptoData

getExchange

public ExchangeStreamer.exchanges getExchange()

Description copied from interface: CryptoBaseExchange

gets the e parameter this object uses for the CryptoCompare API

Specified by:

getExchange in interface CryptoBaseExchange

Returns:

exchange exchange to get data from

setExchange

public void setExchange(ExchangeStreamer.exchanges exchange)

Description copied from interface: CryptoBaseExchange

sets the e parameter this object uses for the CryptoCompare API

Specified by:

setExchange in interface CryptoBaseExchange

Parameters:

exchange - exchange to get data from

getCurrencyFrom

public java.lang.String getCurrencyFrom()

Description copied from interface: CryptoBase

gets the fsym(s) parameter this object uses for the CryptoCompare API

Specified by:

getCurrencyFrom in interface CryptoBase

Returns:

currencyFrom - currency symbol to convert from

setCurrencyFrom

public void setCurrencyFrom(java.lang.String currencyFrom)

Description copied from interface: CryptoBase

sets the fsym(s) parameter this object uses for the CryptoCompare API

Specified by:

setCurrencyFrom in interface CryptoBase

Parameters:

currencyFrom - currency symbol to convert from

getCurrencyTo

public java.lang.String getCurrencyTo()

Description copied from interface: CryptoBase

gets the tsym(s) parameter this object uses for the CryptoCompare API

Specified by:

getCurrencyTo in interface CryptoBase

Returns:

currencyTo currency symbol to convert to

setCurrencyTo

public void setCurrencyTo(java.lang.String currencyTo)

Description copied from interface: CryptoBase

sets the tsym(s) parameter this object uses for the CryptoCompare API

Specified by:

setCurrencyTo in interface CryptoBase

Parameters:

currencyTo - currency symbol to convert to

getURL

public java.net.URL getURL()

gets the min-api.cryptocompare.com/data/generateAvg end point url with parameters currencyTo, currencyFrom, exchange, and apiKey (if any)

Specified by:

getURL in interface CryptoBase

Returns:

URL end point this object connects to

getRawData

public RawData getRawData()

returns RawData object equivalent to the 'RAW' json object returned by the Generate Custom Average end point.

Returns:

rawData

update

public void update()
            throws InvalidArgumentException

updates url with parameters, then connects and updates this objects RawData aggregate with the returned json.

Specified by:

update in interface CryptoBase

Throws:

InvalidArgumentException

See Also:

getRawData(), getURL()

dataToString

public java.lang.String dataToString()

Description copied from interface: CryptoBase

returns a string representation of the data retrieved from the CryptoCompare API

Specified by:

dataToString in interface CryptoBase

Returns:

dataToString

See Also:

RawData.datatoString()