001/*
002 * Copyright 2006-2010 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 */
016
017package org.springframework.batch.integration.chunk;
018
019import java.util.Collection;
020
021import org.springframework.batch.core.StepContribution;
022import org.springframework.batch.core.StepExecution;
023
024/**
025 * A source of {@link StepContribution} instances that can be aggregated and used to update an ongoing
026 * {@link StepExecution}.
027 * 
028 * @author Dave Syer
029 * 
030 */
031public interface StepContributionSource {
032
033        /**
034         * Get the currently available contributions and drain the source. The next call would return an empty collection,
035         * unless new contributions have arrived.
036         * 
037         * @return a collection of {@link StepContribution} instances
038         */
039        Collection<StepContribution> getStepContributions();
040
041}