tech.sirwellington.alchemy.generator.AlchemyGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemy-generator Show documentation

Part of the Alchemy collection. More Data means better tests. Alchemy Generator makes it easier to test your code by providing generators for common Objects and Data.

There is a newer version: 2.5.0

Show newest version

/*
 * Copyright 2015 SirWellington Tech.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package tech.sirwellington.alchemy.generator;

import java.util.function.Supplier;
import tech.sirwellington.alchemy.annotations.arguments.NonNull;
import tech.sirwellington.alchemy.annotations.designs.patterns.StrategyPattern;
import static tech.sirwellington.alchemy.annotations.designs.patterns.StrategyPattern.Role.INTERFACE;
import static tech.sirwellington.alchemy.generator.Checks.checkNotNull;

/**
 * An {@link AlchemyGenerator} generates Data or Objects, commonly used in testing scenarios.
 * 

 * Common generators exist for:
 *  * + Integers
 * + Longs
 * + Doubles
 * + Booleans
 * + Binary
 * + Strings
 *      + Alphabetics
 *      + Hexadecimal
 *      + UUIDs
 * + Enum Values
 * + Lists of the above
 * + Maps of the above
 * 
 *
 * Examples:
 *
 *  * Get a positive integer:
 *
 * {@code
 *  int positive = one(positiveIntegers());
 * }
 * 
 *
 * @author SirWellington
 *
 * @param  The type of the Object to generate.
 */
@FunctionalInterface
@StrategyPattern(role = INTERFACE)
public interface AlchemyGenerator extends Supplier
{

    /**
     * Generate a non-null value of type {@code T}.
     *
     * @return
     */
    @Override
    @NonNull
    T get();

    /**
     * Calls the generator once to get the ones of its values.
     *
     * @param 
     * @param generator
     *
     * @return Only one value from the generator.
     */
    public static  T one(@NonNull AlchemyGenerator generator)
    {
        checkNotNull(generator);
        return generator.get();
    }
}