org.springframework.batch.core.step.job.JobParametersExtractor Maven / Gradle / Ivy

/*
 * Copyright 2006-2010 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.springframework.batch.core.step.job;

import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.StepExecution;

/**
 * Strategy interface for translating a {@link StepExecution} into
 * {@link JobParameters}.
 * 
 * @author Dave Syer
 * 
 */
public interface JobParametersExtractor {

	/**
	 * Extract job parameters from the step execution, for example from the
	 * execution context or other properties.
	 *
	 * @param job a {@link Job}
	 * @param stepExecution a {@link StepExecution}
	 *
	 * @return some {@link JobParameters}
	 */
	JobParameters getJobParameters(Job job, StepExecution stepExecution);

}