Skip to content

Commit

Permalink
Fix type of date/time fields in documentation
Browse files Browse the repository at this point in the history
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
  • Loading branch information
swapy authored and fmbenhassine committed Mar 21, 2023
1 parent 145c31b commit 1343eee
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions spring-batch-docs/src/main/asciidoc/domain.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -211,11 +211,11 @@ and persisted, as the following table shows:
successfully, it is `BatchStatus#COMPLETED`

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

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

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

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

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

|`executionContext`
Expand Down Expand Up @@ -390,12 +390,12 @@ status is `BatchStatus.STARTED`. If it fails, the status is `BatchStatus.FAILED`
finishes successfully, the status is `BatchStatus.COMPLETED`.

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

|`endTime`

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

Expand Down

0 comments on commit 1343eee

Please sign in to comment.