app.model

Enum Suit

java.lang.Object

java.lang.Enum<Suit>

app.model.Suit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Suit>

public enum Suit
extends java.lang.Enum<Suit>

The Suit enumeration defines all suits that can be assigned to a card

Since:

v0.1

Version:

v1.0.0

Author:

Arthur

Enum Constant Summary

Enum Constants

Enum Constant and Description
Club
Diamond
Excuse
Heart
Spade
Trump

Method Summary

Modifier and Type	Method and Description
static Suit	randomSuit() Get a random suit among enum ones
static Suit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Suit[]	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

Spade

public static final Suit Spade

Heart

public static final Suit Heart

Trump

public static final Suit Trump

Diamond

public static final Suit Diamond

Club

public static final Suit Club

Excuse

public static final Suit Excuse

Method Detail

values

public static Suit[] 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 (Suit c : Suit.values())
    System.out.println(c);

Returns:

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

valueOf

public static Suit valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

randomSuit

public static Suit randomSuit()

Get a random suit among enum ones

Returns:

a random suit

Since:

v0.5

See Also:

Random