de.alpharogroup.lottery.wincategories

Enum LotteryWinCategory

java.lang.Object

java.lang.Enum<LotteryWinCategory>

de.alpharogroup.lottery.wincategories.LotteryWinCategory

All Implemented Interfaces:

WinningOpportunity, java.io.Serializable, java.lang.Comparable<LotteryWinCategory>

public enum LotteryWinCategory
extends java.lang.Enum<LotteryWinCategory>
implements WinningOpportunity

The enum LotteryWinCategory represents all lottery winning categories.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EIGHTH_CLASS The eighth winning class.
FIFTH_CLASS The fifth winning class.
FIRST_CLASS The first winning class.
FOURTH_CLASS The fourth winning class.
NINTH_CLASS The ninth winning class.
NONE The none winning class.
SECOND_CLASS The second winning class.
SEVENTH_CLASS The seventh winning class.
SIXTH_CLASS The sixth winning class.
THIRD_CLASS The third winning class.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<LotteryWinCategory>	getLotteryWinCategory(java.util.Collection<java.lang.Integer> wonLotteryTicket, boolean withSuperNumber) Gets an Optional with the LotteryWinCategory from the given Collection that contains the result of an intersection with the drawn lottery numbers.
static java.util.Optional<LotteryWinCategory>	getLotteryWinCategory(java.util.Collection<java.lang.Integer> drawnLotteryNumbers, java.util.Collection<java.lang.Integer> playedLotteryTicket, boolean withSuperNumber) Gets an Optional with the LotteryWinCategory that is an intersection of the given drawn lottery numbers and the given played lottery Ticket.
static LotteryWinCategory	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LotteryWinCategory[]	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

EIGHTH_CLASS

public static final LotteryWinCategory EIGHTH_CLASS

The eighth winning class.

FIFTH_CLASS

public static final LotteryWinCategory FIFTH_CLASS

The fifth winning class.

FIRST_CLASS

public static final LotteryWinCategory FIRST_CLASS

The first winning class.

FOURTH_CLASS

public static final LotteryWinCategory FOURTH_CLASS

The fourth winning class.

NINTH_CLASS

public static final LotteryWinCategory NINTH_CLASS

The ninth winning class.

NONE

public static final LotteryWinCategory NONE

The none winning class.

SECOND_CLASS

public static final LotteryWinCategory SECOND_CLASS

The second winning class.

SEVENTH_CLASS

public static final LotteryWinCategory SEVENTH_CLASS

The seventh winning class.

SIXTH_CLASS

public static final LotteryWinCategory SIXTH_CLASS

The sixth winning class.

THIRD_CLASS

public static final LotteryWinCategory THIRD_CLASS

The third winning class.

Method Detail

values

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

Returns:

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

valueOf

public static LotteryWinCategory 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

getLotteryWinCategory

public static java.util.Optional<LotteryWinCategory> getLotteryWinCategory(java.util.Collection<java.lang.Integer> wonLotteryTicket,
                                                                           boolean withSuperNumber)

Gets an Optional with the LotteryWinCategory from the given Collection that contains the result of an intersection with the drawn lottery numbers.

Parameters:

wonLotteryTicket - the won lottery ticket

withSuperNumber - the with super number

Returns:

the lottery win category

getLotteryWinCategory

public static java.util.Optional<LotteryWinCategory> getLotteryWinCategory(java.util.Collection<java.lang.Integer> drawnLotteryNumbers,
                                                                           java.util.Collection<java.lang.Integer> playedLotteryTicket,
                                                                           boolean withSuperNumber)

Gets an Optional with the LotteryWinCategory that is an intersection of the given drawn lottery numbers and the given played lottery Ticket.

Parameters:

drawnLotteryNumbers - the drawn lottery numbers

playedLotteryTicket - the played lottery ticket

withSuperNumber - the with super number

Returns:

the lottery win category