io.github.benas.randombeans.randomizers.range.LongRangeRandomizer 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.range;

/**
 * Generate a random {@link Long} in the given range.
 *
 * @author Rémi Alvergnat ([email protected])
 */
public class LongRangeRandomizer extends AbstractRangeRandomizer {

    /**
     * Create a new {@link LongRangeRandomizer}.
     *
     * @param min min value
     * @param max max value
     */
    public LongRangeRandomizer(final Long min, final Long max) {
        super(min, max);
    }

    /**
     * Create a new {@link LongRangeRandomizer}.
     *
     * @param min  min value
     * @param max  max value
     * @param seed initial seed
     */
    public LongRangeRandomizer(final Long min, final Long max, final long seed) {
        super(min, max, seed);
    }

    /**
     * Create a new {@link LongRangeRandomizer}.
     *
     * @param min min value
     * @param max max value
     * @return a new {@link LongRangeRandomizer}.
     */
    public static LongRangeRandomizer aNewLongRangeRandomizer(final Long min, final Long max) {
        return new LongRangeRandomizer(min, max);
    }

    /**
     * Create a new {@link LongRangeRandomizer}.
     *
     * @param min  min value
     * @param max  max value
     * @param seed initial seed
     * @return a new {@link LongRangeRandomizer}.
     */
    public static LongRangeRandomizer aNewLongRangeRandomizer(final Long min, final Long max, final long seed) {
        return new LongRangeRandomizer(min, max, seed);
    }

    @Override
    protected void checkValues() {
        if (min > max) {
            throw new IllegalArgumentException("max must be greater than min");
        }
    }

    @Override
    public Long getRandomValue() {
        return nextLong(min, max);
    }

    @Override
    protected Long getDefaultMaxValue() {
        return Long.MAX_VALUE;
    }

    @Override
    protected Long getDefaultMinValue() {
        return Long.MIN_VALUE;
    }
}