Card

java.lang.Object
- Card

All Implemented Interfaces:

java.lang.Comparable<Card>
```
public class Card
extends java.lang.Object
implements java.lang.Comparable<Card>
```
This class will be used to create Card objects. Card objects have two fields: a rank and a suit. The suit is an String and rank is an integer, but this class has provided methods to retrieve them as both Strings and integers and there are Constructors to create them with the ranks and suits as both ints, int and String, String and int, and both Strings. This class mainly just provides basic class methods: constructors, getters, toString(), compareTo(), and equals(). This is because this class is primarily being used for the Deck class.

Author:

AnneMarie Caballero

See Also:

Deck

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ACE_INT`	the integer value assigned to the Ace rank
`static java.lang.String`	`ACE_STR`	the String value assigned to the Ace rank (internally)
`static int`	`CLUBS_INT`	the integer value assigned to the clubs suit
`static java.lang.String`	`CLUBS_STR`	the String value assigned to the clubs suit
`static int`	`DIAMONDS_INT`	the integer value assigned to the diamonds suit
`static java.lang.String`	`DIAMONDS_STR`	the String value assigned to the diamonds suit
`static int`	`EIGHT_INT`	the integer value assigned to the Eight rank
`static java.lang.String`	`EIGHT_STR`	the String value assigned to the Eight rank (internally)
`static int`	`ERROR_INT`	the integer value returned by some methods if there is an error
`static java.lang.String`	`ERROR_STR`	the String value returned by a method if there is an error
`static int`	`FIVE_INT`	the integer value assigned to the Five rank
`static java.lang.String`	`FIVE_STR`	the String value assigned to the Five rank (internally)
`static int`	`FOUR_INT`	the integer value assigned to the Four rank
`static java.lang.String`	`FOUR_STR`	the String value assigned to the Four rank (internally)
`static int`	`HEARTS_INT`	the integer value assigned to the hearts suit
`static java.lang.String`	`HEARTS_STR`	the String value assigned to the hearts suit
`static int`	`JACK_INT`	the integer value assigned to the Jack rank
`static java.lang.String`	`JACK_STR`	the String value assigned to the Jack rank (internally)
`static int`	`KING_INT`	the integer value assigned to the King rank
`static java.lang.String`	`KING_STR`	the String value assigned to the King rank (internally)
`static int`	`NINE_INT`	the integer value assigned to the Nine rank
`static java.lang.String`	`NINE_STR`	the String value assigned to the Nine rank (internally)
`static int`	`QUEEN_INT`	the integer value assigned to the Queen rank
`static java.lang.String`	`QUEEN_STR`	the String value assigned to the Queen rank (internally)
`private int`	`rank`	the rank value of the Card; assignments of ranks that don't directly match to a number: 1 = ace, 11 = jack, 12 = queen, 13 = king
`static int`	`SEVEN_INT`	the integer value assigned to the Seven rank
`static java.lang.String`	`SEVEN_STR`	the String value assigned to the Seven rank (internally)
`static int`	`SIX_INT`	the integer value assigned to the Six rank
`static java.lang.String`	`SIX_STR`	the String value assigned to the Six rank (internally)
`static int`	`SPADES_INT`	the integer value assigned to the spades suit
`static java.lang.String`	`SPADES_STR`	the String value assigned to the spades suit
`private java.lang.String`	`suit`	the suit value of the Card; could be: "Clubs", "Hearts", "Diamonds", or "Spades"
`static int`	`TEN_INT`	the integer value assigned to the Ten rank
`static java.lang.String`	`TEN_STR`	the String value assigned to the Ten rank (internally)
`static int`	`THREE_INT`	the integer value assigned to the Three rank
`static java.lang.String`	`THREE_STR`	the String value assigned to the Three rank (internally)
`static int`	`TWO_INT`	the integer value assigned to the Two rank
`static java.lang.String`	`TWO_STR`	the String value assigned to the Two rank (internally)

Constructor Summary

Constructors
Constructor	Description
`Card()`	Constructs a default card (the Ace of Clubs)
`Card(int s, int r)`	Constructs a Card using two integers
`Card(int s, java.lang.String r)`	Constructs a Card using a integer, for suit, and String, for rank.
`Card(java.lang.String s, int r)`	Constructs a Card using a String, for suit, and integer, for rank.
`Card(java.lang.String s, java.lang.String r)`	Constructs a Card using two Strings

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(Card other)`	Compares two Card objects using both suit and rank
`boolean`	`equals(java.lang.Object other)`	Checks if two Cards are equal
`int`	`getRank()`	Returns the rank of the card (as an integer)
`private static int`	`getRankInt(java.lang.String r)`	Returns the integer value of a given String rank.
`java.lang.String`	`getRankStr()`	Returns the rank (as a String)
`java.lang.String`	`getSuit()`	Returns the suit of a Card (as a String)
`int`	`getSuitInt()`	Returns the suit (as an int)
`private static java.lang.String`	`getSuitStr(int s)`	Returns the String value of a suit given as an integer.
`java.lang.String`	`toString()`	Returns a String object representing the Card's value e.g.

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

