com.github.michaelbull.rs.bestiary

Class Bestiary

java.lang.Object

com.github.michaelbull.rs.bestiary.Bestiary

public final class Bestiary
extends java.lang.Object

Represents the RuneScape Bestiary API.

See Also:

Bestiary APIs

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ImmutableList<java.lang.String>	areaNames() Gets an ImmutableList of area names.
java.util.Optional<Beast>	beastData(int beastId) Gets the a Beast by its id.
ImmutableMap<java.lang.Integer,java.lang.String>	beastsInArea(java.lang.String area) Searches for the Beasts in a given area.
ImmutableMap<java.lang.Integer,java.lang.String>	beastsInLevelGroup(int lowerBound, int upperBound) Searches for the Beasts that have a combat level between the lower and upper bound inclusively.
ImmutableMap<java.lang.Integer,java.lang.String>	beastsInSlayerCategory(int categoryId) Searches for the Beasts in a given Slayer category.
ImmutableMap<java.lang.Integer,java.lang.String>	beastsInSlayerCategory(java.lang.String categoryName) Searches for the Beasts in a given Slayer category.
ImmutableMap<java.lang.Integer,java.lang.String>	beastsWeakTo(int weaknessId) Searches for the Beasts that are weak to a specific weakness.
ImmutableMap<java.lang.Integer,java.lang.String>	beastsWeakTo(java.lang.String weaknessName) Searches for the Beasts that are weak to a specific weakness.
Search	search() Creates a new Search that will use results from this Bestiary.
ImmutableMap<java.lang.Integer,java.lang.String>	searchByFirstLetter(char letter) Searches for a Beast by the first letter in it's name.
ImmutableMap<java.lang.Integer,java.lang.String>	searchByTerms(java.lang.String... terms) Searches for a Beast's id by a set of terms.
ImmutableMap<java.lang.String,java.lang.Integer>	slayerCategories() Gets an ImmutableMap of Slayer category names to their corresponding ids.
ImmutableMap<java.lang.String,java.lang.Integer>	weaknesses() Gets an ImmutableMap of weakness category names to their corresponding ids.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bestiary

public Bestiary(Client client)

Creates a new Bestiary.

Parameters:

client - The web-services Client.

Method Detail

search

public Search search()

Creates a new Search that will use results from this Bestiary.

Returns:

The Search.

beastData

public java.util.Optional<Beast> beastData(int beastId)
                                    throws java.io.IOException

Gets the a Beast by its id.

Parameters:

beastId - The id of the Beast.

Returns:

An Optional containing the Beast, or Optional.empty() if no Beast of that id was found.

Throws:

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

See Also:

Beast Data

searchByTerms

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

Searches for a Beast's id by a set of terms.

Parameters:

terms - The terms to search by.

Returns:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

See Also:

Searching Names

searchByFirstLetter

public ImmutableMap<java.lang.Integer,java.lang.String> searchByFirstLetter(char letter)
                                                                     throws java.io.IOException

Searches for a Beast by the first letter in it's name.

Parameters:

letter - The letter to search by.

Returns:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

See Also:

Beasts A to Z

areaNames

public ImmutableList<java.lang.String> areaNames()
                                          throws java.io.IOException

Gets an ImmutableList of area names.

Returns:

An ImmutableList of area names.

Throws:

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

See Also:

Beasts by Area - areaNames

beastsInArea

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

Searches for the Beasts in a given area.

Parameters:

area - The name of the area to search for.

Returns:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

See Also:

Beasts by Area - areaBeasts

slayerCategories

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

Gets an ImmutableMap of Slayer category names to their corresponding ids.

Returns:

An ImmutableMap of Slayer category names to their corresponding ids.

Throws:

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

See Also:

Beasts by Slayer Category - slayerCatNames

beastsInSlayerCategory

public ImmutableMap<java.lang.Integer,java.lang.String> beastsInSlayerCategory(int categoryId)
                                                                        throws java.io.IOException

Searches for the Beasts in a given Slayer category.

Parameters:

categoryId - The id of the Slayer category.

Returns:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

See Also:

Beasts by Slayer Category - slayerBeasts

beastsInSlayerCategory

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

Searches for the Beasts in a given Slayer category.

Parameters:

categoryName - The name of the Slayer category.

Returns:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

See Also:

Beasts by Slayer Category - slayerBeasts

weaknesses

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

Gets an ImmutableMap of weakness category names to their corresponding ids.

Returns:

An ImmutableMap of weakness category names to their corresponding ids.

Throws:

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

See Also:

Beasts by Weakness - weaknessNames

beastsWeakTo

public ImmutableMap<java.lang.Integer,java.lang.String> beastsWeakTo(int weaknessId)
                                                              throws java.io.IOException

Searches for the Beasts that are weak to a specific weakness.

Parameters:

weaknessId - The id of the weakness.

Returns:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

See Also:

Beasts by Weakness - weaknessBeasts

beastsWeakTo

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

Searches for the Beasts that are weak to a specific weakness.

Parameters:

weaknessName - The name of the weakness.

Returns:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

See Also:

Beasts by Weakness - weaknessBeasts

beastsInLevelGroup

public ImmutableMap<java.lang.Integer,java.lang.String> beastsInLevelGroup(int lowerBound,
                                                                           int upperBound)
                                                                    throws java.io.IOException

Searches for the 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:

An ImmutableMap of Beast ids to Beast names.

Throws:

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

See Also:

Beasts by Level