Package dev.ioliver.enums

Enum Class Suits

java.lang.Object

java.lang.Enum<Suits>

dev.ioliver.enums.Suits

All Implemented Interfaces:

Serializable, Comparable<Suits>, Constable

public enum Suits
extends Enum<Suits>

The Suits enum represents the suits of playing cards. Each suit has an associated image reference and label.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLUBS
DIAMONDS
HEARTS
JOKER
SPADES

Method Summary

Modifier and Type	Method	Description
org.opencv.core.Mat	getImgReference()	Returns the image reference for the suit.
String	getLabel()	Returns the label associated with the suit.
static List<Suits>	getList()	Returns a list of all suits.
static Suits	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Suits[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HEARTS

public static final Suits HEARTS

DIAMONDS

public static final Suits DIAMONDS

CLUBS

public static final Suits CLUBS

SPADES

public static final Suits SPADES

JOKER

public static final Suits JOKER

Method Details

values

public static Suits[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Suits valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getList

public static List<Suits> getList()

Returns a list of all suits.

Returns:

A list of Suits enum values.

getLabel

public String getLabel()

Returns the label associated with the suit.

Returns:

The label of the suit.

getImgReference

public org.opencv.core.Mat getImgReference()

Returns the image reference for the suit.

Returns:

The image reference as a Mat object.