com.github.michaelbull.rs.hiscores

Class HiscoreActivity

java.lang.Object

com.github.michaelbull.rs.hiscores.HiscoreActivity

public final class HiscoreActivity
extends java.lang.Object

Represents a player's rank in an activity on the Hiscores.

Constructor Summary

Constructors

Constructor and Description
HiscoreActivity(CSVRecord record) Deprecated. Use fromCsv(CSVRecord).
HiscoreActivity(int rank, int score) Creates a new HiscoreActivity.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static java.util.Optional<HiscoreActivity>	fromCsv(CSVRecord record) Creates a HiscoreActivity from a CSVRecord.
java.util.OptionalInt	getRank() Gets the rank the player has in the activity.
java.util.OptionalInt	getScore() Gets the score the player has in the activity.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HiscoreActivity

public HiscoreActivity(int rank,
                       int score)

Creates a new HiscoreActivity.

Parameters:

rank - The rank the player has in the activity.

score - The score the player has in the activity.

HiscoreActivity

@Deprecated
public HiscoreActivity(CSVRecord record)

Deprecated. Use fromCsv(CSVRecord).

Creates a new HiscoreActivity from a CSVRecord.

Parameters:

record - The CSVRecord.

Method Detail

fromCsv

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

Creates a HiscoreActivity from a CSVRecord.

Parameters:

record - The record.

Returns:

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

getRank

public java.util.OptionalInt getRank()

Gets the rank the player has in the activity.

Returns:

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

getScore

public java.util.OptionalInt getScore()

Gets the score the player has in the activity.

Returns:

An OptionalInt containing the player's score, or OptionalInt.empty() if the player is unranked for this activity.

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