com.github.michaelbull.rs.ge

Class Item

java.lang.Object

com.github.michaelbull.rs.ge.Item

public final class Item
extends java.lang.Object

Represents an item found on the RuneScape GrandExchange.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Item.Builder

Method Summary

Modifier and Type	Method and Description
static Item.Builder	builder(int id)
boolean	equals(java.lang.Object o)
PriceTrend	getCurrentPrice() Gets the current PriceTrend of the item.
java.util.Optional<PriceChange>	getDay180() Gets an Optional containing the item's PriceChange over the last 180 days.
java.util.Optional<PriceChange>	getDay30() Gets an Optional containing the item's PriceChange over the last 30 days.
java.util.Optional<PriceChange>	getDay90() Gets an Optional containing the item's PriceChange over the last 90 days.
java.lang.String	getDescription() Gets the description of the item.
java.lang.String	getIcon() Gets the URL to the item's inventory sprite.
java.lang.String	getIconLarge() Gets the URL to the item's large sprite.
int	getId() Gets the id of the item.
java.lang.String	getName() Gets the name of the item.
PriceTrend	getTodaysPrice() Gets the PriceTrend of the item today.
java.lang.String	getType() Gets the type of item.
java.lang.String	getTypeIcon() Gets the URL to the type of item.
int	hashCode()
boolean	isMembersOnly() Checks whether this item is only accessible to members.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Item.Builder builder(int id)

getIcon

public java.lang.String getIcon()

Gets the URL to the item's inventory sprite.

Returns:

The URL to the item's inventory sprite.

getIconLarge

public java.lang.String getIconLarge()

Gets the URL to the item's large sprite.

Returns:

The URL to the item's large sprite.

getId

public int getId()

Gets the id of the item.

Returns:

The id of the item.

getType

public java.lang.String getType()

Gets the type of item.

Returns:

The type of item.

getTypeIcon

public java.lang.String getTypeIcon()

Gets the URL to the type of item.

Returns:

The URL to the type of item.

getName

public java.lang.String getName()

Gets the name of the item.

Returns:

The name of the item.

getDescription

public java.lang.String getDescription()

Gets the description of the item.

Returns:

The description of the item.

getCurrentPrice

public PriceTrend getCurrentPrice()

Gets the current PriceTrend of the item.

Returns:

The current PriceTrend of the item.

getTodaysPrice

public PriceTrend getTodaysPrice()

Gets the PriceTrend of the item today.

Returns:

The PriceTrend of the item today.

isMembersOnly

public boolean isMembersOnly()

Checks whether this item is only accessible to members.

Returns:

true if so, false otherwise.

getDay30

public java.util.Optional<PriceChange> getDay30()

Gets an Optional containing the item's PriceChange over the last 30 days.

Returns:

An Optional containing the item's PriceChange over the last 30 days, or Optional.empty() if there is no PriceChange for the last 30 days.

getDay90

public java.util.Optional<PriceChange> getDay90()

Gets an Optional containing the item's PriceChange over the last 90 days.

Returns:

An Optional containing the item's PriceChange over the last 90 days, or Optional.empty() if there is no PriceChange for the last 90 days.

getDay180

public java.util.Optional<PriceChange> getDay180()

Gets an Optional containing the item's PriceChange over the last 180 days.

Returns:

An Optional containing the item's PriceChange over the last 180 days, or Optional.empty() if there is no PriceChange for the last 180 days.

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