From 8a223e35c6e236d2b1a50b1fa03f49cfba9dafb4 Mon Sep 17 00:00:00 2001 From: Michael Minella Date: Wed, 22 Nov 2017 09:19:03 -0600 Subject: [PATCH] Fixed javadoc for `JobOperator#abandon` The javadoc in the `JobOperator#abandon` indicated that a JobExecution marked as `ABANDONED` can be restarted (it cannot). Resolves BATCH-2654 --- .../batch/core/launch/JobOperator.java | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java index 5cdd59dde..19058bc27 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java @@ -201,17 +201,17 @@ public interface JobOperator { */ Set getJobNames(); - /** - * Mark the {@link JobExecution} as ABANDONED. If a stop signal is ignored - * because the process died this is the best way to mark a job as finished - * with (as opposed to STOPPED). An abandoned job execution can be - * restarted, but a stopping one cannot. - * - * @param jobExecutionId the job execution id to abort - * @return the {@link JobExecution} that was aborted - * @throws NoSuchJobExecutionException thrown if there is no job execution for the jobExecutionId. - * @throws JobExecutionAlreadyRunningException if the job is running (it - * should be stopped first) - */ - JobExecution abandon(long jobExecutionId) throws NoSuchJobExecutionException, JobExecutionAlreadyRunningException; + /** + * Mark the {@link JobExecution} as ABANDONED. If a stop signal is ignored + * because the process died this is the best way to mark a job as finished + * with (as opposed to STOPPED). An abandoned job execution cannot be + * restarted by the framework. + * + * @param jobExecutionId the job execution id to abort + * @return the {@link JobExecution} that was aborted + * @throws NoSuchJobExecutionException thrown if there is no job execution for the jobExecutionId. + * @throws JobExecutionAlreadyRunningException if the job is running (it + * should be stopped first) + */ + JobExecution abandon(long jobExecutionId) throws NoSuchJobExecutionException, JobExecutionAlreadyRunningException; }