io.github.benas.randombeans.randomizers.collection.ListRandomizer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of random-beans Show documentation
Random Beans core implementation
There is a newer version: 3.9.0
/*
 * The MIT License
 *
 *   Copyright (c) 2016, Mahmoud Ben Hassine ([email protected])
 *
 *   Permission is hereby granted, free of charge, to any person obtaining a copy
 *   of this software and associated documentation files (the "Software"), to deal
 *   in the Software without restriction, including without limitation the rights
 *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *   copies of the Software, and to permit persons to whom the Software is
 *   furnished to do so, subject to the following conditions:
 *
 *   The above copyright notice and this permission notice shall be included in
 *   all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *   THE SOFTWARE.
 */

package io.github.benas.randombeans.randomizers.collection;

import io.github.benas.randombeans.api.Randomizer;

import java.util.ArrayList;
import java.util.List;

/**
 * A custom {@link Randomizer} that generates a list of random values using a delegate {@link Randomizer}.
 *
 * @param  the type of elements generated by this {@link Randomizer}
 * @author Eric Taix ([email protected])
 */
public class ListRandomizer extends CollectionRandomizer {

    /**
     * Create a new {@link ListRandomizer} that will generate a list with a random number of elements.
     * Each element is generated by the {@link Randomizer} parameter
     *
     * @param elementRandomizer the {@link Randomizer} to use to generate elements
     */
    public ListRandomizer(final Randomizer elementRandomizer) {
        super(elementRandomizer);
    }

    /**
     * Create a new {@link ListRandomizer} that will generate a list with a fixed number of elements.
     * Each element is generated by the {@link Randomizer} parameter
     *
     * @param elementRandomizer The {@link Randomizer} used to generate each element
     * @param nbElements        The number of elements to generate
     */
    public ListRandomizer(final Randomizer elementRandomizer, final int nbElements) {
        super(elementRandomizer, nbElements);
    }

    /**
     * Create a new {@link ListRandomizer}.
     *
     * @param elementRandomizer the {@link Randomizer} to use to generate elements
     * @return a new {@link ListRandomizer}.
     */
    public static  ListRandomizer aNewListRandomizer(final Randomizer elementRandomizer) {
        return new ListRandomizer<>(elementRandomizer);
    }

    /**
     * Create a new {@link ListRandomizer} that will generate a list with a fixed number of elements.
     * Each element is generated by the {@link Randomizer} parameter
     *
     * @param elementRandomizer The {@link Randomizer} used to generate each element
     * @param nbElements        The number of elements to generate
     */
    public static  ListRandomizer aNewListRandomizer(final Randomizer elementRandomizer, final int nbElements) {
        return new ListRandomizer<>(elementRandomizer, nbElements);
    }

    @Override
    public List getRandomValue() {
        List result = new ArrayList<>(nbElements);
        for (int i = 0; i < nbElements; i++) {
            result.add(getRandomElement());
        }
        return result;
    }

    @Override
    public String toString() {
        return "ListRandomizer [delegate=" + delegate + ", nbElements=" + nbElements + "]";
    }
}