ball.game.card.poker

Enum Ranking

java.lang.Object

java.lang.Enum<Ranking>

ball.game.card.poker.Ranking

All Implemented Interfaces:

Serializable, Comparable<Ranking>, Predicate<List<Card>>

public enum Ranking
extends Enum<Ranking>
implements Predicate<List<Card>>

Poker hand Ranking Enum and Predicate.

Version:

$Revision: 5431 $

Author:

Allen D. Ball

Enum Constant Summary

Enum Constants

Enum Constant and Description
Empty
FiveOfAKind
Flush
FourOfAKind
FullHouse
HighCard
Pair
RoyalFlush
Straight
StraightFlush
ThreeOfAKind
TwoPair

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<Ranking>	COMPARATOR Comparator that orders Rankings weakest to strongest.

Method Summary

Modifier and Type	Method and Description
List<Card>	find(Collection<Card> collection) Method to find the best possible this Ranking hand in the Collection.
Predicate<List<Card>>	possible() Method to return a Predicate to test if the List of Card is a possible Ranking.
int	required() Returns the number of Card for this Ranking.
boolean	test(List<Card> list)
static Ranking	valueOf(String name) Returns the enum constant of this type with the specified name.
static Ranking[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Enum Constant Detail

Empty

public static final Ranking Empty

FiveOfAKind

public static final Ranking FiveOfAKind

Flush

public static final Ranking Flush

FourOfAKind

public static final Ranking FourOfAKind

FullHouse

public static final Ranking FullHouse

HighCard

public static final Ranking HighCard

Pair

public static final Ranking Pair

RoyalFlush

public static final Ranking RoyalFlush

Straight

public static final Ranking Straight

StraightFlush

public static final Ranking StraightFlush

ThreeOfAKind

public static final Ranking ThreeOfAKind

TwoPair

public static final Ranking TwoPair

Field Detail

COMPARATOR

public static Comparator<Ranking> COMPARATOR

Comparator that orders Rankings weakest to strongest.

Method Detail

find

public List<Card> find(Collection<Card> collection)

Method to find the best possible this Ranking hand in the Collection.

Parameters:

collection - The Collection of Cards to evaluate.

Returns:

The best sorted hand as a List of Cards if a combination matching this Ranking is found; the empty List otherwise.

possible

public Predicate<List<Card>> possible()

Method to return a Predicate to test if the List of Card is a possible Ranking.

Returns:

A Predicate that returns false if the hand cannot be this Ranking; true otherwise.

required

public int required()

Returns the number of Card for this Ranking.

Returns:

The number of Cards required.

test

public boolean test(List<Card> list)

Specified by:

test in interface Predicate<List<Card>>

valueOf

public static Ranking 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

values

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

Returns:

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