001/*
002 * Copyright 2006-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.springframework.batch.core;
017
018import org.springframework.lang.Nullable;
019
020/**
021 * Interface for obtaining the next {@link JobParameters} in a sequence.
022 * 
023 * @author Dave Syer
024 * @author Lucas Ward
025 * @author Mahmoud Ben Hassine
026 * @since 2.0
027 */
028public interface JobParametersIncrementer {
029
030        /**
031         * Increment the provided parameters. If the input is empty, then this
032         * should return a bootstrap or initial value to be used on the first
033         * instance of a job.
034         * 
035         * @param parameters the last value used
036         * @return the next value to use (never {@code null})
037         */
038        JobParameters getNext(@Nullable JobParameters parameters);
039
040}