com.github.michaelbull.rs.ge

Class GrandExchange

java.lang.Object

com.github.michaelbull.rs.ge.GrandExchange

public final class GrandExchange
extends java.lang.Object

Represents the RuneScape Grand Exchange API.

See Also:

Grand Exchange APIs

Field Summary

Fields

Modifier and Type	Field and Description
static ImmutableList<java.lang.String>	CATEGORIES The categories of Items on the Grand Exchange.

Constructor Summary

Constructors

Constructor and Description
GrandExchange(Client client) Creates a new GrandExchange.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Category>	category(int categoryId) Gets a Category by its id.
java.util.Optional<Category>	category(java.lang.String categoryName) Gets a Category by its name.
java.util.Optional<CategoryPrices>	categoryPrices(int categoryId, java.lang.String prefix, int page) Gets a set CategoryPrices based on the Category's id, an item's prefix, and specified page.
java.util.Optional<CategoryPrices>	categoryPrices(java.lang.String categoryName, java.lang.String prefix, int page) Gets a set CategoryPrices based on the Category's name, an item's prefix, and specified page.
java.util.Optional<GraphingData>	graphingData(int itemId) Gets the GraphingData of an Item.
java.util.Optional<ItemPriceInformation>	itemPriceInformation(int itemId) Gets the ItemPriceInformation of an Item.

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORIES

public static final ImmutableList<java.lang.String> CATEGORIES

The categories of Items on the Grand Exchange.

See Also:

Category IDs

Constructor Detail

GrandExchange

public GrandExchange(Client client)

Creates a new GrandExchange.

Parameters:

client - The web-services Client.

Method Detail

category

public java.util.Optional<Category> category(int categoryId)
                                      throws java.io.IOException

Gets a Category by its id.

Parameters:

categoryId - The id of the Category.

Returns:

An Optional containing the Category, or Optional.empty() if there is no Category for the Category id.

Throws:

java.io.IOException - If an I/O error occurs.

See Also:

Category information details

category

public java.util.Optional<Category> category(java.lang.String categoryName)
                                      throws java.io.IOException

Gets a Category by its name.

Parameters:

categoryName - The name of the Category.

Returns:

An Optional containing the Category, or Optional.empty() if there is no Category for the Category name.

Throws:

java.io.IOException - If an I/O error occurs.

See Also:

Category information details

categoryPrices

public java.util.Optional<CategoryPrices> categoryPrices(int categoryId,
                                                         java.lang.String prefix,
                                                         int page)
                                                  throws java.io.IOException

Gets a set CategoryPrices based on the Category's id, an item's prefix, and specified page.

Parameters:

categoryId - The id of the Category.

prefix - An item's prefix.

page - The page.

Returns:

An Optional containing the CategoryPrices, or Optional.empty() if no CategoryPrices were found.

Throws:

java.io.IOException - If an I/O error occurs.

See Also:

Category price details

categoryPrices

public java.util.Optional<CategoryPrices> categoryPrices(java.lang.String categoryName,
                                                         java.lang.String prefix,
                                                         int page)
                                                  throws java.io.IOException

Gets a set CategoryPrices based on the Category's name, an item's prefix, and specified page.

Parameters:

categoryName - The name of the Category.

prefix - An item's prefix.

page - The page.

Returns:

An Optional containing the CategoryPrices, or Optional.empty() if no CategoryPrices were found.

Throws:

java.io.IOException - If an I/O error occurs.

See Also:

Category price details

graphingData

public java.util.Optional<GraphingData> graphingData(int itemId)
                                              throws java.io.IOException

Gets the GraphingData of an Item.

Parameters:

itemId - The id of the Item.

Returns:

An Optional containing the GraphingData, or Optional.empty() if no GraphingData was found for the Item id.

Throws:

java.io.IOException - If an I/O error occurs.

See Also:

Graphing Data

itemPriceInformation

public java.util.Optional<ItemPriceInformation> itemPriceInformation(int itemId)
                                                              throws java.io.IOException

Gets the ItemPriceInformation of an Item.

Parameters:

itemId - The id of the Item.

Returns:

An Optional containing the ItemPriceInformation, or Optional.empty() if no ItemPriceInformation was found for the Item id.

Throws:

java.io.IOException - If an I/O error occurs.

See Also:

GE Item price information