Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed javadoc for JobOperator#abandon

Browse Source 
The javadoc in the `JobOperator#abandon` indicated that a JobExecution
marked as `ABANDONED` can be restarted (it cannot).

Resolves BATCH-2654
This commit is contained in:
Michael Minella
2017-11-22 09:19:03 -06:00
parent e47bcbdc9f
commit 8a223e35c6
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java
View File

@@ -201,17 +201,17 @@ public interface JobOperator {
*/
Set<String> 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;
}