Skip to content

Commit 1343eee

Browse files
swapyfmbenhassine
authored andcommitted
Fix type of date/time fields in documentation
This commit fixes a bug in the documentation of JobExecution and StepExecution to point to `java.time.LocalDateTime` instead of `java.util.Date`. Resolves #4324
1 parent 145c31b commit 1343eee

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

spring-batch-docs/src/main/asciidoc/domain.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -211,11 +211,11 @@ and persisted, as the following table shows:
211211
successfully, it is `BatchStatus#COMPLETED`
212212

213213
|`startTime`
214-
|A `java.util.Date` representing the current system time when the execution was started.
214+
|A `java.time.LocalDateTime` representing the current system time when the execution was started.
215215
This field is empty if the job has yet to start.
216216

217217
|`endTime`
218-
|A `java.util.Date` representing the current system time when the execution finished,
218+
|A `java.time.LocalDateTime` representing the current system time when the execution finished,
219219
regardless of whether or not it was successful. The field is empty if the job has yet to
220220
finish.
221221

@@ -225,13 +225,13 @@ contains an exit code that is returned to the caller. See chapter 5 for more det
225225
field is empty if the job has yet to finish.
226226

227227
|`createTime`
228-
|A `java.util.Date` representing the current system time when the `JobExecution` was
228+
|A `java.time.LocalDateTime` representing the current system time when the `JobExecution` was
229229
first persisted. The job may not have been started yet (and thus has no start time), but
230230
it always has a `createTime`, which is required by the framework for managing job-level
231231
`ExecutionContexts`.
232232

233233
|`lastUpdated`
234-
|A `java.util.Date` representing the last time a `JobExecution` was persisted. This field
234+
|A `java.time.LocalDateTime` representing the last time a `JobExecution` was persisted. This field
235235
is empty if the job has yet to start.
236236

237237
|`executionContext`
@@ -390,12 +390,12 @@ status is `BatchStatus.STARTED`. If it fails, the status is `BatchStatus.FAILED`
390390
finishes successfully, the status is `BatchStatus.COMPLETED`.
391391

392392
|`startTime`
393-
|A `java.util.Date` representing the current system time when the execution was started.
393+
|A `java.time.LocalDateTime` representing the current system time when the execution was started.
394394
This field is empty if the step has yet to start.
395395

396396
|`endTime`
397397

398-
|A `java.util.Date` representing the current system time when the execution finished,
398+
|A `java.time.LocalDateTime` representing the current system time when the execution finished,
399399
regardless of whether or not it was successful. This field is empty if the step has yet to
400400
exit.
401401

0 commit comments

Comments
 (0)