org.jeasy.random.randomizers.misc

Class EnumRandomizer<E extends java.lang.Enum<E>>

java.lang.Object

org.jeasy.random.randomizers.AbstractRandomizer<E>

org.jeasy.random.randomizers.misc.EnumRandomizer<E>

Type Parameters:

E - the type of elements in the enumeration

All Implemented Interfaces:

Randomizer<E>

public class EnumRandomizer<E extends java.lang.Enum<E>>
extends AbstractRandomizer<E>

A Randomizer that generates a random value from a given Enum.

Author:

Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Field Summary

Fields inherited from class org.jeasy.random.randomizers.AbstractRandomizer

random

Constructor Summary

Constructors

Constructor and Description
EnumRandomizer(java.lang.Class<E> enumeration) Create a new EnumRandomizer.
EnumRandomizer(java.lang.Class<E> enumeration, E... excludedValues) Create a new EnumRandomizer.
EnumRandomizer(java.lang.Class<E> enumeration, long seed) Create a new EnumRandomizer.

Method Summary

Modifier and Type	Method and Description
static <E extends java.lang.Enum<E>> EnumRandomizer<E>	aNewEnumRandomizer(java.lang.Class<E> enumeration) Create a new EnumRandomizer.
static <E extends java.lang.Enum<E>> EnumRandomizer<E>	aNewEnumRandomizer(java.lang.Class<E> enumeration, E... excludedValues) Create a new EnumRandomizer.
static <E extends java.lang.Enum<E>> EnumRandomizer<E>	aNewEnumRandomizer(java.lang.Class<E> enumeration, long seed) Create a new EnumRandomizer.
E	getRandomValue() Get a random value within an enumeration or an enumeration subset (when values are excluded)

Methods inherited from class org.jeasy.random.randomizers.AbstractRandomizer

getPredefinedValuesOf, nextDouble, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumRandomizer

public EnumRandomizer(java.lang.Class<E> enumeration)

Create a new EnumRandomizer.

Parameters:

enumeration - the enumeration from which this randomizer will generate random values

EnumRandomizer

public EnumRandomizer(java.lang.Class<E> enumeration,
                      long seed)

Create a new EnumRandomizer.

Parameters:

enumeration - the enumeration from which this randomizer will generate random values

seed - the initial seed

EnumRandomizer

public EnumRandomizer(java.lang.Class<E> enumeration,
                      E... excludedValues)
               throws java.lang.IllegalArgumentException

Create a new EnumRandomizer.

Parameters:

enumeration - the enumeration from which this randomizer will generate random values

excludedValues - the values to exclude from random picking

Throws:

java.lang.IllegalArgumentException - when excludedValues contains all enumeration values, ie all elements from the enumeration are excluded

Method Detail

aNewEnumRandomizer

public static <E extends java.lang.Enum<E>> EnumRandomizer<E> aNewEnumRandomizer(java.lang.Class<E> enumeration)

Create a new EnumRandomizer.

Type Parameters:

E - the type of elements in the enumeration

Parameters:

enumeration - the enumeration from which this randomizer will generate random values

Returns:

a new EnumRandomizer.

aNewEnumRandomizer

public static <E extends java.lang.Enum<E>> EnumRandomizer<E> aNewEnumRandomizer(java.lang.Class<E> enumeration,
                                                                                 long seed)

Create a new EnumRandomizer.

Type Parameters:

E - the type of elements in the enumeration

Parameters:

enumeration - the enumeration from which this randomizer will generate random values

seed - the initial seed

Returns:

a new EnumRandomizer.

aNewEnumRandomizer

public static <E extends java.lang.Enum<E>> EnumRandomizer<E> aNewEnumRandomizer(java.lang.Class<E> enumeration,
                                                                                 E... excludedValues)

Create a new EnumRandomizer.

Type Parameters:

E - the type of elements in the enumeration

Parameters:

enumeration - the enumeration from which this randomizer will generate random values

excludedValues - the values to exclude from the subset in which the random value will be picked

Returns:

a new EnumRandomizer.

getRandomValue

public E getRandomValue()

Get a random value within an enumeration or an enumeration subset (when values are excluded)

Returns:

a random value within the enumeration