Package cryptos.historical

Interface HistoricalBase

All Known Implementing Classes:

HistoricalDaily, HistoricalData, HistoricalHourly, HistoricalMinute

public interface HistoricalBase

Interface for HistoricalData.

Since:

Cryptos4J v1.0

Author:

Matt - mcfadd

Method Summary

Modifier and Type	Method	Description
int	getAggregate()	gets the aggregate parameter this object uses for the CryptoCompare API
ConversionType	getConversionType()	gets the ConversionType for this object
TimestampedData	getDataAtTime(long unixTimestamp)	gets the TimestampedData with unix timestamp equal to unixTimestamp. If the unixTimestamp is in between two unix timestamps then the latter TimestampedData is returned.
java.util.stream.Stream<TimestampedData>	getDataStream()	streams TimestampedData from this Historical object
long	getLastUnixTimestamp()	gets the toTs parameter this object uses for the CryptoCompare API
int	getLimit()	gets the limit parameter this object uses for the CryptoCompare API
java.lang.String	getResponse()
long	getTimeFrom()
long	getTimeTo()
float	getType()
boolean	isAggregated()
boolean	isFirstValueInArray()
void	setAggregate(int aggregate)	sets the aggregate parameter this object uses for the CryptoCompare API
void	setLastUnixTimestamp(long lastUnixTimestamp)	sets the toTs parameter this object uses for the CryptoCompare API
void	setLimit(int limit)	sets the limit parameter this object uses for the CryptoCompare API

Method Detail

getLastUnixTimestamp

long getLastUnixTimestamp()

gets the toTs parameter this object uses for the CryptoCompare API

Returns:

lastUnixTimestap - the last unix timestamp to get data for

Since:

Cryptos4J v1.0

setLastUnixTimestamp

void setLastUnixTimestamp(long lastUnixTimestamp)

sets the toTs parameter this object uses for the CryptoCompare API

Parameters:

lastUnixTimestamp - the last unix timestamp to get data for

Since:

Cryptos4J v1.0

getAggregate

int getAggregate()

gets the aggregate parameter this object uses for the CryptoCompare API

Returns:

aggregate time period to aggregate the data over

Since:

Cryptos4J v1.0

setAggregate

void setAggregate(int aggregate)

sets the aggregate parameter this object uses for the CryptoCompare API

Parameters:

aggregate - time period to aggregate the data over

Since:

Cryptos4J v1.0

getLimit

int getLimit()

gets the limit parameter this object uses for the CryptoCompare API

Returns:

limit the number of TimestampedData to return

Since:

Cryptos4J v1.0

setLimit

void setLimit(int limit)

sets the limit parameter this object uses for the CryptoCompare API

Parameters:

limit - The number of TimestampedData to return

Since:

Cryptos4J v1.0

getResponse

java.lang.String getResponse()

Returns:

response message
Example: "Success" if data was successfully retrieved

Since:

Cryptos4J v1.0

getType

float getType()

Returns:

type

Since:

Cryptos4J v1.0

isAggregated

boolean isAggregated()

Returns:

true if data is aggregated

Since:

Cryptos4J v1.0

getTimeTo

long getTimeTo()

Returns:

unix timestamp to for this Historical object

Since:

Cryptos4J v1.0

getTimeFrom

long getTimeFrom()

Returns:

unix timestamp from for this Historical object

Since:

Cryptos4J v1.0

isFirstValueInArray

boolean isFirstValueInArray()

Returns:

true if there is a first value in the array of TimestampedData

Since:

Cryptos4J v1.0

getConversionType

ConversionType getConversionType()

gets the ConversionType for this object

Returns:

ConversionType

Since:

Cryptos4J v1.0

See Also:

ConversionType

getDataStream

java.util.stream.Stream<TimestampedData> getDataStream()

streams TimestampedData from this Historical object

Returns:

data stream

Since:

Cryptos4J v1.0

See Also:

TimestampedData

getDataAtTime

TimestampedData getDataAtTime(long unixTimestamp)
                       throws TimestampOutOfBoundsException

gets the TimestampedData with unix timestamp equal to unixTimestamp.
If the unixTimestamp is in between two unix timestamps then the latter TimestampedData is returned.

Note: this method expects the unixTimestamp parameter to be in GMT time zone

Parameters:

unixTimestamp - unix timestamp of TimestampedData to get

Returns:

TimestampedData with unix timestamp equal to or greater than unixTimestamp

Throws:

TimestampOutOfBoundsException

Since:

Cryptos4J v1.0

See Also:

TimestampedData