com.insightfullogic.lambdabehave.generators.SourceGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lambda-behave Show documentation

A modern testing and behavioural specification framework for Java 8

There is a newer version: 0.4

package com.insightfullogic.lambdabehave.generators;

import com.insightfullogic.lambdabehave.impl.generators.RandomNumberGenerator;
import com.insightfullogic.lambdabehave.impl.generators.ValueSourceGenerator;

/**
 * A source of information which generators use. Generators should
 * deterministically generate test cases based upon the source
 * generator.
 *
 * @see com.insightfullogic.lambdabehave.generators.Generator
 */
public interface SourceGenerator {

    /**
     * creates a source generator that returns random numbers.
     *
     * @return the source generator
     */
    public static SourceGenerator randomNumbers() {
        return new RandomNumberGenerator();
    }

    /**
     * creates a source generator that returns random numbers.
     *
     * @param seed the seed for the random number generator
     * @return the source generator
     */
    public static SourceGenerator randomNumbers(final long seed) {
        return new RandomNumberGenerator(seed);
    }

    /**
     * Generates a source from a sequence of values
     *
     * @param values the values to use
     * @return the source generator
     */
    public static SourceGenerator values(final int ... values) {
        return new ValueSourceGenerator(values);
    }

    /**
     * Generate an int which is <= maxValue.
     *
     * @param maxValue the maximum value of the int
     * @return the generated int
     */
    int generateInt(int maxValue);

    /**
     * Gets the seed state required to generate the sequence of numbers.
     *
     * @return the seed required to generate the sequence of numbers
     */
    long getSeed();

    /**
     * Generate a boolean value, based upon the current source
     * of information.
     *
     * @return either true or false
     */
    default boolean generateBoolean() {
        return generateInt(2) == 0;
    }

}