com.javaflair.pokerprophesier.api.helper
Class MyHandHelper

java.lang.Object
  com.javaflair.pokerprophesier.api.helper.MyHandHelper

public class MyHandHelper
extends Object

A helper which contains the analysis of my current hand.

The helper can not be instantiated directly, rather a reference must be retrieved from the PokerProphesierAdapter after the PokerProphesierAdapter.runMySimulations(HoleCards, CommunityCards, int, int) simulator method is executed.

The helper is populated in all game states.

Author:

Javaflair

See Also:

PokerProphesierAdapter, PokerProphesierAdapter.getMyHandHelper()

Method Summary

CommunityCards	getCommunityCards() Returns the community cards.
Hand	getHand() Returns the hand.
Card[]	getHandCards() Returns the cards which make up the hand.
Card[]	getHandCommunityCards() Returns the community cards used in the hand.
Card[]	getHandHoleCards() Returns the hole cards used in the hand.
int	getHandRank() Returns the hand rank.
HoleCards	getHoleCards() Returns my hole cards.
Card[]	getKickerCards() Returns the kicker (least significant) cards in the hand.
Card[]	getSignificantCards() Returns the significant cards in the hand.
Card	getTopHoleCardKicker() Returns the top hole card kicker (if there is one).
boolean	isBottomPair() Returns a boolean indicating whether the pair is bottom pair (the hole card is matched with the lowest card on the board).
boolean	isFlushDraw() Returns a boolean indicating whether the hand is a flush draw.
boolean	isHoleCardHand() Returns a boolean indicating whether the significant cards of the hand include at least one hole card, meaning that the significant part of the hand is not solely on the board and shared amongst all players.
boolean	isMiddlePair() Returns a boolean indicating whether the pair is middle pair (the hole card is paired with a card between the highest and lowest card on the board).
boolean	isOverPair() Returns a boolean indicating whether the hole cards pocket pair is an over pair (higher than the highest card on the board).
boolean	isPocketPair() Returns a boolean indicating whether the hole cards are a pocket pair.
boolean	isSecondPair() Returns a boolean indicating whether the hole cards pocket pair is second pair (between the highest and second highest cards on the board).
boolean	isSet() Returns a boolean indicating whether the three-of-a-kind is a set (matching a pocket pair with a card on the board).
boolean	isStraightDraw() Returns a boolean indicating whether the hand is a straight draw.
boolean	isStraightFlushDraw() Returns a boolean indicating whether the hand is a straight flush draw.
boolean	isTheNuts() Returns a boolean indicating whether the hand is currently The Nuts, given my hole cards, the community cards dealt and the possible hole cards an opponent could have.
boolean	isTopHoleCardKickerAce() Returns a boolean indicating whether the top hole card kicker is an ace.
boolean	isTopKickerHoleCard() Returns a boolean indicating whether the top kicker in the hand is a hole card rather than a community card.
boolean	isTopPair() Returns a boolean indicating whether the pair is top pair (the hole card is paired with the highest card on the board).
boolean	isTrips() Returns a boolean indicating whether the three-of-a-kind is trips (matching one hole card with a pair on the board).
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getHoleCards

public HoleCards getHoleCards()

Returns my hole cards.

Returns:

the hole cards

See Also:

HoleCards

getCommunityCards

public CommunityCards getCommunityCards()

Returns the community cards.

Returns:

the community cards

See Also:

CommunityCards

getHand

public Hand getHand()

Returns the hand.

Returns:

the hand

See Also:

Hand

getHandCards

public Card[] getHandCards()

Returns the cards which make up the hand.

Returns:

the array of cards

getHandRank

public int getHandRank()

Returns the hand rank.

Returns:

the hand rank

getHandHoleCards

public Card[] getHandHoleCards()

Returns the hole cards used in the hand.

Returns:

the hole cards

getHandCommunityCards

public Card[] getHandCommunityCards()

Returns the community cards used in the hand.

Returns:

the community cards

getSignificantCards

public Card[] getSignificantCards()

Returns the significant cards in the hand. Significant cards are the non-kicker cards.

Returns:

the significant cards

isHoleCardHand

public boolean isHoleCardHand()

Returns a boolean indicating whether the significant cards of the hand include at least one hole card, meaning that the significant part of the hand is not solely on the board and shared amongst all players.

Returns:

true if the hand is a hole card hand; false if not

isTheNuts

public boolean isTheNuts()

Returns a boolean indicating whether the hand is currently The Nuts, given my hole cards, the community cards dealt and the possible hole cards an opponent could have.

Returns:

true if the hand is currently the nuts; false if not

isStraightDraw

public boolean isStraightDraw()

Returns a boolean indicating whether the hand is a straight draw.

Returns:

true if a straight draw; false if not

isFlushDraw

public boolean isFlushDraw()

Returns a boolean indicating whether the hand is a flush draw.

Returns:

true if a flush draw; false if not

isStraightFlushDraw

public boolean isStraightFlushDraw()

Returns a boolean indicating whether the hand is a straight flush draw.

Returns:

true if a straight flush draw; false if not

isTrips

public boolean isTrips()

Returns a boolean indicating whether the three-of-a-kind is trips (matching one hole card with a pair on the board).

Returns:

true if trips; false if not

isSet

public boolean isSet()

Returns a boolean indicating whether the three-of-a-kind is a set (matching a pocket pair with a card on the board).

Returns:

true if a set; false if not

isTopPair

public boolean isTopPair()

Returns a boolean indicating whether the pair is top pair (the hole card is paired with the highest card on the board).

Returns:

true if top pair; false if not

isMiddlePair

public boolean isMiddlePair()

Returns a boolean indicating whether the pair is middle pair (the hole card is paired with a card between the highest and lowest card on the board).

Returns:

true if middle pair; false if not

isBottomPair

public boolean isBottomPair()

Returns a boolean indicating whether the pair is bottom pair (the hole card is matched with the lowest card on the board).

Returns:

true if bottom pair; false if not

isPocketPair

public boolean isPocketPair()

Returns a boolean indicating whether the hole cards are a pocket pair.

Returns:

true if pocket pair; false if not

isOverPair

public boolean isOverPair()

Returns a boolean indicating whether the hole cards pocket pair is an over pair (higher than the highest card on the board).

Returns:

true if an over pair; false if not

isSecondPair

public boolean isSecondPair()

Returns a boolean indicating whether the hole cards pocket pair is second pair (between the highest and second highest cards on the board).

Returns:

true if second pair; false if not

getKickerCards

public Card[] getKickerCards()

Returns the kicker (least significant) cards in the hand.

Returns:

the array of kicker cards

getTopHoleCardKicker

public Card getTopHoleCardKicker()

Returns the top hole card kicker (if there is one).

Returns:

the top hole card kicker

isTopKickerHoleCard

public boolean isTopKickerHoleCard()

Returns a boolean indicating whether the top kicker in the hand is a hole card rather than a community card.

Returns:

true if the top kicker is a hole card; false if not

isTopHoleCardKickerAce

public boolean isTopHoleCardKickerAce()

Returns a boolean indicating whether the top hole card kicker is an ace.

Returns:

true if an ace; false if not

toString

public String toString()

Overrides:

toString in class Object