- Field Detail
  - suit
```
private java.lang.String suit
```
    the suit value of the Card; could be: "Clubs", "Hearts", "Diamonds", or "Spades"
  - rank
```
private int rank
```
    the rank value of the Card; assignments of ranks that don't directly match to a number: 1 = ace, 11 = jack, 12 = queen, 13 = king
  - CLUBS_INT
```
public static final int CLUBS_INT
```
    the integer value assigned to the clubs suit
    
    See Also:
    
    Constant Field Values
  - DIAMONDS_INT
```
public static final int DIAMONDS_INT
```
    the integer value assigned to the diamonds suit
    
    See Also:
    
    Constant Field Values
  - HEARTS_INT
```
public static final int HEARTS_INT
```
    the integer value assigned to the hearts suit
    
    See Also:
    
    Constant Field Values
  - SPADES_INT
```
public static final int SPADES_INT
```
    the integer value assigned to the spades suit
    
    See Also:
    
    Constant Field Values
  - CLUBS_STR
```
public static final java.lang.String CLUBS_STR
```
    the String value assigned to the clubs suit
    
    See Also:
    
    Constant Field Values
  - DIAMONDS_STR
```
public static final java.lang.String DIAMONDS_STR
```
    the String value assigned to the diamonds suit
    
    See Also:
    
    Constant Field Values
  - HEARTS_STR
```
public static final java.lang.String HEARTS_STR
```
    the String value assigned to the hearts suit
    
    See Also:
    
    Constant Field Values
  - SPADES_STR
```
public static final java.lang.String SPADES_STR
```
    the String value assigned to the spades suit
    
    See Also:
    
    Constant Field Values
  - ACE_INT
```
public static final int ACE_INT
```
    the integer value assigned to the Ace rank
    
    See Also:
    
    Constant Field Values
  - TWO_INT
```
public static final int TWO_INT
```
    the integer value assigned to the Two rank
    
    See Also:
    
    Constant Field Values
  - THREE_INT
```
public static final int THREE_INT
```
    the integer value assigned to the Three rank
    
    See Also:
    
    Constant Field Values
  - FOUR_INT
```
public static final int FOUR_INT
```
    the integer value assigned to the Four rank
    
    See Also:
    
    Constant Field Values
  - FIVE_INT
```
public static final int FIVE_INT
```
    the integer value assigned to the Five rank
    
    See Also:
    
    Constant Field Values
  - SIX_INT
```
public static final int SIX_INT
```
    the integer value assigned to the Six rank
    
    See Also:
    
    Constant Field Values
  - SEVEN_INT
```
public static final int SEVEN_INT
```
    the integer value assigned to the Seven rank
    
    See Also:
    
    Constant Field Values
  - EIGHT_INT
