PlayingCard

java.lang.Object
- cse1030.PlayingCard

All Implemented Interfaces:

Comparable<PlayingCard>
```
public final class PlayingCard
extends Object
implements Comparable<PlayingCard>
```
An immutable class representing a playing card from a standard 52 card deck. A playing card is identified by its suit (clubs, diamond, heart, spade) and its rank (two through ten, jack, queen, king, and ace). Both the suit and rank are represented with strings.

Author:

CSE1030

Constructor Summary

Constructors
Constructor and Description

PlayingCard(String rank, String suit)
Create a playing card with a given rank and suit.

Constructors
Constructor and Description
`PlayingCard(String rank, String suit)` Create a playing card with a given rank and suit.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(PlayingCard other)` Compares two playing cards by their ranks and suits.
`boolean`	`equals(Object obj)` Compares this playing card to the specified object.
`static Set<String>`	`getAllRanks()` Returns a set of the strings that can be used to specify the rank of a playing card.
`static Set<String>`	`getAllSuits()` Returns a set of the strings that can be used to specify the suit of a playing card.
`String`	`getRank()` Gets the rank of the card.
`String`	`getSuit()` Gets the suit of the card.
`int`	`hashCode()` Return a hash code for this playing card.
`static void`	`main(String[] args)`
`String`	`toString()` Returns a string representation of this playing card.

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

- Constructor Detail
  - PlayingCard
```
public PlayingCard(String rank,
           String suit)
```
    Create a playing card with a given rank and suit.
    Valid ranks are "2", "3", "4", "5", "6", "7", "8", "9", "10", "J", "Q", "K", "A" (the number cards 2 through 10, and the face cards jack, queen, king, and ace).
    Valid suits are "H", "D", "C", "S" (the suits hearts, diamonds, clubs, and spades).
    
    Throws:
    
    IllegalArgumentException - if the rank or the suit is not valid.
    Parameters:
    rank - The rank of the card.
    suit - The suit of the card.
- Method Detail
  - getRank
```
public String getRank()
```
    Gets the rank of the card. The rank is guaranteed to be one of the rank strings described in PlayingCard(String, String).
    
    See Also:
    PlayingCard(String, String)
    
    Returns:
    the rank
  - getSuit
```
public String getSuit()
```
    Gets the suit of the card. The suit is guaranteed to be one of the suit strings described in PlayingCard(String, String).
    
    See Also:
    PlayingCard(String, String)
    
    Returns:
    the suit
  - hashCode
```
public int hashCode()
```
    Return a hash code for this playing card.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    A hash code value for this playing card.
  - equals
```
public boolean equals(Object obj)
```
    Compares this playing card to the specified object. The result is true if and only if the argument is a PlayingCard with the same rank and suit as this card.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - The object to compare this PlayingCard against.
    
    Returns:
    true if the given object is a PlayingCard equal to this playing card, false otherwise.
  - compareTo
```
public int compareTo(PlayingCard other)
```
    Compares two playing cards by their ranks and suits. The result is guaranteed to be consistent with equals.
    The cards are first compared by their ranks. If their ranks are equal then the cards are compared by their suits.
    The ordering of ranks from smallest to largest is 2, 3, 4, 5, 6, 7, 8, 9, 10, J, Q, K, A (i.e., 2 is considered the smallest rank and A (ace) is considered the largest rank).
    The order of suits from smallest to largest is S, C, D, H (i.e., spades < clubs < diamonds < hearts).
    
    Specified by:
    
    compareTo in interface Comparable<PlayingCard>
    
    Parameters:
    other - The PlayingCard to be compared against.
    
    Returns:
    the value 0 if argument card is equal to this card; a value less than zero if this card is smaller than the other card; a value greater than zero if this card is greater than the other card.
  - toString
```
public String toString()
```
    Returns a string representation of this playing card.
    The returned string is the rank of the card followed by " of " followed by the suit of the card. For example, the card representing the ace of hearts has the string representation "A of H".
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this playing card.
  - getAllRanks
```
public static Set<String> getAllRanks()
```
    Returns a set of the strings that can be used to specify the rank of a playing card. The set is guaranteed to contain all of the rank strings described in PlayingCard(String, String).
    
    Returns:
    a set of the valid ranks as strings
  - getAllSuits
```
public static Set<String> getAllSuits()
```
    Returns a set of the strings that can be used to specify the suit of a playing card. The set is guaranteed to contain all of the suit strings described in PlayingCard(String, String).
    
    Returns:
    a set of the valid suits as strings
  - main
```
public static void main(String[] args)
```

Class PlayingCard

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlayingCard

Method Detail

getRank

getSuit

hashCode

equals

compareTo

toString

getAllRanks

getAllSuits

main