org.springframework.batch.core.converter

Interface JobParametersConverter

All Known Implementing Classes:

DefaultJobParametersConverter, JsrJobParametersConverter, ScheduledJobParametersFactory

public interface JobParametersConverter

A factory for JobParameters instances. A job can be executed with many possible runtime parameters, which identify the instance of the job. This converter allows job parameters to be converted to and from Properties.

Author:

Dave Syer, Mahmoud Ben Hassine

See Also:

JobParametersBuilder

Method Summary

Modifier and Type	Method and Description
JobParameters	getJobParameters(java.util.Properties properties) Get a new JobParameters instance.
java.util.Properties	getProperties(JobParameters params) The inverse operation: get a Properties instance.

Method Detail

getJobParameters

JobParameters getJobParameters(@Nullable
                               java.util.Properties properties)

Get a new JobParameters instance. If given null, or an empty properties, an empty JobParameters will be returned.

Parameters:

properties - the runtime parameters in the form of String literals.

Returns:

a JobParameters properties converted to the correct types.

getProperties

java.util.Properties getProperties(@Nullable
                                   JobParameters params)

The inverse operation: get a Properties instance. If given null or empty JobParameters, an empty Properties should be returned.

Parameters:

params - the JobParameters instance to be converted.

Returns:

a representation of the parameters as properties