com.redfin.fuzzy

Enum CaseCompositionMode

java.lang.Object

java.lang.Enum<CaseCompositionMode>

com.redfin.fuzzy.CaseCompositionMode

All Implemented Interfaces:

Serializable, Comparable<CaseCompositionMode>

public enum CaseCompositionMode
extends Enum<CaseCompositionMode>

Describes the different algorithms the fuzzy library can use to permute subcases when running tests or using one of the case composition functions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EACH_SUBCASE_AT_LEAST_ONCE The composition will generate enough subcases so that each base case's suppliers are covered at least once, or the a number equivalent to the maximum number of suppliers of any base case.
PAIRWISE_PERMUTATIONS_OF_SUBCASES The composition will generate enough subcases so that each possible pairing of any two base cases will be included at least once.

Method Summary

Modifier and Type	Method and Description
static CaseCompositionMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CaseCompositionMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EACH_SUBCASE_AT_LEAST_ONCE

public static final CaseCompositionMode EACH_SUBCASE_AT_LEAST_ONCE

The composition will generate enough subcases so that each base case's suppliers are covered at least once, or the a number equivalent to the maximum number of suppliers of any base case. Use this mode when you are concerned about the number of combined cases growing too large.

For example, suppose you are writing a composition of the following three base cases:

• case a, with subcases 1 and 2;
• case b, with subcases 'X', 'Y', and 'Z'; and
• case c, with a single subcase true.

When these cases are composed with EACH_SUBCASE_AT_LEAST_ONCE, the final set of combined cases might be the following:

Output for the cases in this example

	case a	case b	case c
1	1	'X'	true
2	2	'Y'	true
3	1	'Z'	true

Note that the total number of composed subcases is 3, because case b had the most subcases (again, 3). The subcases for a and c repeated as necessary so that each composed subcase had a valid value for all three.

Note also that the way in which subcases are reused is not guaranteed by this algorithm and may change between tests.

PAIRWISE_PERMUTATIONS_OF_SUBCASES

public static final CaseCompositionMode PAIRWISE_PERMUTATIONS_OF_SUBCASES

The composition will generate enough subcases so that each possible pairing of any two base cases will be included at least once. Use this mode when you want to provide broader test coverage at the expense of a larger number of permutations.

This mode uses the pairwise algorithm defined by the Pairwise class; refer to it for more details. As an example, consider the following three base cases:

• case a, with subcases 1 and 2;
• case b, with subcases 'X', 'Y', and 'Z'; and
• case c, with a single subcase true.

Given this input, the pairwise algorithm might generate the following composed subcases:

Output for the cases in this example

	case a	case b	case c
1	1	'X'	true
2	1	'Y'	true
3	1	'Z'	true
4	2	'X'	true
5	2	'Y'	true
6	2	'Z'	true

Note that each possible pair between (a, b), (a, c), and (b, c) are covered at least once. The number of subcases necessary roughly depends on the number of subcases between the two largest base cases (in this example, case a had two possible subcases, and case b had three, for a total of 2 * 3 = 6 cases).

Note also that the specific distribution of subcases is not guaranteed by this algorithm and may change between tests.

Method Detail

values

public static CaseCompositionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CaseCompositionMode c : CaseCompositionMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CaseCompositionMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null