Class CardComparator

java.lang.Object

CardComparator

All Implemented Interfaces:

java.util.Comparator<Card>

public class CardComparator
extends java.lang.Object
implements java.util.Comparator<Card>

This Comparator is for Card objects, and compares them on the basis of rank. This Comparator was modeled off the Comparator example from pg.384 of the Java Methods book by Maria and Gary Litvin. The Comparator does not include suit in its comparison. Additionally, the comparator has one boolean which determines whether or not the comparator is sorting in ascending order (if true) or descending order (if false). The default constructor however just sets this boolean field to true.

Author:

AnneMarie Caballero

See Also:

Comparator

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	ascend	A boolean that keeps track of whether the Cards should be sorted in ascending or descending order.

Constructor Summary

Constructors

Constructor	Description
CardComparator()	Constructs a default CardComparator object that can be used to sort Cards in ascending order
CardComparator(boolean asc)	Constructs a default CardComparator object

Method Summary

Modifier and Type	Method	Description
int	compare(Card card1, Card card2)	Compares two Cards

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.Object

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

Field Detail

ascend

private boolean ascend

A boolean that keeps track of whether the Cards should be sorted in ascending or descending order. If true, Cards should be sorted in ascending order. If false, Cards should be sorted in descending order.

Constructor Detail

CardComparator

public CardComparator()

Constructs a default CardComparator object that can be used to sort Cards in ascending order

CardComparator

public CardComparator(boolean asc)

Constructs a default CardComparator object

Parameters:

asc - a boolean that if true, indicates to sort cards in an ascending fashion, and if false indicates to sort cards in a descending fashion

Method Detail

compare

public int compare(Card card1,
                   Card card2)

Compares two Cards

Specified by:

compare in interface java.util.Comparator<Card>

Parameters:

card1 - the first Card to be compared

card2 - the second Card to be compared

Returns:

an int that represent the difference between card1 and card2. the difference will be negative if asc is false.

See Also:

Comparator.compare(java.lang.Object, java.lang.Object)