com.github.michaelbull.rs.bestiary

Class Search

java.lang.Object

com.github.michaelbull.rs.bestiary.Search

public final class Search
extends java.lang.Object

Facilitates searching of the RuneScape Bestiary by applying various Filters to the search.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Search	filterByArea(java.lang.String areaName) Applies a Filter to the Search that filters by Beasts found in a specific area.
Search	filterByLevel(int lowerBound, int upperBound) Applies a Filter to the Search that filters by Beasts that have a combat level between the lower and upper bound inclusively.
Search	filterByNameFirstLetter(char letter) Applies a Filter to the Search that filters by Beasts that have names starting with a specified letter.
Search	filterByNameTerms(java.lang.String... terms) Applies a Filter to the Search that filters by Beasts that have one of the specified search terms within their name.
Search	filterBySlayerCategory(int categoryId) Applies a Filter to the Search that filters by Beasts that belong to a specific Slayer category.
Search	filterBySlayerCategory(java.lang.String categoryName) Applies a Filter to the Search that filters by Beasts that belong to a specific Slayer category.
Search	filterByWeakness(int weaknessId) Applies a Filter to the Search that filters by Beasts that are weak to a specific weakness.
Search	filterByWeakness(java.lang.String weaknessName) Applies a Filter to the Search that filters by Beasts that are weak to a specific weakness.
int	hashCode()
ImmutableMap<java.lang.Integer,java.lang.String>	results() Executes the search.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

filterByNameTerms

public Search filterByNameTerms(java.lang.String... terms)

Applies a Filter to the Search that filters by Beasts that have one of the specified search terms within their name.

Parameters:

terms - The terms to search by.

Returns:

The Search, for chaining.

filterByNameFirstLetter

public Search filterByNameFirstLetter(char letter)

Applies a Filter to the Search that filters by Beasts that have names starting with a specified letter.

Parameters:

letter - The starting letter.

Returns:

The Search, for chaining.

filterByArea

public Search filterByArea(java.lang.String areaName)

Applies a Filter to the Search that filters by Beasts found in a specific area.

Parameters:

areaName - The name of the area.

Returns:

The Search, for chaining.

filterBySlayerCategory

public Search filterBySlayerCategory(int categoryId)

Applies a Filter to the Search that filters by Beasts that belong to a specific Slayer category.

Parameters:

categoryId - The id of the Slayer category.

Returns:

The Search, for chaining.

filterBySlayerCategory

public Search filterBySlayerCategory(java.lang.String categoryName)

Applies a Filter to the Search that filters by Beasts that belong to a specific Slayer category.

Parameters:

categoryName - The name of the Slayer category.

Returns:

The Search, for chaining.

filterByWeakness

public Search filterByWeakness(int weaknessId)

Applies a Filter to the Search that filters by Beasts that are weak to a specific weakness.

Parameters:

weaknessId - The id of the weakness.

Returns:

The Search, for chaining.

filterByWeakness

public Search filterByWeakness(java.lang.String weaknessName)

Applies a Filter to the Search that filters by Beasts that are weak to a specific weakness.

Parameters:

weaknessName - The name of the weakness.

Returns:

The Search, for chaining.

filterByLevel

public Search filterByLevel(int lowerBound,
                            int upperBound)

Applies a Filter to the Search that filters by Beasts that have a combat level between the lower and upper bound inclusively.

Parameters:

lowerBound - The lowest combat level.

upperBound - The highest combat level.

Returns:

The Search, for chaining.

results

public ImmutableMap<java.lang.Integer,java.lang.String> results()
                                                         throws java.io.IOException

Executes the search.

Returns:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

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