org.springframework.xd.dirt.plugins.job

Class JobParametersBean

java.lang.Object

org.springframework.xd.dirt.plugins.job.JobParametersBean

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class JobParametersBean
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean

Prepares the JobParameters for the Spring Bach Jobs. As input you pass in a JSON-based Map representation of the parameters. Will use the DefaultJobParametersConverter class underneath, allowing you to provide type information.

Since:

1.0

Author:

Gunnar Hillert

Constructor Summary

Constructors

Constructor and Description
JobParametersBean(java.lang.String jobParametersAsJsonMap) Initializes the JobParametersBean.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
org.springframework.batch.core.JobParameters	getJobParameters() Please ensure that afterPropertiesSet() is called before obtaining the JobParameters.
void	setDateFormat(java.text.DateFormat dateFormat) Will set the DateFormat on the underlying DefaultJobParametersConverter.
void	setDateFormatAsString(java.lang.String dateFormat)
void	setMakeParametersUnique(boolean makeParametersUnique) If not set, this property defaults to true.
void	setNumberFormat(java.text.NumberFormat numberFormat) Setter for the NumberFormat which is set on the underlying DefaultJobParametersConverter.
void	setNumberFormatAsString(java.lang.String numberFormat)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobParametersBean

public JobParametersBean(java.lang.String jobParametersAsJsonMap)

Initializes the JobParametersBean.

Parameters:

jobParametersAsJsonMap - Can be null or empty. In that case the resulting JobParameters will be empty.

Method Detail

setDateFormat

public void setDateFormat(java.text.DateFormat dateFormat)

Will set the DateFormat on the underlying DefaultJobParametersConverter. If not set explicitly the DateFormat will default to "yyyy/MM/dd".

Parameters:

dateFormat - Must not be null

setDateFormatAsString

public void setDateFormatAsString(java.lang.String dateFormat)

setNumberFormat

public void setNumberFormat(java.text.NumberFormat numberFormat)

Setter for the NumberFormat which is set on the underlying DefaultJobParametersConverter. If not set explicitly, defaults to NumberFormat.getInstance(Locale.US);

Parameters:

numberFormat - Must not be null.

setNumberFormatAsString

public void setNumberFormatAsString(java.lang.String numberFormat)

setMakeParametersUnique

public void setMakeParametersUnique(boolean makeParametersUnique)

If not set, this property defaults to true.

Parameters:

makeParametersUnique -

getJobParameters

public org.springframework.batch.core.JobParameters getJobParameters()

Please ensure that afterPropertiesSet() is called before obtaining the JobParameters.

Returns:

The parsed Job Parameters.

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception