Package org.springframework.batch.core.converter

Class DefaultJobParametersConverter

java.lang.Object

org.springframework.batch.core.converter.DefaultJobParametersConverter

All Implemented Interfaces:

JobParametersConverter

Direct Known Subclasses:

JsonJobParametersConverter

public class DefaultJobParametersConverter
extends Object
implements JobParametersConverter

Converter for JobParameters instances that uses a simple naming convention for converting job parameters. The expected notation is the following:

key=value,type,identifying

where:

• value: string literal representing the value
• type (optional): fully qualified name of the type of the value. Defaults to String.
• identifying (optional): boolean to flag the job parameter as identifying or not. Defaults to true

For example, schedule.date=2022-12-12,java.time.LocalDate will be converted to an identifying job parameter of type LocalDate with value "2022-12-12".

The literal values are converted to the target type by using the default Spring conversion service, augmented if necessary by any custom converters. The conversion service should be configured with a converter to and from string literals to job parameter types.

By default, the Spring conversion service is augmented to support the conversion of the following types:

• Date: in the DateTimeFormatter.ISO_INSTANT format
• LocalDate: in the DateTimeFormatter.ISO_LOCAL_DATE format
• LocalTime: in the DateTimeFormatter.ISO_LOCAL_TIME format
• LocalDateTime: in the DateTimeFormatter.ISO_LOCAL_DATE_TIME format

Author:

Dave Syer, Michael Minella, Mahmoud Ben Hassine

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.core.convert.support.ConfigurableConversionService	conversionService

Constructor Summary

Constructors

Constructor	Description
DefaultJobParametersConverter()

Method Summary

Modifier and Type	Method	Description
protected JobParameter<?>	decode(String encodedJobParameter)	Decode a job parameter from a string.
protected String	encode(JobParameter<?> jobParameter)	Encode a job parameter to a string.
JobParameters	getJobParameters(Properties properties)	Get a new JobParameters instance.
Properties	getProperties(JobParameters jobParameters)	The inverse operation: get a Properties instance.
void	setConversionService(org.springframework.core.convert.support.ConfigurableConversionService conversionService)	Set the conversion service to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

conversionService

protected org.springframework.core.convert.support.ConfigurableConversionService conversionService

Constructor Details

DefaultJobParametersConverter

public DefaultJobParametersConverter()

Method Details

getJobParameters

public JobParameters getJobParameters(@Nullable
 Properties properties)

Description copied from interface: JobParametersConverter

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

Specified by:

getJobParameters in interface JobParametersConverter

Parameters:

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

Returns:

a JobParameters object converted to the correct types.

See Also:

• JobParametersConverter.getJobParameters(java.util.Properties)

getProperties

public Properties getProperties(@Nullable
 JobParameters jobParameters)

Description copied from interface: JobParametersConverter

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

Specified by:

getProperties in interface JobParametersConverter

Parameters:

jobParameters - The JobParameters instance to be converted.

Returns:

a representation of the parameters as properties.

See Also:

• JobParametersConverter.getProperties(org.springframework.batch.core.JobParameters)

setConversionService

public void setConversionService(@NonNull
 org.springframework.core.convert.support.ConfigurableConversionService conversionService)

Set the conversion service to use.

Parameters:

conversionService - the conversion service to use. Must not be null.

Since:

5.0

encode

protected String encode(JobParameter<?> jobParameter)

Encode a job parameter to a string.

Parameters:

jobParameter - the parameter to encode

Returns:

the encoded job parameter

decode

protected JobParameter<?> decode(String encodedJobParameter)

Decode a job parameter from a string.

Parameters:

encodedJobParameter - the encoded job parameter

Returns:

the decoded job parameter