dev.codesoapbox.dummy4j

Class ConvenienceMethods

java.lang.Object

dev.codesoapbox.dummy4j.ConvenienceMethods

public class ConvenienceMethods
extends Object

Since:

0.5.0

Constructor Summary

Constructors

Constructor and Description
ConvenienceMethods(RandomService random)

Method Summary

Modifier and Type	Method and Description
boolean	chance(int howMany, int in) Has a howMany in in chance to return true.
<T> T	chance(int howMany, int in, Supplier<T> supplier) Has a howMany in in chance to supply a value.
<T> List<T>	listOf(int count, Supplier<T> supplier) Provides a list of objects supplied by a method
<T extends Enum<?>> T	nextEnum(Class<T> clazz) Returns a random enum value
<T> T	of(List<T> list) Returns a random element from a list
<T> T	of(Set<T> set) Returns a random element from a set
<T> T	of(Supplier<T>... suppliers) Returns a value from a random supplier.
<T> T	of(T... array) Returns a random element from an array
<T> Set<T>	setOf(int count, Supplier<T> supplier) Provides a set of objects supplied by a method

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvenienceMethods

public ConvenienceMethods(RandomService random)

Method Detail

listOf

public <T> List<T> listOf(int count,
                          Supplier<T> supplier)

Provides a list of objects supplied by a method

Type Parameters:

T - the type of objects to generate

Parameters:

count - the number of objects to generate

supplier - the method to generate an object

Returns:

a list of objects

setOf

public <T> Set<T> setOf(int count,
                        Supplier<T> supplier)

Provides a set of objects supplied by a method

Type Parameters:

T - the type of objects to generate

Parameters:

count - the number of objects to generate

supplier - the method to generate an object

Returns:

a list of objects

of

@SafeVarargs
public final <T> T of(T... array)

Returns a random element from an array

Type Parameters:

T - the type of object to return

Parameters:

array - the array to pick from

Returns:

a random element from the array or NULL if the array is empty

of

public <T> T of(List<T> list)

Returns a random element from a list

Type Parameters:

T - the type of object to return

Parameters:

list - the list to pick from

Returns:

a random element from the list or NULL if the list is NULL or empty

of

public <T> T of(Set<T> set)

Returns a random element from a set

Type Parameters:

T - the type of object to return

Parameters:

set - the list to pick from

Returns:

a random element from the set or NULL if the set is NULL or empty

of

@SafeVarargs
public final <T> T of(Supplier<T>... suppliers)

Returns a value from a random supplier.

Type Parameters:

T - the type of value to return

Parameters:

suppliers - value suppliers to pick from

Returns:

a value from a random supplier or NULL if an empty array or NULL was given as an argument

chance

public <T> T chance(int howMany,
                    int in,
                    Supplier<T> supplier)

Has a howMany in in chance to supply a value. Otherwise, returns null.

E.g. chance(1, 2, () -> "hello") has a 1-in-2 chance to supply "hello", that is it will be supplied 50% of the time when the method is invoked.

Returns:

supplied T or null

Since:

0.5.0

chance

public boolean chance(int howMany,
                      int in)

Has a howMany in in chance to return true. Otherwise, returns false.

E.g. chance(1, 2) has a 1-in-2 chance to return true, that is it will return true 50% of the time when the method is invoked.

Returns:

boolean

Since:

0.5.0

nextEnum

public <T extends Enum<?>> T nextEnum(Class<T> clazz)

Returns a random enum value