Package io.github.mrtesz.teszcore.util

Class Chance

java.lang.Object

io.github.mrtesz.teszcore.util.Chance

public class Chance
extends Object

Util class for generating random values

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Chance.WeightedEntry<T>	A weighted entry holding a chance and a result value, used in roll(Collection).

Constructor Summary

Constructors

Constructor	Description
Chance()

Method Summary

Modifier and Type	Method	Description
static boolean	roll(double percent)	Rolls a `boolean` of a provided percentage
static boolean	roll(double percent, @NotNull Random random)	Rolls a `boolean` of a provided percentage with a specified random
static boolean	roll(int percent)	Rolls a percentage
static boolean	roll(int percent, @NotNull Random random)	Rolls a percentage with a specified random
static <T> T	roll(@NotNull Collection<? extends Chance.WeightedEntry<T>> entries)	Roll a value of a weighted entry collection
static <T> T	roll(@NotNull Collection<? extends Chance.WeightedEntry<T>> entries, @NotNull Random random)	Roll a value of a weighted entry collection with a specified random

Methods inherited from class java.lang.Object

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

Constructor Details

Chance

public Chance()

Method Details

roll

public static boolean roll(double percent)
                    throws IllegalNumberRangeException

Rolls a `boolean` of a provided percentage

Parameters:

percent - percent

Returns:

the rolled result

Throws:

IllegalNumberRangeException - if percent is not in the range 0.0-1.0

roll

public static boolean roll(double percent,
 @NotNull
 @NotNull Random random)
                    throws IllegalNumberRangeException,
NullPointerException

Rolls a `boolean` of a provided percentage with a specified random

Parameters:

percent - percent

random - random

Returns:

the rolled result

Throws:

IllegalNumberRangeException - if percent is not in the range 0.0-1.0

NullPointerException - if random is null

roll

public static boolean roll(int percent)
                    throws IllegalNumberRangeException

Rolls a percentage

Parameters:

percent - percent

Returns:

the rolled result

Throws:

IllegalArgumentException - if percent is not in the range 0-100

IllegalNumberRangeException

roll

public static boolean roll(int percent,
 @NotNull
 @NotNull Random random)
                    throws IllegalNumberRangeException,
NullPointerException

Rolls a percentage with a specified random

Parameters:

percent - percent

random - random

Returns:

the rolled result

Throws:

IllegalArgumentException - if percent is not in the range 0-100

NullPointerException - if random is null

IllegalNumberRangeException

roll

public static <T> T roll(@NotNull
 @NotNull Collection<? extends Chance.WeightedEntry<T>> entries)

Roll a value of a weighted entry collection

Parameters:

entries - entries

Returns:

rolled value

roll

public static <T> T roll(@NotNull
 @NotNull Collection<? extends Chance.WeightedEntry<T>> entries,
 @NotNull
 @NotNull Random random)

Roll a value of a weighted entry collection with a specified random

Parameters:

entries - entries

random - random

Returns:

rolled value