wcg.games

Class DefaultCardComparator

java.lang.Object

wcg.games.DefaultCardComparator

All Implemented Interfaces:

java.util.Comparator<Card>, CardComparator

Direct Known Subclasses:

WarCardComparator

public class DefaultCardComparator
extends java.lang.Object
implements CardComparator

A default implementation implementation of CardComparator based on the ranks of suits and values as defined by the respective enumerations.

Different games have different game orders and the game definitions may define their particular card comparator by extending this class, redefining only the CardValue comparator, for example.

Comparison of suits and values must take in consideration these can be null (e.g. jokers). This class is a singleton to prevent the proliferation of redundant objects in the application. Extensions of this class should also be singletons.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static DefaultCardComparator	instance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultCardComparator() Although a singleton, this class constructor is protected rather than private to enable its extension.

Method Summary

Modifier and Type	Method and Description
int	compare(Card o1, Card o2) Card order used in this game.
int	compare(CardSuit o1, CardSuit o2) Implementation of a method similar the Comparator<CardSuit> interface using the compareTo() method of Enum.
int	compare(CardValue o1, CardValue o2) Implementation of a method similar the Comparator<CardValue> interface using the the compareTo() method of Enum.
static DefaultCardComparator	getInstance() Single instance if this class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

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

Field Detail

instance

static DefaultCardComparator instance

Constructor Detail

DefaultCardComparator

protected DefaultCardComparator()

Although a singleton, this class constructor is protected rather than private to enable its extension.

Method Detail

getInstance

public static DefaultCardComparator getInstance()

Single instance if this class.

Returns:

instance.

compare

public int compare(Card o1,
                   Card o2)

Card order used in this game. Extensions may force a different order by redefining compare(CardSuit o1, CardSuit o2) and/or compare(CardValue o1, CardValue o2).

Specified by:

compare in interface java.util.Comparator<Card>

compare

public int compare(CardSuit o1,
                   CardSuit o2)

Implementation of a method similar the Comparator<CardSuit> interface using the compareTo() method of Enum.

Specified by:

compare in interface CardComparator

Parameters:

o1 - 1st object to compare.

o1 - 2nd object to compare.

o2 - 2nd object to compare.

Returns:

comparison of objects as suits.

compare

public int compare(CardValue o1,
                   CardValue o2)

Implementation of a method similar the Comparator<CardValue> interface using the the compareTo() method of Enum.

Specified by:

compare in interface CardComparator

Parameters:

o1 - 1st object to compare.

o1 - 2nd object to compare.

o2 - 2nd object to compare.

Returns:

comparison of objects as values.