```
public static final int EIGHT_INT
```
    the integer value assigned to the Eight rank
    
    See Also:
    
    Constant Field Values
  - NINE_INT
```
public static final int NINE_INT
```
    the integer value assigned to the Nine rank
    
    See Also:
    
    Constant Field Values
  - TEN_INT
```
public static final int TEN_INT
```
    the integer value assigned to the Ten rank
    
    See Also:
    
    Constant Field Values
  - JACK_INT
```
public static final int JACK_INT
```
    the integer value assigned to the Jack rank
    
    See Also:
    
    Constant Field Values
  - QUEEN_INT
```
public static final int QUEEN_INT
```
    the integer value assigned to the Queen rank
    
    See Also:
    
    Constant Field Values
  - KING_INT
```
public static final int KING_INT
```
    the integer value assigned to the King rank
    
    See Also:
    
    Constant Field Values
  - ACE_STR
```
public static final java.lang.String ACE_STR
```
    the String value assigned to the Ace rank (internally)
    
    See Also:
    
    Constant Field Values
  - TWO_STR
```
public static final java.lang.String TWO_STR
```
    the String value assigned to the Two rank (internally)
    
    See Also:
    
    Constant Field Values
  - THREE_STR
```
public static final java.lang.String THREE_STR
```
    the String value assigned to the Three rank (internally)
    
    See Also:
    
    Constant Field Values
  - FOUR_STR
```
public static final java.lang.String FOUR_STR
```
    the String value assigned to the Four rank (internally)
    
    See Also:
    
    Constant Field Values
  - FIVE_STR
```
public static final java.lang.String FIVE_STR
```
    the String value assigned to the Five rank (internally)
    
    See Also:
    
    Constant Field Values
  - SIX_STR
```
public static final java.lang.String SIX_STR
```
    the String value assigned to the Six rank (internally)
    
    See Also:
    
    Constant Field Values
  - SEVEN_STR
```
public static final java.lang.String SEVEN_STR
```
    the String value assigned to the Seven rank (internally)
    
    See Also:
    
    Constant Field Values
  - EIGHT_STR
```
public static final java.lang.String EIGHT_STR
```
    the String value assigned to the Eight rank (internally)
    
    See Also:
    
    Constant Field Values
  - NINE_STR
```
public static final java.lang.String NINE_STR
```
    the String value assigned to the Nine rank (internally)
    
    See Also:
    
    Constant Field Values
  - TEN_STR
```
public static final java.lang.String TEN_STR
```
    the String value assigned to the Ten rank (internally)
    
    See Also:
    
    Constant Field Values
  - JACK_STR
```
public static final java.lang.String JACK_STR
```
    the String value assigned to the Jack rank (internally)
    
    See Also:
    
    Constant Field Values
  - QUEEN_STR
```
public static final java.lang.String QUEEN_STR
```
    the String value assigned to the Queen rank (internally)
    
    See Also:
    
    Constant Field Values
  - KING_STR
```
public static final java.lang.String KING_STR
```
    the String value assigned to the King rank (internally)
    
    See Also:
    
    Constant Field Values
  - ERROR_STR
```
public static final java.lang.String ERROR_STR
```
    the String value returned by a method if there is an error
    
    See Also:
    
    Constant Field Values
  - ERROR_INT
```
public static final int ERROR_INT
```
    the integer value returned by some methods if there is an error
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Card
```
public Card()
```
    Constructs a default card (the Ace of Clubs)
  - Card
```
public Card(int s,
            int r)
```
    Constructs a Card using two integers
    
    Parameters:
    
    s - the value of suit in integer form
    
    r - the value of rank in integer form
    
    Throws:
    
    java.lang.IllegalArgumentException - if rank or suit values are invalid
  - Card
```
public Card(java.lang.String s,
            java.lang.String r)
```
    Constructs a Card using two Strings
    
    Parameters:
    
    s - the value of suit in String form
    
    r - the value of rank in String form
    
    Throws:
    
    java.lang.IllegalArgumentException - if rank or suit values are invalid
  - Card
