View Javadoc

1   /*
2    * Copyright 2006-2007 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.repeat.policy;
18  
19  import org.springframework.batch.repeat.CompletionPolicy;
20  import org.springframework.batch.repeat.RepeatStatus;
21  import org.springframework.batch.repeat.RepeatContext;
22  import org.springframework.batch.repeat.context.RepeatContextSupport;
23  
24  /**
25   * Very simple base class for {@link CompletionPolicy} implementations.
26   * 
27   * @author Dave Syer
28   * 
29   */
30  public class CompletionPolicySupport implements CompletionPolicy {
31  
32  	/**
33  	 * If exit status is not continuable return <code>true</code>, otherwise
34  	 * delegate to {@link #isComplete(RepeatContext)}.
35  	 * 
36  	 * @see org.springframework.batch.repeat.CompletionPolicy#isComplete(org.springframework.batch.repeat.RepeatContext,
37  	 * RepeatStatus)
38  	 */
39  	public boolean isComplete(RepeatContext context, RepeatStatus result) {
40  		if (result != null && !result.isContinuable()) {
41  			return true;
42  		}
43  		else {
44  			return isComplete(context);
45  		}
46  	}
47  
48  	/**
49  	 * Always true.
50  	 * 
51  	 * @see org.springframework.batch.repeat.CompletionPolicy#isComplete(org.springframework.batch.repeat.RepeatContext)
52  	 */
53  	public boolean isComplete(RepeatContext context) {
54  		return true;
55  	}
56  
57  	/**
58  	 * Build a new {@link RepeatContextSupport} and return it.
59  	 * 
60  	 * @see org.springframework.batch.repeat.CompletionPolicy#start(RepeatContext)
61  	 */
62  	public RepeatContext start(RepeatContext context) {
63  		return new RepeatContextSupport(context);
64  	}
65  
66  	/**
67  	 * Increment the context so the counter is up to date. Do nothing else.
68  	 * 
69  	 * @see org.springframework.batch.repeat.CompletionPolicy#update(org.springframework.batch.repeat.RepeatContext)
70  	 */
71  	public void update(RepeatContext context) {
72  		if (context instanceof RepeatContextSupport) {
73  			((RepeatContextSupport) context).increment();
74  		}
75  	}
76  
77  }