org.instancio.GivenOriginDestinationAction Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022-2024 the original author or authors.
 *
 * 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
 *
 *      https://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 org.instancio;

import org.instancio.documentation.ExperimentalApi;
import org.instancio.generator.Generator;
import org.instancio.generator.GeneratorSpec;
import org.instancio.generators.Generators;

import java.util.function.Supplier;

/**
 * Defines optional methods that can be chained to
 * {@link Assign#given(TargetSelector)} builder expression.
 *
 * @since 3.0.0
 */
@ExperimentalApi
public interface GivenOriginDestinationAction extends GivenOriginDestination, Assignment {

    /**
     * Generates values using built-in generators provided by the {@code gen}
     * parameter, of type {@link Generators}.
     *
     * @param gen provider of customisable built-in generators (also known as specs)
     * @param  the type of object to generate
     * @return a complete assignment
     * @since 3.0.0
     */
     Assignment elseGenerate(GeneratorSpecProvider gen);

    /**
     * Generates values using arbitrary generator specs.
     *
     * @param spec generator spec for generating values
     * @param   the type of object to generate
     * @return a complete assignment
     * @since 3.0.0
     */
     Assignment elseGenerate(GeneratorSpec spec);

    /**
     * Sets a value to matching selector targets.
     *
     * @param value value to set
     * @param    the type of object to generate
     * @return a complete assignment
     * @since 3.0.0
     */
     Assignment elseSet(T value);

    /**
     * Supplies an object using a {@link Generator} to matching selector targets.
     *
     * @param generator for generating values
     * @param        the type of object to generate
     * @return a complete assignment
     * @since 3.0.0
     */
     Assignment elseSupply(Generator generator);

    /**
     * Supplies an object using a {@link Supplier}.
     *
     * @param supplier for supplying values
     * @param       the type of object to generate
     * @return a complete assignment
     * @since 3.0.0
     */
     Assignment elseSupply(Supplier supplier);
}