com.github.writethemfirst.approvals.utils

Class FunctionUtils

java.lang.Object

com.github.writethemfirst.approvals.utils.FunctionUtils

public class FunctionUtils
extends java.lang.Object

# FunctionUtils

Set of static methods allowing to ease the manipulation of functions applications.

This particular class aims at allowing the application of functions on combinations of parameter values by looping over all values and producing the result. Since the result is to be used for Approval Testing, the applied functions will return String values.

Constructor Summary

Constructors

Constructor and Description
FunctionUtils()

Method Summary

Modifier and Type	Method and Description
static <IN1> java.lang.String	applyCombinations(java.lang.Iterable<IN1> args1, Function1<IN1,?> function) Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
static <IN1,IN2> java.lang.String	applyCombinations(java.lang.Iterable<IN1> args1, java.lang.Iterable<IN2> args2, Function2<IN1,IN2,?> function) Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
static <IN1,IN2,IN3> java.lang.String	applyCombinations(java.lang.Iterable<IN1> args1, java.lang.Iterable<IN2> args2, java.lang.Iterable<IN3> args3, Function3<IN1,IN2,IN3,?> function) Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
static <IN1,IN2,IN3,IN4> java.lang.String	applyCombinations(java.lang.Iterable<IN1> args1, java.lang.Iterable<IN2> args2, java.lang.Iterable<IN3> args3, java.lang.Iterable<IN4> args4, Function4<IN1,IN2,IN3,IN4,?> function) Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
static <IN1,IN2,IN3,IN4,IN5> java.lang.String	applyCombinations(java.lang.Iterable<IN1> args1, java.lang.Iterable<IN2> args2, java.lang.Iterable<IN3> args3, java.lang.Iterable<IN4> args4, java.lang.Iterable<IN5> args5, Function5<IN1,IN2,IN3,IN4,IN5,?> function) Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionUtils

public FunctionUtils()

Method Detail

applyCombinations

public static <IN1> java.lang.String applyCombinations(java.lang.Iterable<IN1> args1,
                                                       Function1<IN1,?> function)

Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.

The produced String will contain both the provided arguments and the computed value, and can later be used for writting the approvals files.

Parameters:

args1 - A collection of all the arguments 1 to apply the function to

function - The function to apply on the combinations of provided arguments

IN1 - Type of the argument 1

Returns:

A String containing all the combinations of provided arguments, and the result produced by the function application

applyCombinations

public static <IN1,IN2> java.lang.String applyCombinations(java.lang.Iterable<IN1> args1,
                                                           java.lang.Iterable<IN2> args2,
                                                           Function2<IN1,IN2,?> function)

Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.

The produced String will contain both the provided arguments and the computed value, and can later be used for writting the approvals files.

Parameters:

args1 - A collection of all the arguments 1 to apply the function to

args2 - A collection of all the arguments 2 to apply the function to

function - The function to apply on the combinations of provided arguments

IN1 - Type of the argument 1

IN2 - Type of the argument 2

Returns:

A String containing all the combinations of provided arguments, and the result produced by the function application

applyCombinations

public static <IN1,IN2,IN3> java.lang.String applyCombinations(java.lang.Iterable<IN1> args1,
                                                               java.lang.Iterable<IN2> args2,
                                                               java.lang.Iterable<IN3> args3,
                                                               Function3<IN1,IN2,IN3,?> function)

Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.

The produced String will contain both the provided arguments and the computed value, and can later be used for writting the approvals files.

Parameters:

args1 - A collection of all the arguments 1 to apply the function to

args2 - A collection of all the arguments 2 to apply the function to

args3 - A collection of all the arguments 3 to apply the function to

function - The function to apply on the combinations of provided arguments

IN1 - Type of the argument 1

IN2 - Type of the argument 2

IN3 - Type of the argument 3

Returns:

A String containing all the combinations of provided arguments, and the result produced by the function application

applyCombinations

public static <IN1,IN2,IN3,IN4> java.lang.String applyCombinations(java.lang.Iterable<IN1> args1,
                                                                   java.lang.Iterable<IN2> args2,
                                                                   java.lang.Iterable<IN3> args3,
                                                                   java.lang.Iterable<IN4> args4,
                                                                   Function4<IN1,IN2,IN3,IN4,?> function)

Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.

The produced String will contain both the provided arguments and the computed value, and can later be used for writting the approvals files.

Parameters:

args1 - A collection of all the arguments 1 to apply the function to

args2 - A collection of all the arguments 2 to apply the function to

args3 - A collection of all the arguments 3 to apply the function to

args4 - A collection of all the arguments 4 to apply the function to

function - The function to apply on the combinations of provided arguments

IN1 - Type of the argument 1

IN2 - Type of the argument 2

IN3 - Type of the argument 3

IN4 - Type of the argument 4

Returns:

A String containing all the combinations of provided arguments, and the result produced by the function application

applyCombinations

public static <IN1,IN2,IN3,IN4,IN5> java.lang.String applyCombinations(java.lang.Iterable<IN1> args1,
                                                                       java.lang.Iterable<IN2> args2,
                                                                       java.lang.Iterable<IN3> args3,
                                                                       java.lang.Iterable<IN4> args4,
                                                                       java.lang.Iterable<IN5> args5,
                                                                       Function5<IN1,IN2,IN3,IN4,IN5,?> function)

Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.

The produced String will contain both the provided arguments and the computed value, and can later be used for writting the approvals files.

Parameters:

args1 - A collection of all the arguments 1 to apply the function to

args2 - A collection of all the arguments 2 to apply the function to

args3 - A collection of all the arguments 3 to apply the function to

args4 - A collection of all the arguments 4 to apply the function to

args5 - A collection of all the arguments 5 to apply the function to

function - The function to apply on the combinations of provided arguments

IN1 - Type of the argument 1

IN2 - Type of the argument 2

IN3 - Type of the argument 3

IN4 - Type of the argument 4

IN5 - Type of the argument 5

Returns:

A String containing all the combinations of provided arguments, and the result produced by the function application