View Javadoc
1   /*
2    * Copyright 2006-2010 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.batch.integration.chunk;
18  
19  import java.util.Collection;
20  
21  import org.springframework.batch.core.StepContribution;
22  import org.springframework.batch.core.StepExecution;
23  
24  /**
25   * A source of {@link StepContribution} instances that can be aggregated and used to update an ongoing
26   * {@link StepExecution}.
27   * 
28   * @author Dave Syer
29   * 
30   */
31  public interface StepContributionSource {
32  
33  	/**
34  	 * Get the currently available contributions and drain the source. The next call would return an empty collection,
35  	 * unless new contributions have arrived.
36  	 * 
37  	 * @return a collection of {@link StepContribution} instances
38  	 */
39  	Collection<StepContribution> getStepContributions();
40  
41  }