Helper class for creating JobParameters. Useful because all JobParameter objects are immutable, and must be instantiated separately to ensure typesafety. Once created, it can be used in the same was a StringBuilder (except, order is irrelevant), by adding various parameter types and creating a valid JobParameters once finished. Using the identifying flag indicates if the parameter will be used in the identification of a JobInstance. That flag defaults to true. More...
Public Member Functions | |
| JobParametersBuilder () | |
| Default constructor. Initializes the builder with empty parameters. More... | |
| JobParametersBuilder (JobParameters jobParameters) | |
| Copy constructor. Initializes the builder with the supplied parameters. THIS SHOULD PRESERVE PRIOR EXISTING ORDER. More... | |
| JobParametersBuilder (NameValueCollection properties) | |
| Constructor to add conversion capabilities to support JSR-352. Per the spec, it is expected that all keys and values in the provided Properties instance are Strings More... | |
| JobParametersBuilder | AddString (string key, string parameter) |
| Adds a new identifying String parameter for the given key. More... | |
| JobParametersBuilder | AddString (string key, string parameter, bool identifying) |
| Adds a new String parameter for the given key. More... | |
| JobParametersBuilder | AddDate (string key, DateTime?parameter) |
| Adds a new identifying DateTime parameter for the given key. More... | |
| JobParametersBuilder | AddDate (string key, DateTime?parameter, bool identifying) |
| Adds a new DateTime parameter for the given key. More... | |
| JobParametersBuilder | AddLong (string key, long parameter) |
| Add a new identifying Long parameter for the given key. More... | |
| JobParametersBuilder | AddLong (string key, long parameter, bool identifying) |
| Add a new Long parameter for the given key. More... | |
| JobParametersBuilder | AddDouble (string key, double parameter) |
| Add a new identifying Double parameter for the given key. More... | |
| JobParametersBuilder | AddDouble (string key, double parameter, bool identifying) |
| Adds a new Double parameter for the given key. More... | |
| JobParameters | ToJobParameters () |
| Conversion method that takes the current state of this builder and returns it as a JobruntimeParameters object. More... | |
| JobParametersBuilder | AddParameter (string key, JobParameter jobParameter) |
| Adds a new JobParameter for the given key. More... | |
| void | Dispose () |
| see https://msdn.microsoft.com/fr-fr/library/ms244737.aspx More... | |
Detailed Description
Helper class for creating JobParameters. Useful because all JobParameter objects are immutable, and must be instantiated separately to ensure typesafety. Once created, it can be used in the same was a StringBuilder (except, order is irrelevant), by adding various parameter types and creating a valid JobParameters once finished. Using the identifying flag indicates if the parameter will be used in the identification of a JobInstance. That flag defaults to true.
Constructor & Destructor Documentation
| Summer.Batch.Core.JobParametersBuilder.JobParametersBuilder | ( | ) |
Default constructor. Initializes the builder with empty parameters.
| Summer.Batch.Core.JobParametersBuilder.JobParametersBuilder | ( | JobParameters | jobParameters | ) |
Copy constructor. Initializes the builder with the supplied parameters. THIS SHOULD PRESERVE PRIOR EXISTING ORDER.
- Parameters
-
jobParameters
| Summer.Batch.Core.JobParametersBuilder.JobParametersBuilder | ( | NameValueCollection | properties | ) |
Constructor to add conversion capabilities to support JSR-352. Per the spec, it is expected that all keys and values in the provided Properties instance are Strings
- Parameters
-
properties the job parameters to be used
Member Function Documentation
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddDate | ( | string | key, |
| DateTime? | parameter | ||
| ) |
Adds a new identifying DateTime parameter for the given key.
- Parameters
-
key parameter
- Returns
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddDate | ( | string | key, |
| DateTime? | parameter, | ||
| bool | identifying | ||
| ) |
Adds a new DateTime parameter for the given key.
- Parameters
-
key parameter identifying
- Returns
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddDouble | ( | string | key, |
| double | parameter | ||
| ) |
Add a new identifying Double parameter for the given key.
- Parameters
-
key parameter
- Returns
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddDouble | ( | string | key, |
| double | parameter, | ||
| bool | identifying | ||
| ) |
Adds a new Double parameter for the given key.
- Parameters
-
key parameter identifying
- Returns
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddLong | ( | string | key, |
| long | parameter | ||
| ) |
Add a new identifying Long parameter for the given key.
- Parameters
-
key parameter
- Returns
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddLong | ( | string | key, |
| long | parameter, | ||
| bool | identifying | ||
| ) |
Add a new Long parameter for the given key.
- Parameters
-
key parameter identifying
- Returns
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddParameter | ( | string | key, |
| JobParameter | jobParameter | ||
| ) |
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddString | ( | string | key, |
| string | parameter | ||
| ) |
Adds a new identifying String parameter for the given key.
- Parameters
-
key parameter
- Returns
| JobParametersBuilder Summer.Batch.Core.JobParametersBuilder.AddString | ( | string | key, |
| string | parameter, | ||
| bool | identifying | ||
| ) |
Adds a new String parameter for the given key.
- Parameters
-
key parameter identifying
- Returns
| void Summer.Batch.Core.JobParametersBuilder.Dispose | ( | ) |
| JobParameters Summer.Batch.Core.JobParametersBuilder.ToJobParameters | ( | ) |
Conversion method that takes the current state of this builder and returns it as a JobruntimeParameters object.
- Returns
The documentation for this class was generated from the following file:
- Summer.Batch.Core/Core/JobParametersBuilder.cs