Package cryptos

Class CryptoInfo

java.lang.Object

cryptos.CryptoInfo

All Implemented Interfaces:

CryptoBase

public final class CryptoInfo
extends java.lang.Object
implements CryptoBase

Wrapper class for GeneralInfo and ConversionInfo.

Since:

Cryptos4J v1.0

Author:

Matt - mcfadd

See Also:

GeneralInfo, ConversionInfo

Method Summary

Modifier and Type	Method	Description
java.lang.String	dataToString()	returns a string representation of the data retrieved from the CryptoCompare API
ConversionInfo	getConversionInfo()	returns ConversionInfo object equivalent to the 'ConversionInfo' json object returned by the Coins General Info end point.
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
GeneralInfo	getGeneralInfo()	returns GeneralInfo object equivalent to the 'GeneralInfo' json object returned by the Coins General Info.
static CryptoInfo	getInstance(java.lang.String currencyTo, java.lang.String currencyFrom)	gets a new instance of CryptoInfo with the following parameters
java.net.URL	getURL()	gets the min-api.cryptocompare.com/data/generalinfo end point url with parameters currencyTo, currencyFrom, 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
static java.util.stream.Stream<CryptoInfo>	streamCryptoInfo(java.lang.String currencyTo, java.lang.String... currenciesFrom)	streams CryptoInfo objects by connecting to the Coins General Info end point. The number of objects streamed is equal to the length of currenciesFrom.
void	update()	updates url with parameters, then connects and updates this objects GeneralInfo and ConversionInfo aggregates with the returned json.

Methods inherited from class java.lang.Object

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

Method Detail

streamCryptoInfo

public static java.util.stream.Stream<CryptoInfo> streamCryptoInfo(java.lang.String currencyTo,
                                                                   java.lang.String... currenciesFrom)
                                                            throws InvalidArgumentException

streams CryptoInfo objects by connecting to the Coins General Info end point.
The number of objects streamed is equal to the length of currenciesFrom.

Parameters:

currencyTo - currency to convert to

currenciesFrom - array of currencies to convert from

Returns:

a stream of CryptoInfo

Throws:

InvalidArgumentException

Since:

Cryptos4J v1.0

getInstance

public static CryptoInfo getInstance(java.lang.String currencyTo,
                                     java.lang.String currencyFrom)

gets a new instance of CryptoInfo with the following parameters

Parameters:

currencyTo - currency symbol to convert to

currencyFrom - currency symbol to convert from

Returns:

new instance of CryptoInfo

Since:

Cryptos4J v1.0

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/generalinfo end point url with parameters currencyTo, currencyFrom, and apiKey (if any)

Specified by:

getURL in interface CryptoBase

Returns:

URL end point this object connects to

getGeneralInfo

public GeneralInfo getGeneralInfo()

returns GeneralInfo object equivalent to the 'GeneralInfo' json object returned by the Coins General Info. end point.

Returns:

generalInfo

getConversionInfo

public ConversionInfo getConversionInfo()

returns ConversionInfo object equivalent to the 'ConversionInfo' json object returned by the Coins General Info end point.

Returns:

conversionInfo

update

public void update()
            throws InvalidArgumentException

updates url with parameters, then connects and updates this objects GeneralInfo and ConversionInfo aggregates with the returned json.

Specified by:

update in interface CryptoBase

Throws:

InvalidArgumentException

See Also:

getConversionInfo(), getGeneralInfo(), 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:

GeneralInfo.dataToString(), ConversionInfo.dataToString()