com.github.michaelbull.rs.ge

Class Category

java.lang.Object

com.github.michaelbull.rs.ge.Category

public final class Category
extends java.lang.Object

Represents the information of an item category on the RuneScape GrandExchange.

See Also:

Category information details

Field Summary

Fields

Modifier and Type	Field and Description
static int	ITEMS_PER_PAGE The amount of items on each Category page.

Constructor Summary

Constructors

Constructor and Description
Category(java.lang.Object[] types, SearchResult... alpha) Creates a new Category

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
ImmutableList<SearchResult>	getAlpha() Gets an ImmutableList of the SearchResults within this category.
java.util.Optional<SearchResult>	getResult(int index) Gets a SearchResult from its index in the alpha array.
ImmutableList<java.lang.Object>	getTypes() Gets an ImmutableList of the types of item within this category.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ITEMS_PER_PAGE

public static final int ITEMS_PER_PAGE

The amount of items on each Category page.

See Also:

Constant Field Values

Constructor Detail

Category

public Category(java.lang.Object[] types,
                SearchResult... alpha)

Creates a new Category

Parameters:

types - The types of item.

alpha - The search results.

Method Detail

getTypes

public ImmutableList<java.lang.Object> getTypes()

Gets an ImmutableList of the types of item within this category.

Returns:

An ImmutableList of the types of item within this category.

getAlpha

public ImmutableList<SearchResult> getAlpha()

Gets an ImmutableList of the SearchResults within this category.

Returns:

An ImmutableList of the SearchResults within this category

getResult

public java.util.Optional<SearchResult> getResult(int index)

Gets a SearchResult from its index in the alpha array.

Parameters:

index - The index.

Returns:

An Optional containing the SearchResult, or Optional.empty() if no SearchResult was found at this index.

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