Card (dev.hcf.ball:ball-game API 3.0.20.20251111 API)

java.lang.Object
- ball.game.card.Card

All Implemented Interfaces:

Comparable<Card>
```
public class Card
extends Object
implements Comparable<Card>
```
Playing Card.
Bean Property Summary
Name Mode Type isHidden isBound isConstrained
color R Card.Color false false false
rank R Card.Rank false false false
suit R Card.Suit false false false

Author:

Allen D. Ball

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Card.Color`	`Card` color `Enum` type.
`static class`	`Card.Rank`	`Card` rank `Enum` type.
`static class`	`Card.Suit`	`Card` suit `Enum` type.

Constructor Summary

Constructors
Modifier Constructor Description

protected Card(Card.Suit suit, Card.Rank rank)
Sole protected constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(Card that)`
`boolean`	`equals(Object object)`
`Card.Color`	`getColor()`	Method to get the `Card` `Card.Color`.
`Card.Rank`	`getRank()`	Method to get the `Card` `Card.Rank`.
`Card.Suit`	`getSuit()`	Method to get the `Card` `Card.Suit`.
`int`	`hashCode()`
`static Card`	`parse(String string)`	Static method to parse a `String` consistent with `toString()` to a `Card`.
`String`	`toString()`

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

- Constructor Detail
  - Card
```
@ConstructorProperties({"suit","rank"})
protected Card(Card.Suit suit,
               Card.Rank rank)
```
    Sole protected constructor.
    
    Parameters:
    
    suit - The Card Card.Suit.
    
    rank - The Card Card.Rank.
- Method Detail
  - getSuit
```
public Card.Suit getSuit()
```
    Method to get the Card Card.Suit.
    
    Returns:
    
    Card.Suit
  - getRank
```
public Card.Rank getRank()
```
    Method to get the Card Card.Rank.
    
    Returns:
    
    Card.Rank
  - getColor
```
public Card.Color getColor()
```
    Method to get the Card Card.Color.
    
    Returns:
    
    Card.Suit.getColor()
  - compareTo
```
public int compareTo(Card that)
```
    Specified by:
    
    compareTo in interface Comparable<Card>
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - parse
```
public static Card parse(String string)
```
    Static method to parse a String consistent with toString() to a Card.
    
    Parameters:
    
    string - The String to parse.
    
    Returns:
    
    The Card.