com.github.michaelbull.rs.hiscores

Class ClanMate

java.lang.Object

com.github.michaelbull.rs.hiscores.ClanMate

public final class ClanMate
extends java.lang.Object

Represents a member of a clan.

Constructor Summary

Constructors

Constructor and Description
ClanMate(CSVRecord record) Deprecated. Use fromCsv(CSVRecord).
ClanMate(java.lang.String name, java.lang.String rank, long experience, int kills) Creates a new ClanMate.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static java.util.Optional<ClanMate>	fromCsv(CSVRecord record) Creates a ClanMate from a CSVRecord.
long	getExperience() Gets the experience contributed to the clan by this clan mate.
int	getKills() Gets the amount of kills earned by this clan mate.
java.lang.String	getName() Gets the name of this clan mate.
java.lang.String	getRank() Gets the rank of this clan mate.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClanMate

public ClanMate(java.lang.String name,
                java.lang.String rank,
                long experience,
                int kills)

Creates a new ClanMate.

Parameters:

name - The name of the clan mate.

rank - The rank of the clan mate.

experience - The contributed experience of the clan mate.

kills - The amount of earned kills by the clan mate.

ClanMate

@Deprecated
public ClanMate(CSVRecord record)

Deprecated. Use fromCsv(CSVRecord).

Creates a new ClanMate from a CSVRecord.

Parameters:

record - The CSVRecord.

Method Detail

fromCsv

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

Creates a ClanMate from a CSVRecord.

Parameters:

record - The record.

Returns:

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

getName

public java.lang.String getName()

Gets the name of this clan mate.

Returns:

The name of this clan mate.

getRank

public java.lang.String getRank()

Gets the rank of this clan mate.

Returns:

The rank of this clan mate.

getExperience

public long getExperience()

Gets the experience contributed to the clan by this clan mate.

Returns:

The experience contributed to the clan by this clan mate.

getKills

public int getKills()

Gets the amount of kills earned by this clan mate.

Returns:

The amount of kills earned by this clan mate.

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