hw3.optional

Enum CardSuit

java.lang.Object

java.lang.Enum<CardSuit>

hw3.optional.CardSuit

All Implemented Interfaces:

Serializable, Comparable<CardSuit>

public enum CardSuit
extends Enum<CardSuit>

Represents one of the four suits (Hearts, Spades, Diamonds, Clubs) that appear on a playing card. This class is immutable.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLUBS The suit of clubs.
DIAMONDS The suit of diamonds.
HEARTS The suit of hearts.
SPADES The suit of spades.

Method Summary

Methods

Modifier and Type	Method and Description
static CardSuit	valueOf(String name) Returns the enum constant of this type with the specified name.
static CardSuit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLUBS

public static final CardSuit CLUBS

The suit of clubs.

DIAMONDS

public static final CardSuit DIAMONDS

The suit of diamonds.

HEARTS

public static final CardSuit HEARTS

The suit of hearts.

SPADES

public static final CardSuit SPADES

The suit of spades.

Method Detail

values

public static CardSuit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CardSuit c : CardSuit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CardSuit valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null