Deck

java.lang.Object
- Deck

```
public class Deck
extends java.lang.Object
```
This class will be used to create Deck objects, which are groups of Cards. Deck has two fields: a Card[] to hold its current Cards, and a topCard that has the index of the top card of the Card[]. topCard is necessary because some of the Deck's functionalities require the removal of Cards, and topCard prevents those methods from needing to reinstantiate the Deck. The main functionalities of Deck are shuffle, deal, pick, selectionSort, and mergeSort. Shuffle shuffles the current deck. Deal deals a certain amount of hands from the Deck, each their own individual Deck. Pick picks a random card from the Deck, removes it and returns it. selectionSort uses a backwards SelectionSort (the algorithm used swaps to the first position not the last and continues by having the sorted section of the deck during the sort be in the front of the deck which is atypical) algorithm to sort the deck. MergeSort uses a typical MergeSort algorithm to sort the deck. The class also has class-typical functions like equals, getters, and constructors. There are 3 constructors, one that creates a sorted 52-card deck, one that can create a sorted or unsorted 52-card deck, and one that creates a deck based on the Card[] provided.

Author:

AnneMarie Caballero

Field Summary

Fields
Modifier and Type	Field	Description
`private Card[]`	`cards`	a card array that holds all of the cards in Deck
`static int`	`MAX_RANK_INT`	represents maximum integer value of rank
`static int`	`MAX_SUIT_INT`	represents maximum integer value of suit
`static int`	`MIN_RANK_INT`	represents minimum integer value of rank
`static int`	`MIN_SUIT_INT`	represents minimum integer value of suit
`static int`	`NUM_CARDS_FULL_DECK`	represents number of cards in a full deck
`static int`	`NUM_CARDS_SUIT`	represents number of cards in a suit
`static Card[]`	`sorted`	Holds the sorted Card array in the mergeSort methods
`private int`	`topCard`	the index of the top card of the deck; for a full deck, it would be 51

Constructor Summary

Constructors
Constructor	Description
`Deck()`	Constructs a default Deck object that holds 52 cards that are sorted.
`Deck(boolean sorted)`	Constructs a Deck object that holds 52 cards.
`Deck(Card[] hands)`	Constructs a Deck object with a Card[]

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Deck[]`	`deal(int numHands, int cardsPerHand)`	Deals a Deck
`boolean`	`equals(java.lang.Object other)`	Checks if this Deck is equal to the other Deck.
`Card[]`	`getCards()`	Returns the value of the Card[] that Deck holds
`int`	`getTopCard()`	Returns the index of the top card of the deck
`private static void`	`merge(Card[] temp, int from, int middle, int to)`	Joins both sides of the array sent in back together.
`void`	`mergeSort()`	Uses the MergeSort method to sort the Cards in the Deck.
`private static void`	`mSort(Card[] temp, int from, int to)`	The recursive sort part of MergeSort.
`Card`	`pick()`	Returns and removes a random Card from the Deck
`void`	`selectionSort()`	Uses the SelectionSort method to sort the Cards in the Deck
`void`	`shuffle()`	Shuffles the card array in the Deck
`java.lang.String`	`toString()`	Returns the String value of the Deck object

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - cards
```
private Card[] cards
```
    a card array that holds all of the cards in Deck
  - topCard
```
private int topCard
```
    the index of the top card of the deck; for a full deck, it would be 51
  - MIN_SUIT_INT
```
public static final int MIN_SUIT_INT
```
    represents minimum integer value of suit
    
    See Also:
    
    Constant Field Values
  - MIN_RANK_INT
```
public static final int MIN_RANK_INT
```
    represents minimum integer value of rank
    
    See Also:
    
    Constant Field Values
  - MAX_SUIT_INT
```
public static final int MAX_SUIT_INT
```
    represents maximum integer value of suit
    
    See Also:
    
    Constant Field Values
  - MAX_RANK_INT
```
public static final int MAX_RANK_INT
```
    represents maximum integer value of rank
    
    See Also:
    
    Constant Field Values
  - NUM_CARDS_FULL_DECK
```
public static final int NUM_CARDS_FULL_DECK
```
    represents number of cards in a full deck
    
    See Also:
    
    Constant Field Values
  - NUM_CARDS_SUIT
```
public static final int NUM_CARDS_SUIT
```
    represents number of cards in a suit
    
    See Also:
    
    Constant Field Values
  - sorted
```
public static Card[] sorted
```
    Holds the sorted Card array in the mergeSort methods
- Constructor Detail
  - Deck
```
public Deck()
```
    Constructs a default Deck object that holds 52 cards that are sorted.
  - Deck
```
public Deck(boolean sorted)
```
    Constructs a Deck object that holds 52 cards.
    
    Parameters:
    
    sorted - if true, sorts the Card[], if false, shuffles the Card[]
  - Deck
```
public Deck(Card[] hands)
```
    Constructs a Deck object with a Card[]
    
    Parameters:
    
    hands - sets the array of Card to the passed array
- Method Detail
  - getCards
```
public Card[] getCards()
```
    Returns the value of the Card[] that Deck holds
    
    Returns:
    
    an array of cards that is the value of the cards in the Deck
  - getTopCard
```
public int getTopCard()
```
    Returns the index of the top card of the deck
    
    Returns:
    
    an integer representing the index of the top card of the deck
  - shuffle
```
public void shuffle()
```
    Shuffles the card array in the Deck
  - toString
```
public java.lang.String toString()
```
    Returns the String value of the Deck object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of the Deck. If there is 52 cards, there will be four columns, else there will be one column.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(java.lang.Object other)
```
    Checks if this Deck is equal to the other Deck. Order matters in determining equality.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - the Deck object that this is being checked against
    
    Returns:
    
    true, if this is equal to other; false, if this is not equal to other
  - deal
```
public Deck[] deal(int numHands,
                   int cardsPerHand)
```
    Deals a Deck
    
    Parameters:
    
    numHands - an integer that represents the number of hands to be dealt
    
    cardsPerHand - an integer that represents the card per hand that is dealt
    
    Returns:
    
    null, if there are not enough cards for the deal specified; an array of Decks that represents the hands dealt
  - pick
```
public Card pick()
```
    Returns and removes a random Card from the Deck
    
    Returns:
    
    a random Card from the Deck
  - selectionSort
```
public void selectionSort()
```
    Uses the SelectionSort method to sort the Cards in the Deck
  - mergeSort
```
public void mergeSort()
```
    Uses the MergeSort method to sort the Cards in the Deck. This method uses internal methods that were created with a lot of help from the MergeSort example on pg. 394 in Java Methods book by Maria and Gary Litvin
  - mSort
```
private static void mSort(Card[] temp,
                          int from,
                          int to)
```
    The recursive sort part of MergeSort. This method was based heavily on the one from page 394 of the Java Methods book by Maria and Gary Litvin.
    
    Parameters:
    
    temp - array that references cards and thus changes cards when it is changed
    
    from - first index of given array
    
    to - last index of given arry
  - merge
```
private static void merge(Card[] temp,
                          int from,
                          int middle,
                          int to)
```
    Joins both sides of the array sent in back together. This method was based heavily on the one from page 394 of the Java Methods book by Maria and Gary Litvin.
    
    Parameters:
    
    temp - array that references cards and thus changes cards when it is changed
    
    from - first index of the given array
    
    middle - middle index of the given array
    
    to - last index of the given array

Class Deck

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cards

topCard

MIN_SUIT_INT

MIN_RANK_INT

MAX_SUIT_INT

MAX_RANK_INT

NUM_CARDS_FULL_DECK

NUM_CARDS_SUIT

sorted

Constructor Detail

Deck

Deck

Deck

Method Detail

getCards

getTopCard

shuffle

toString

equals

deal

pick

selectionSort

mergeSort

mSort

merge