com.github.michaelbull.rs.hiscores

Class Skill

java.lang.Object

com.github.michaelbull.rs.hiscores.Skill

public final class Skill
extends java.lang.Object

Represents a players skill ranking on the RuneScape Hiscores.

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAX_EXPERIENCE The maximum amount of experience achievable in a single skill.

Constructor Summary

Constructors

Constructor and Description
Skill(CSVRecord record) Deprecated. Use fromCsv(CSVRecord).
Skill(int rank, int level, long experience) Creates a new Skill.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static java.util.Optional<Skill>	fromCsv(CSVRecord record) Creates a Skill from a CSVRecord.
java.util.OptionalLong	getExperience() Gets the amount of experience the player has earned in this skill.
int	getLevel() Gets the level the player has in this skill.
java.util.OptionalInt	getRank() Gets the rank the player has on the Hiscores for this type of skill.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_EXPERIENCE

public static final long MAX_EXPERIENCE

The maximum amount of experience achievable in a single skill.

See Also:

Constant Field Values

Constructor Detail

Skill

public Skill(int rank,
             int level,
             long experience)

Creates a new Skill.

Parameters:

rank - The rank the player has on the Hiscores for this type of skill.

level - The level the player has in this skill.

experience - The amount of experience the player has earned in this skill.

Skill

@Deprecated
public Skill(CSVRecord record)

Deprecated. Use fromCsv(CSVRecord).

Creates a new Skill from a CSVRecord.

Parameters:

record - The CSVRecord.

Method Detail

fromCsv

public static java.util.Optional<Skill> fromCsv(CSVRecord record)

Creates a Skill from a CSVRecord.

Parameters:

record - The record.

Returns:

The Skill or Optional.empty() if the record was invalid.

getRank

public java.util.OptionalInt getRank()

Gets the rank the player has on the Hiscores for this type of skill.

Returns:

An OptionalInt containing the player's rank, or OptionalInt.empty() if the player is unranked.

getLevel

public int getLevel()

Gets the level the player has in this skill.

Returns:

The level the player has in this skill.

getExperience

public java.util.OptionalLong getExperience()

Gets the amount of experience the player has earned in this skill.

Returns:

An OptionalLong containing the amount of experience the player has earned in this skill, or OptionalLong.empty() if the player is unranked.

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