com.github.michaelbull.rs.ge

Class GraphingData

java.lang.Object

com.github.michaelbull.rs.ge.GraphingData

public final class GraphingData
extends java.lang.Object

Represents the data used to graphically display an Items price history on the RuneScape GrandExchange.

See Also:

Graphing Data

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static GraphingData	fromDatecodes(java.util.Map<java.lang.String,java.lang.Integer> daily, java.util.Map<java.lang.String,java.lang.Integer> average) Creates a set of GraphingData from a Map of datecodes (milliseconds since the epoch of 1970-01-01T00:00:00Z) to prices.
static GraphingData	fromLocalDates(java.util.Map<java.time.LocalDate,java.lang.Integer> daily, java.util.Map<java.time.LocalDate,java.lang.Integer> average) Creates a set of GraphingData from a Map of LocalDates to prices.
java.util.OptionalInt	getAveragePrice(java.time.LocalDate dateTime) Gets the average price of an Item given on a given LocalDate.
ImmutableMap<java.time.LocalDate,java.lang.Integer>	getAveragePrices() Gets an ImmutableMap of LocalDates to average prices.
java.util.OptionalInt	getDailyPrice(java.time.LocalDate dateTime) Gets the daily price of an Item on a given a LocalDate on the UTC time-zone.
ImmutableMap<java.time.LocalDate,java.lang.Integer>	getDailyPrices() Gets an ImmutableMap of LocalDates to daily prices.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

fromDatecodes

public static GraphingData fromDatecodes(java.util.Map<java.lang.String,java.lang.Integer> daily,
                                         java.util.Map<java.lang.String,java.lang.Integer> average)

Creates a set of GraphingData from a Map of datecodes (milliseconds since the epoch of 1970-01-01T00:00:00Z) to prices.

Parameters:

daily - The daily price values.

average - The average price values.

Returns:

The GraphingData.

fromLocalDates

public static GraphingData fromLocalDates(java.util.Map<java.time.LocalDate,java.lang.Integer> daily,
                                          java.util.Map<java.time.LocalDate,java.lang.Integer> average)

Creates a set of GraphingData from a Map of LocalDates to prices.

Parameters:

daily - The daily price values.

average - The average price values.

Returns:

The GraphingData.

getDailyPrices

public ImmutableMap<java.time.LocalDate,java.lang.Integer> getDailyPrices()

Gets an ImmutableMap of LocalDates to daily prices.

Returns:

An ImmutableMap of LocalDates to daily prices.

getDailyPrice

public java.util.OptionalInt getDailyPrice(java.time.LocalDate dateTime)

Gets the daily price of an Item on a given a LocalDate on the UTC time-zone.

Parameters:

dateTime - The LocalDate.

Returns:

An OptionalInt containing the price, or OptionalInt.empty() if no daily value was recorded on this date.

getAveragePrices

public ImmutableMap<java.time.LocalDate,java.lang.Integer> getAveragePrices()

Gets an ImmutableMap of LocalDates to average prices.

Returns:

An ImmutableMap of LocalDates to average prices.

getAveragePrice

public java.util.OptionalInt getAveragePrice(java.time.LocalDate dateTime)

Gets the average price of an Item given on a given LocalDate.

Parameters:

dateTime - The LocalDate.

Returns:

An OptionalInt containing the price, or OptionalInt.empty() if no average value was recorded on this date.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object