Enforce order of Javadoc tags for records introduced in 6.2

See gh-33403
This commit is contained in:
Sam Brannen
2024-08-18 13:12:47 +02:00
parent 04271c3ead
commit 59c779d8fe
2 changed files with 18 additions and 8 deletions

View File

@@ -23,11 +23,13 @@ import org.springframework.util.Assert;
/**
* Outcome of a {@link Task} execution.
* @param executionTime the instant when the task execution started, {@code null} if the task has not started.
* @param status the {@link Status} of the execution outcome.
* @param throwable the exception thrown from the task execution, if any.
*
* @author Brian Clozel
* @since 6.2
* @param executionTime the instant when the task execution started, or
* {@code null} if the task has not started
* @param status the {@link Status} of the execution outcome
* @param throwable the exception thrown from the task execution, if any
*/
public record TaskExecutionOutcome(@Nullable Instant executionTime, Status status, @Nullable Throwable throwable) {
@@ -54,21 +56,27 @@ public record TaskExecutionOutcome(@Nullable Instant executionTime, Status statu
* Status of the task execution outcome.
*/
public enum Status {
/**
* The task has not been executed so far.
*/
NONE,
/**
* The task execution has been started and is ongoing.
*/
STARTED,
/**
* The task execution finished successfully.
*/
SUCCESS,
/**
* The task execution finished with an error.
*/
ERROR
}
}