com.github.michaelbull.rs.hiscores

Enum HiscoreTable

java.lang.Object

java.lang.Enum<HiscoreTable>

com.github.michaelbull.rs.hiscores.HiscoreTable

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HiscoreTable>

public enum HiscoreTable
extends java.lang.Enum<HiscoreTable>

Represents a type of hiscore table found on the RuneScape Hiscores.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT The default RuneScape Hiscores.
HARDCORE_IRONMAN The Hiscores for hardcore ironman players.
IRONMAN The Hiscores for ironman players.
OLDSCHOOL The oldschool RuneScape Hiscores.
OLDSCHOOL_IRONMAN The Hiscores for oldschool RuneScape ironman players.
OLDSCHOOL_ULTIMATE_IRONMAN The Hiscores for oldschool RuneScape ultimate ironman players.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<HiscoreTable>	from(java.lang.String name) Gets a HiscoreTable from its name.
ImmutableList<java.lang.String>	getActivityNames() Gets the names of activities found on this hiscore table.
java.lang.String	getName() Gets the name of this hiscore table.
ImmutableList<java.lang.String>	getSkillNames() Gets the names of skills found on this hiscore table.
java.lang.String	toString()
static HiscoreTable	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HiscoreTable[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final HiscoreTable DEFAULT

The default RuneScape Hiscores.

IRONMAN

public static final HiscoreTable IRONMAN

The Hiscores for ironman players.

See Also:

Ironman modes

HARDCORE_IRONMAN

public static final HiscoreTable HARDCORE_IRONMAN

The Hiscores for hardcore ironman players.

See Also:

Ironman modes

OLDSCHOOL

public static final HiscoreTable OLDSCHOOL

The oldschool RuneScape Hiscores.

See Also:

Old School RuneScape

OLDSCHOOL_IRONMAN

public static final HiscoreTable OLDSCHOOL_IRONMAN

The Hiscores for oldschool RuneScape ironman players.

See Also:

Old School RuneScape

OLDSCHOOL_ULTIMATE_IRONMAN

public static final HiscoreTable OLDSCHOOL_ULTIMATE_IRONMAN

The Hiscores for oldschool RuneScape ultimate ironman players.

See Also:

Old School RuneScape

Method Detail

values

public static HiscoreTable[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HiscoreTable c : HiscoreTable.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HiscoreTable valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

from

public static java.util.Optional<HiscoreTable> from(java.lang.String name)

Gets a HiscoreTable from its name.

Parameters:

name - The name of the HiscoreTable.

Returns:

The HiscoreTable or Optional.empty() if no table was found.

getName

public java.lang.String getName()

Gets the name of this hiscore table.

Returns:

The name of this hiscore table.

getSkillNames

public ImmutableList<java.lang.String> getSkillNames()

Gets the names of skills found on this hiscore table.

Returns:

The names of skills found on this hiscore table.

getActivityNames

public ImmutableList<java.lang.String> getActivityNames()

Gets the names of activities found on this hiscore table.

Returns:

The names of activities found on this hiscore table.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<HiscoreTable>