Package org.bitbrawl.foodfight.util

Enum PlayerComparator

java.lang.Object

java.lang.Enum<PlayerComparator>

org.bitbrawl.foodfight.util.PlayerComparator

All Implemented Interfaces:

Serializable, Comparable<Player>, Comparator<Player>

@Immutable
public enum PlayerComparator
extends Enum<PlayerComparator>
implements Comparator<Player>

A comparator that can be used to order players by their symbols. For example, if you had a list of players, you could sort it by calling Collections.sort(List, Comparator), passing in INSTANCE as your comparator.

Note: this comparator imposes orderings that are inconsistent with equals, because any two players that have the same symbol will be treated as equal. However, all players passed to competitors are uniquely identified by their symbols, so this is not an issue unless you create your own implementation of the Player interface.

Author:

Finn

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The singleton instance of this class.

Method Summary

Modifier and Type	Method	Description
int	compare(Player p1, Player p2)
static PlayerComparator	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PlayerComparator[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final PlayerComparator INSTANCE

The singleton instance of this class.

Method Detail

values

public static PlayerComparator[] 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 (PlayerComparator c : PlayerComparator.values())
    System.out.println(c);

Returns:

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

valueOf

public static PlayerComparator valueOf(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:

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

NullPointerException - if the argument is null

compare

public int compare(Player p1,
                   Player p2)

Specified by:

compare in interface Comparator<Player>