Package org.stubit.random

Class RandomChoice.Builder<T>

java.lang.Object

org.stubit.random.RandomChoice.Builder<T>

Enclosing class:

RandomChoice

public static class RandomChoice.Builder<T>
extends Object

Randomly selects an element from a collection of choices.

Method Summary

Modifier and Type	Method	Description
RandomChoice.Builder<T>	and(Collection<T> additionalChoices)	Add the provided additional choices to the selection
final RandomChoice.Builder<T>	and(T... additionalChoices)	Add the provided additional choices to the selection
T	build()	Returns a randomly selected element from the choices.
RandomChoice.Builder<T>	butNot(Collection<T> excluded)	Excludes the provided choices from the selection
final RandomChoice.Builder<T>	butNot(T... excluded)	Excludes the provided choices from the selection

Methods inherited from class java.lang.Object

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

Method Details

and

public RandomChoice.Builder<T> and(Collection<T> additionalChoices)

Add the provided additional choices to the selection

Parameters:

additionalChoices - the additional choices

and

@SafeVarargs
public final RandomChoice.Builder<T> and(T... additionalChoices)

Add the provided additional choices to the selection

Parameters:

additionalChoices - the additional choices

butNot

public RandomChoice.Builder<T> butNot(Collection<T> excluded)

Excludes the provided choices from the selection

Parameters:

excluded - the excluded choices

Returns:

this

Throws:

IllegalArgumentException - if no choices remain

butNot

@SafeVarargs
public final RandomChoice.Builder<T> butNot(T... excluded)

Excludes the provided choices from the selection

Parameters:

excluded - the excluded choices

Returns:

this

Throws:

IllegalArgumentException - if no choices remain

build

public T build()

Returns a randomly selected element from the choices.

Returns:

a randomly selected element form the choices