Enforce order of Javadoc tags for records introduced in 6.2
See gh-33403
This commit is contained in:
parent
04271c3ead
commit
59c779d8fe
|
|
@ -23,11 +23,13 @@ import org.springframework.util.Assert;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Outcome of a {@link Task} execution.
|
* 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
|
* @author Brian Clozel
|
||||||
* @since 6.2
|
* @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) {
|
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.
|
* Status of the task execution outcome.
|
||||||
*/
|
*/
|
||||||
public enum Status {
|
public enum Status {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The task has not been executed so far.
|
* The task has not been executed so far.
|
||||||
*/
|
*/
|
||||||
NONE,
|
NONE,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The task execution has been started and is ongoing.
|
* The task execution has been started and is ongoing.
|
||||||
*/
|
*/
|
||||||
STARTED,
|
STARTED,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The task execution finished successfully.
|
* The task execution finished successfully.
|
||||||
*/
|
*/
|
||||||
SUCCESS,
|
SUCCESS,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The task execution finished with an error.
|
* The task execution finished with an error.
|
||||||
*/
|
*/
|
||||||
ERROR
|
ERROR
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -31,15 +31,17 @@ import org.springframework.http.codec.HttpMessageWriter;
|
||||||
import org.springframework.lang.Nullable;
|
import org.springframework.lang.Nullable;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@link Encoder} and {@link Decoder} that is able to handle a map to and from
|
* {@link Encoder} and {@link Decoder} that is able to encode and decode
|
||||||
* JSON. Used to configure the jsonpath infrastructure without having a hard
|
* a {@link Map} to and from JSON.
|
||||||
|
*
|
||||||
|
* <p>Used to configure the jsonpath infrastructure without having a hard
|
||||||
* dependency on the library.
|
* dependency on the library.
|
||||||
*
|
*
|
||||||
* @param encoder the JSON encoder
|
|
||||||
* @param decoder the JSON decoder
|
|
||||||
* @author Stephane Nicoll
|
* @author Stephane Nicoll
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 6.2
|
* @since 6.2
|
||||||
|
* @param encoder the JSON encoder
|
||||||
|
* @param decoder the JSON decoder
|
||||||
*/
|
*/
|
||||||
record JsonEncoderDecoder(Encoder<?> encoder, Decoder<?> decoder) {
|
record JsonEncoderDecoder(Encoder<?> encoder, Decoder<?> decoder) {
|
||||||
|
|
||||||
|
|
@ -89,7 +91,7 @@ record JsonEncoderDecoder(Encoder<?> encoder, Decoder<?> decoder) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Find the first suitable {@link Decoder} that can decode a {@link Map} to
|
* Find the first suitable {@link Decoder} that can decode a {@link Map} from
|
||||||
* JSON.
|
* JSON.
|
||||||
* @param readers the readers to inspect
|
* @param readers the readers to inspect
|
||||||
* @return a suitable JSON {@link Decoder} or {@code null}
|
* @return a suitable JSON {@link Decoder} or {@code null}
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue