Euchre

java.lang.Object
- game.Euchre

```
public class Euchre
extends java.lang.Object
```
The Euchre class is our main class that controls the functionality of the game to be played in the console window. It can create a deck and keep track of score as the game is played.

Version:

1.0

Author:

Andrew Lawton, Dan Schroeder, Aron Ockerse

Constructor Summary

Constructors
Constructor and Description

Euchre()
A constructor for Euchre.

Constructors
Constructor and Description
`Euchre()` A constructor for Euchre.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`alone()` A method to check if alone is true or false..
`void`	`assignPoints()` A method to assign points to teams.
`Player`	`assignTrick(java.util.ArrayList<Player> players, int dead, Player current)` A method to assign the trick.
`java.util.ArrayList<Card>`	`createDeck()` A helper method used to create the deck in main.
`Card`	`deal()` A method that give each player 5 cards from the shuffled deck.
`boolean`	`gameStatus()` A method that returns the games status.
`Player`	`getDealer()` A method to return the dealer.
`java.util.ArrayList<Card>`	`getDeck()` A method to return the deck.
`Player`	`getFirstPlayer(int dPlayer)` A method to return the first player.
`java.util.ArrayList<Card>`	`getPlay()` A method to return the played cards.
`java.util.ArrayList<Player>`	`getPlayers()` A method to return the players.
`int`	`getT1Score()` A accessor used to get team 1s' score.
`int`	`getT1Trick()` A accessor to return team 1's trick count.
`int`	`getT2Score()` A accessor used to get team 2s' score.
`int`	`getT2Trick()` A accessor to return team 2's trick count.
`Suits`	`getTrump()` A method to return the trump.
`Player`	`nextPlayer(int current, int dPlayer)` A method that returns next player.
`java.util.ArrayList<Card>`	`organizeHand(java.util.ArrayList<Card> hand)` A method used to organize the hand.
`boolean`	`playable(Card lead, Card played, java.util.ArrayList<Card> hand)` A method that checks if the card played is playable or not.
`static void`	`printCard(Card c)` A method that prints a card for turn up.
`static void`	`printHand(java.util.ArrayList<Card> hand)` A method that prints the hand.
`void`	`setAlone(boolean b)` A method to set the alone boolean.
`void`	`setT1Score(int t1)` A mutator used to change team 1s' score.
`static void`	`setT1Trick(int t1)` A mutator to set team 1's trick count.
`void`	`setT2Score(int t2)` A mutator used to change team 2s' score.
`static void`	`setT2Trick(int t2)` A mutator to set team 2's trick count.
`void`	`setTrump(Suits t)` A mutator that sets trump.
`void`	`shuffle(java.util.ArrayList<Card> deck)` A method that shuffles the deck ArrayList then deals.
`void`	`shuffleTest(java.util.ArrayList<Card> deck)` A method that shuffles the deck ArrayList then deals.
`void`	`swapDealer()` A method used to swap the dealer.
`void`	`t1Point(int p)` An adder that increments team 1's score.
`void`	`t2Point(int p)` An incrementor that increments team 2's score.
`Card`	`takeTrick(java.util.ArrayList<Card> active)` A method that determines which card is the highest out of those played, and will return that card.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Euchre
```
public Euchre()
```
    A constructor for Euchre. This constructor instantiates all values for the game to be played. (Creates the deck and players
- Method Detail
  - getPlayers
```
public java.util.ArrayList<Player> getPlayers()
```
    A method to return the players.
    
    Returns:
    
    returns an ArrayList of player objects (the players)
  - getTrump
```
public Suits getTrump()
```
    A method to return the trump.
    
    Returns:
    
    returns a Suit for trump.
  - getPlay
```
public java.util.ArrayList<Card> getPlay()
```
    A method to return the played cards.
    
    Returns:
    
    returns an ArrayList of played cards
  - getDeck
```
public java.util.ArrayList<Card> getDeck()
```
    A method to return the deck.
    
    Returns:
    
    returns an ArrayList of cards.
  - alone
```
public boolean alone()
```
    A method to check if alone is true or false..
    
    Returns:
    
    returns a boolean.
  - createDeck
```
public java.util.ArrayList<Card> createDeck()
```
    A helper method used to create the deck in main.
    
    Returns:
    
    returns an ArrayList of card objects (the deck)
  - swapDealer
```
public void swapDealer()
```
    A method used to swap the dealer. Changes dealer to the next player.
  - getT1Score
```
public int getT1Score()
```
    A accessor used to get team 1s' score.
    
    Returns:
    
    returns t1Score
  - setT1Score
```
public void setT1Score(int t1)
```
    A mutator used to change team 1s' score.
    
    Parameters:
    
    t1 - a desired score
  - t1Point
```
public void t1Point(int p)
```
    An adder that increments team 1's score.
    
    Parameters:
    
    p - the point value
  - getT2Score
```
public int getT2Score()
```
    A accessor used to get team 2s' score.
    
    Returns:
    
    returns t2Score
  - setT2Score
```
public void setT2Score(int t2)
```
    A mutator used to change team 2s' score.
    
    Parameters:
    
    t2 - a desired score
  - t2Point
```
public void t2Point(int p)
```
    An incrementor that increments team 2's score.
    
    Parameters:
    
    p - the point value
  - gameStatus
```
public boolean gameStatus()
```
    A method that returns the games status.
    
    Returns:
    
    returns a boolean whether the game is complete
  - shuffle
```
public void shuffle(java.util.ArrayList<Card> deck)
```
    A method that shuffles the deck ArrayList then deals.
    
    Parameters:
    
    deck - the games deck
  - shuffleTest
```
public void shuffleTest(java.util.ArrayList<Card> deck)
```
    A method that shuffles the deck ArrayList then deals.
    
    Parameters:
    
    deck - the games deck
  - playable
```
public boolean playable(Card lead,
                        Card played,
                        java.util.ArrayList<Card> hand)
```
    A method that checks if the card played is playable or not.
    
    Parameters:
    
    lead - The lead card
    
    played - The card to check if valid
    
    hand - The players hand
    
    Returns:
    
    returns True if played is a valid card
  - setTrump
```
public void setTrump(Suits t)
```
    A mutator that sets trump.
    
    Parameters:
    
    t - the suit to set trump
  - takeTrick
```
public Card takeTrick(java.util.ArrayList<Card> active)
```
    A method that determines which card is the highest out of those played, and will return that card.
    
    Parameters:
    
    active - an array list of cards that were played
    
    Returns:
    
    returns the highest value card
  - getT1Trick
```
public int getT1Trick()
```
    A accessor to return team 1's trick count.
    
    Returns:
    
    returns t1Trick
  - setT1Trick
```
public static void setT1Trick(int t1)
```
    A mutator to set team 1's trick count.
    
    Parameters:
    
    t1 - What you want to set the trick to
  - getT2Trick
```
public int getT2Trick()
```
    A accessor to return team 2's trick count.
    
    Returns:
    
    returns t2Trick
  - setT2Trick
```
public static void setT2Trick(int t2)
```
    A mutator to set team 2's trick count.
    
    Parameters:
    
    t2 - What you want to set the trick to
  - deal
```
public Card deal()
```
    A method that give each player 5 cards from the shuffled deck.
    
    Returns:
    
    returns the card to be turned up
  - organizeHand
```
public java.util.ArrayList<Card> organizeHand(java.util.ArrayList<Card> hand)
```
    A method used to organize the hand.
    
    Parameters:
    
    hand - an ArrayList of cards that represents the hand
    
    Returns:
    
    returns the new organized hand
  - getDealer
```
public Player getDealer()
```
    A method to return the dealer.
    
    Returns:
    
    returns an a player that is the dealer.
  - getFirstPlayer
```
public Player getFirstPlayer(int dPlayer)
```
    A method to return the first player.
    
    Parameters:
    
    dPlayer - the dead player
    
    Returns:
    
    returns an player that plays first
  - assignPoints
```
public void assignPoints()
```
    A method to assign points to teams.
  - setAlone
```
public void setAlone(boolean b)
```
    A method to set the alone boolean.
    
    Parameters:
    
    b - the boolean to be set
  - assignTrick
```
public Player assignTrick(java.util.ArrayList<Player> players,
                          int dead,
                          Player current)
```
    A method to assign the trick.
    
    Parameters:
    
    players - a array list of players
    
    dead - dead player
    
    current - the current player
    
    Returns:
    
    returns a Player that receives the trick.
  - nextPlayer
```
public Player nextPlayer(int current,
                         int dPlayer)
```
    A method that returns next player.
    
    Parameters:
    
    current - The current player index
    
    dPlayer - The player not playing if alone.
    
    Returns:
    
    player Returns the next player
  - printHand
```
public static void printHand(java.util.ArrayList<Card> hand)
```
    A method that prints the hand.
    
    Parameters:
    
    hand - An array list of a cards to be printed
  - printCard
```
public static void printCard(Card c)
```
    A method that prints a card for turn up.
    
    Parameters:
    
    c - A card to be printed

Class Euchre

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Euchre

Method Detail

getPlayers

getTrump

getPlay

getDeck

alone

createDeck

swapDealer

getT1Score

setT1Score

t1Point

getT2Score

setT2Score

t2Point

gameStatus

shuffle

shuffleTest

playable

setTrump

takeTrick

getT1Trick

setT1Trick

getT2Trick

setT2Trick

deal

organizeHand

getDealer

getFirstPlayer

assignPoints

setAlone

assignTrick

nextPlayer

printHand

printCard