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.core.converter;
18  
19  import java.util.Properties;
20  
21  import org.springframework.batch.core.JobParameters;
22  import org.springframework.batch.core.JobParametersBuilder;
23  
24  /**
25   * A factory for {@link JobParameters} instances. A job can be executed with
26   * many possible runtime parameters, which identify the instance of the job.
27   * This converter allows job parameters to be converted to and from Properties.
28   * 
29   * @author Dave Syer
30   * 
31   * @see JobParametersBuilder
32   * 
33   */
34  public interface JobParametersConverter {
35  
36  	/**
37  	 * Get a new {@link JobParameters} instance. If given null, or an empty
38  	 * properties, an empty JobParameters will be returned.
39  	 * 
40  	 * @param properties the runtime parameters in the form of String literals.
41  	 * @return a {@link JobParameters} properties converted to the correct
42  	 * types.
43  	 */
44  	public JobParameters getJobParameters(Properties properties);
45  
46  	/**
47  	 * The inverse operation: get a {@link Properties} instance. If given null
48  	 * or empty JobParameters, an empty Properties should be returned.
49  	 * 
50  	 * @param params
51  	 * @return a representation of the parameters as properties
52  	 */
53  	public Properties getProperties(JobParameters params);
54  }