com.ninja_squad.dbsetup.generator.SequenceValueGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of DbSetup Show documentation

Helps you setup your database with test data

There is a newer version: 2.1.0

/*
 * The MIT License
 *
 * Copyright (c) 2013, Ninja Squad
 *
 * 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 com.ninja_squad.dbsetup.generator;

/**
 * A {@link ValueGenerator} which generates a sequence of long values. By default, the sequence starts at 1 and
 * increments by 1, but this can be customized. Instances of this class are created using
 * {@link ValueGenerators#sequence()}.
 * @author JB Nizet
 */
public final class SequenceValueGenerator implements ValueGenerator {

    private long next = 1L;
    private int increment = 1;

    SequenceValueGenerator() {
        this(1, 1);
    }

    private SequenceValueGenerator(long start, int increment) {
        this.next = start;
        this.increment = increment;
    }

    /**
     * Restarts the sequence at the given value
     * @param start the starting value of the created generator
     * @return this instance, for chaining
     */
    public SequenceValueGenerator startingAt(long start) {
        this.next = start;
        return this;
    }

    /**
     * Increments the value by the given increment.
     * @return this instance, for chaining
     */
    public SequenceValueGenerator incrementingBy(int increment) {
        this.increment = increment;
        return this;
    }

    @Override
    public Long nextValue() {
        long result = next;
        next += increment;
        return result;
    }

    @Override
    public String toString() {
        return "SequenceValueGenerator["
               + "next="
               + next
               + ", increment="
               + increment
               + "]";
    }
}