```
public Card(java.lang.String s,
            int r)
```
    Constructs a Card using a String, for suit, and integer, for rank.
    
    Parameters:
    
    s - the value of suit in String form
    
    r - the value of rank in int form
    
    Throws:
    
    java.lang.IllegalArgumentException - if rank or suit values are invalid
  - Card
```
public Card(int s,
            java.lang.String r)
```
    Constructs a Card using a integer, for suit, and String, for rank.
    
    Parameters:
    
    s - the value of suit in int form
    
    r - the value of rank in String form
    
    Throws:
    
    java.lang.IllegalArgumentException - if rank or suit values are invalid
- Method Detail
  - getSuit
```
public java.lang.String getSuit()
```
    Returns the suit of a Card (as a String)
    
    Returns:
    
    the value of Suit as a String
  - getRank
```
public int getRank()
```
    Returns the rank of the card (as an integer)
    
    Returns:
    
    an integer representing the Card's rank
  - toString
```
public java.lang.String toString()
```
    Returns a String object representing the Card's value e.g. "Nine of Spades".
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the value of the Card as a String
    
    See Also:
    
    Object.toString()
  - getRankStr
```
public java.lang.String getRankStr()
```
    Returns the rank (as a String)
    
    Returns:
    
    the rank as a String
  - getSuitInt
```
public int getSuitInt()
```
    Returns the suit (as an int)
    
    Returns:
    
    the suit as an integer
  - compareTo
```
public int compareTo(Card other)
```
    Compares two Card objects using both suit and rank
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Card>
    
    Parameters:
    
    other - the Card that this Card is being compared to.
    
    Returns:
    
    1 if the Card is greater than other, -1 if this is less than other and 0 if the two Cards being compared are equal.
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)
  - equals
```
public boolean equals(java.lang.Object other)
```
    Checks if two Cards are equal
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - the Card that this Card is being checked for equality with
    
    Returns:
    
    true if the Cards are equal, false if the Cards are unequal
  - getSuitStr
```
private static java.lang.String getSuitStr(int s)
                                    throws java.lang.IllegalArgumentException
```
    Returns the String value of a suit given as an integer. Used internally to reduce redundancy of constructors where suit is given as an integer.
    
    Parameters:
    
    s - the integer version of suit that will be used to find the String equivalent
    
    Returns:
    
    the String equivalent of integer s
    
    Throws:
    
    java.lang.IllegalArgumentException - if the int given doesn't have a String equivalent for suit
  - getRankInt
```
private static int getRankInt(java.lang.String r)
                       throws java.lang.IllegalArgumentException
```
    Returns the integer value of a given String rank. Is used internally to get the equivalent integer value of a rank given as String to reduce redundancy in constructors where rank is given as a String.
    
    Parameters:
    
    r - the String value of the rank that it gets the int for
    
    Returns:
    
    the equivalent integer value to the rank held by String r
    
    Throws:
    
    java.lang.IllegalArgumentException - if String r doesn't have an equivalent integer rank

Class Card

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

suit

rank

CLUBS_INT

DIAMONDS_INT

HEARTS_INT

SPADES_INT

CLUBS_STR

DIAMONDS_STR

HEARTS_STR

SPADES_STR

ACE_INT

TWO_INT

THREE_INT

FOUR_INT

FIVE_INT

SIX_INT

SEVEN_INT

EIGHT_INT

NINE_INT

TEN_INT

JACK_INT

QUEEN_INT

KING_INT

ACE_STR

TWO_STR

THREE_STR

FOUR_STR

FIVE_STR

SIX_STR

SEVEN_STR

EIGHT_STR

NINE_STR

TEN_STR

JACK_STR

QUEEN_STR

KING_STR

ERROR_STR

ERROR_INT

Constructor Detail

Card

Card

Card

Card

Card

Method Detail

getSuit

getRank

toString

getRankStr

getSuitInt

compareTo

equals

getSuitStr

getRankInt