com.redfin.fuzzy

Interface Case<T>

Type Parameters:

T - the type of values created by this case.

All Known Implementing Classes:

CollectionCase, CollectionCase.ListCase, CollectionCase.SetCase, DoubleNumericCase, EnumCase, ExcludingCase, FloatNumericCase, LiteralCase, NullableCase, NumericCase, StringCase, UnionCase

public interface Case<T>

Cases are the principal building block of the fuzzy engine. They describe tests by producing instances of specific values according to a set of subcases (also known as equivalency classes).

For example, the StringCase describes all of the different types of string that an application should be able to handle. It provides several subcases, including the empty string, strings with non-ASCII characters, and strings that contain characters with special meanings in various languages.

When a test consumes a particular case, it is making a broad statement that the code under test should be able to handle the values of each of the equivalency classes defined by that case.

Note to implementors: consider overriding the default implementations for the methods listed below. See comments on those methods for explanations.

• excluding(Iterable)

See Also:

Cases, Literal, Subcases

Method Summary

Modifier and Type	Method and Description
default Case<T>	excluding(Iterable<T> values)
default Case<T>	excluding(T... values)
default Case<T>	excluding(T value) Constrains the
default Set<T>	generateAllOnce() Requests each of this case's subcases to generate and return a value.
default Set<T>	generateAllOnce(Random random) Requests each of this case's subcases to generate and return a value.
default T	generateAnyOnce() Arbitrarily selects and returns the value of one of this case's subcases.
default T	generateAnyOnce(Random random) Arbitrarily selects and returns the value of one of this case's subcases.
Set<Subcase<T>>	getSubcases() Returns the specific set of subcases that describe all equivalency classes for this case.
default Case<T>	or(Case<T> other) Returns a new case that combines the subcases of this case and the provided other case.
default Case<T>	orNull() Returns a new case that combines the subcases of this case and a subcase specifically generating the value null.

Method Detail

getSubcases

Set<Subcase<T>> getSubcases()

Returns the specific set of subcases that describe all equivalency classes for this case.

Cases are expected to return at least one subcase. When the fuzzy engine is determining how many test cases to execute, it does so in terms of subcases, not cases. Thus, when using the pairwise permutation algorithm, the fuzzy library works to ensure that each possible combination of two subcases are executed.

Note to implementors: cases should generally not include null values as possible outputs. Instead, consumers are expected to use the orNull() method (or, equivalently, Any.nullableOf(com.redfin.fuzzy.Case<T>)) to declare that their cases should also generate null values.

or

default Case<T> or(Case<T> other)

Returns a new case that combines the subcases of this case and the provided other case. This method can be used to combine different cases for a value into a single generator.

orNull

default Case<T> orNull()

Returns a new case that combines the subcases of this case and a subcase specifically generating the value null.

excluding

default Case<T> excluding(T value)

Constrains the

excluding

default Case<T> excluding(T... values)

excluding

default Case<T> excluding(Iterable<T> values)

generateAnyOnce

default T generateAnyOnce()

Arbitrarily selects and returns the value of one of this case's subcases.

generateAnyOnce

default T generateAnyOnce(Random random)

Arbitrarily selects and returns the value of one of this case's subcases.

Parameters:

random - the random number generator that will be used to create the returned value.

generateAllOnce

default Set<T> generateAllOnce()

Requests each of this case's subcases to generate and return a value.

generateAllOnce

default Set<T> generateAllOnce(Random random)

Requests each of this case's subcases to generate and return a value.

Parameters:

random - the random number generator that will be used to create the returned values.