us.talabrek.ultimateskyblock.api

Class IslandLevel

java.lang.Object

us.talabrek.ultimateskyblock.api.IslandLevel

All Implemented Interfaces:

Comparable<IslandLevel>

Direct Known Subclasses:

IslandRank

public class IslandLevel
extends Object
implements Comparable<IslandLevel>

Simple Immutable POJO for holding the island level.

Since:

v2.1.0

Constructor Summary

Constructors

Constructor and Description
IslandLevel(String islandName, String leaderName, List<String> members, double score)

Method Summary

Modifier and Type	Method and Description
int	compareTo(IslandLevel o)
boolean	equals(Object o)
String	getIslandName() Returns a logical name of the island on the form x,y
String	getLeaderName() Returns the display-name of the island-leader.
List<String>	getMembers() Returns a comma-separated list of members, with parenthesis around, or the empty string.
double	getScore() Returns the score of the island.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

IslandLevel

public IslandLevel(String islandName,
                   String leaderName,
                   List<String> members,
                   double score)

Method Detail

getIslandName

public String getIslandName()

Returns a logical name of the island on the form x,y

Returns:

the name of the island.

getLeaderName

public String getLeaderName()

Returns the display-name of the island-leader. I.e. §9[Own]§f R4zorax

Returns:

the display-name of the island-leader.

getMembers

public List<String> getMembers()

Returns a comma-separated list of members, with parenthesis around, or the empty string. I.e. (R4zorax, dutchy1001)

Returns:

a comma-separated list of members, with parenthesis around, or the empty string.

Since:

v2.1.1

getScore

public double getScore()

Returns the score of the island. Each block within the island contributes to the score. But with varying weights (i.e. cobble has a cut-off at 10000 blocks).

Returns:

the score of the island.

compareTo

public int compareTo(IslandLevel o)

Specified by:

compareTo in interface Comparable<IslandLevel>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object