com.github.michaelbull.rs.hiscores

Class Hiscores

java.lang.Object

com.github.michaelbull.rs.hiscores.Hiscores

public final class Hiscores
extends java.lang.Object

Represents the RuneScape Hiscores API.

See Also:

Hiscores APIs

Field Summary

Fields

Modifier and Type	Field and Description
static ImmutableList<java.lang.String>	ACTIVITY_NAMES The RuneScape activity names.
static ImmutableList<java.lang.String>	OLDSCHOOL_ACTIVITY_NAMES The oldschool RuneScape activity names.
static ImmutableList<java.lang.String>	OLDSCHOOL_SKILL_NAMES The oldschool RuneScape skill names.
static ImmutableList<java.lang.String>	SKILL_NAMES The RuneScape skill names.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ImmutableList<ClanMate>	clanInformation(java.lang.String clanName) Gets an ImmutableList of ClanMates within a clan, based on the clan's name.
java.util.Optional<Player>	playerInformation(java.lang.String displayName, HiscoreTable table) Gets a Player based on their display name.

Methods inherited from class java.lang.Object

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

Field Detail

SKILL_NAMES

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

The RuneScape skill names.

OLDSCHOOL_SKILL_NAMES

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

The oldschool RuneScape skill names.

ACTIVITY_NAMES

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

The RuneScape activity names.

OLDSCHOOL_ACTIVITY_NAMES

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

The oldschool RuneScape activity names.

Constructor Detail

Hiscores

public Hiscores(Client client)

Creates a new Hiscores.

Parameters:

client - The web-services Client.

Method Detail

playerInformation

public java.util.Optional<Player> playerInformation(java.lang.String displayName,
                                                    HiscoreTable table)
                                             throws java.io.IOException

Gets a Player based on their display name.

Parameters:

displayName - The player's display name.

table - The table of Hiscores.

Returns:

An Optional containing the Player, or Optional.empty() if no Player was found with that name.

Throws:

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

See Also:

Top Players

clanInformation

public ImmutableList<ClanMate> clanInformation(java.lang.String clanName)
                                        throws java.io.IOException

Gets an ImmutableList of ClanMates within a clan, based on the clan's name.

Parameters:

clanName - The clan's name.

Returns:

An ImmutableList of ClanMates in the clan.

Throws:

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

See Also:

Clans