Commit 0056722

committed

Refine contribution #4715

- Deprecate stop method - Fix imports - Update Javadocs

1 parent bdb2bfc commit 0056722Copy full SHA for 0056722

File tree

3 files changed

+19

-10

lines changed

spring-batch-core/src/main/java/org/springframework/batch/core
- launch/support
  - SimpleJobOperator.java
- step/tasklet
  - StoppableTasklet.java
  - SystemCommandTasklet.java

3 files changed

+19

-10

lines changed

`‎spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/SimpleJobOperator.java`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -367,7 +367,9 @@ public boolean stop(JobExecution jobExecution) throws JobExecutionNotRunningExce`
`367`	`367`	`}`
`368`	`368`	`}`
`369`	`369`	`catch (NoSuchJobException e) {`
`370`		`- logger.warn("Cannot find Job object in the job registry. StoppableTasklet#stop(StepExecution stepExecution) will not be called", e);`
	`370`	`+ logger.warn(`
	`371`	`+ "Cannot find Job object in the job registry. StoppableTasklet#stop(StepExecution stepExecution) will not be called",`
	`372`	`+ e);`
`371`	`373`	`}`
`372`	`374`
`373`	`375`	`return true;`

`‎spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/StoppableTasklet.java`

Lines changed: 8 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2013 the original author or authors.`
	`2`	`+ * Copyright 2013-present the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -15,7 +15,7 @@`
`15`	`15`	`*/`
`16`	`16`	`package org.springframework.batch.core.step.tasklet;`
`17`	`17`
`18`		`-import org.springframework.batch.core.StepExecution;`
	`18`	`+import org.springframework.batch.core.step.StepExecution;`
`19`	`19`	`import org.springframework.batch.core.launch.JobOperator;`
`20`	`20`	`import org.springframework.batch.core.step.StepContribution;`
`21`	`21`
`@@ -38,17 +38,20 @@ public interface StoppableTasklet extends Tasklet {`
`38`	`38`	`/**`
`39`	`39`	`* Used to signal that the job this {@link Tasklet} is executing within has been`
`40`	`40`	`* requested to stop.`
	`41`	`+ * @deprecated Since 6.0, use {@link #stop(StepExecution)} instead.`
`41`	`42`	`*/`
	`43`	`+ @Deprecated(since = "6.0", forRemoval = true)`
`42`	`44`	`void stop();`
`43`	`45`
`44`	`46`	`/**`
`45`	`47`	`* Used to signal that the job should stop, providing access to the current`
`46`	`48`	`* {@link StepExecution} context.`
`47`		`- *`
`48`		`- * @param stepExecution the current {@link StepExecution} context in which the job`
`49`		`- * is being executed`
	`49`	`+ * @param stepExecution the current {@link StepExecution} context in which the job is`
	`50`	`+ * being executed`
	`51`	`+ * @since 6.0`
`50`	`52`	`*/`
`51`	`53`	`default void stop(StepExecution stepExecution) {`
`52`	`54`	`stop();`
`53`	`55`	`}`
	`56`	`+`
`54`	`57`	`}`

`‎spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/SystemCommandTasklet.java`

Lines changed: 8 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -279,17 +279,21 @@ public void stop() {`
`279`	`279`	`/**`
`280`	`280`	`* Interrupts the execution of the system command if the given {@link StepExecution}`
`281`	`281`	`* matches the current execution context. This method allows for granular control over`
`282`		`- * stopping specific step executions, ensuring that only the intended command is halted.`
`283`		`- *`
	`282`	`+ * stopping specific step executions, ensuring that only the intended command is`
	`283`	`+ * halted.`
	`284`	`+ * <p>`
	`285`	`+ * This method will interrupt the thread executing the system command only if`
	`286`	`+ * {@link #setInterruptOnCancel(boolean)} has been set to true. Otherwise, the`
	`287`	`+ * underlying command will be allowed to finish before the tasklet ends.`
`284`	`288`	`* @param stepExecution the current {@link StepExecution} context; the execution is`
`285`	`289`	`* interrupted if it matches the ongoing one.`
`286`	`290`	`* @since 6.0`
`287`	`291`	`* @see StoppableTasklet#stop(StepExecution)`
`288`	`292`	`*/`
`289`	`293`	`@Override`
`290`	`294`	`public void stop(StepExecution stepExecution) {`
`291`		`- if (stepExecution.equals(execution)) {`
`292`		`- stopped = true;`
	`295`	`+ if (stepExecution.equals(this.execution)) {`
	`296`	`+ this.stopped = true;`
`293`	`297`	`}`
`294`	`298`	`}`
`295`	`299`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 0056722

File tree

3 files changed

3 files changed

`‎spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/SimpleJobOperator.java`

`‎spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/StoppableTasklet.java`

`‎spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/SystemCommandTasklet.java`

0 commit comments