Move enhance method to AbstractStep

Author: acktsap

spring-batch-core/src/main/java/org/springframework/batch/core/step/AbstractStep.java

@@ -60,6 +60,7 @@
  * @author Michael Minella
  * @author Chris Schaefer
  * @author Mahmoud Ben Hassine
+ * @author Taeik Lim
  */
 public abstract class AbstractStep implements Step, InitializingBean, BeanNameAware {
 
@@ -183,6 +184,22 @@ protected void open(ExecutionContext ctx) throws Exception {
 	protected void close(ExecutionContext ctx) throws Exception {
 	}
 
+	public void enhance(StepProperties properties) {
+		setJobRepository(properties.getJobRepository());
+
+		Boolean allowStartIfComplete = properties.getAllowStartIfComplete();
+		if (allowStartIfComplete != null) {
+			setAllowStartIfComplete(allowStartIfComplete);
+		}
+
+		setStartLimit(properties.getStartLimit());
+
+		List<StepExecutionListener> listeners = properties.getStepExecutionListeners();
+		if (!listeners.isEmpty()) {
+			setStepExecutionListeners(listeners.toArray(new StepExecutionListener[0]));
+		}
+	}
+
 	/**
 	 * Template method for step execution logic - calls abstract methods for resource
 	 * initialization ( {@link #open(ExecutionContext)}), execution logic

spring-batch-core/src/main/java/org/springframework/batch/core/step/StepProperties.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2006-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.batch.core.step;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.springframework.batch.core.Step;
+import org.springframework.batch.core.StepExecutionListener;
+import org.springframework.batch.core.repository.JobRepository;
+
+/**
+ * A common properties for {@link Step}.
+ *
+ * @author Taeik Lim
+ */
+public class StepProperties {
+
+	private List<StepExecutionListener> stepExecutionListeners = new ArrayList<>();
+
+	private String name;
+
+	private int startLimit = Integer.MAX_VALUE;
+
+	private Boolean allowStartIfComplete;
+
+	private JobRepository jobRepository;
+
+	public StepProperties() {
+	}
+
+	public StepProperties(StepProperties properties) {
+		this.name = properties.name;
+		this.startLimit = properties.startLimit;
+		this.allowStartIfComplete = properties.allowStartIfComplete;
+		this.jobRepository = properties.jobRepository;
+		this.stepExecutionListeners = new ArrayList<>(properties.stepExecutionListeners);
+	}
+
+	public JobRepository getJobRepository() {
+		return jobRepository;
+	}
+
+	public void setJobRepository(JobRepository jobRepository) {
+		this.jobRepository = jobRepository;
+	}
+
+	public String getName() {
+		return name;
+	}
+
+	public void setName(String name) {
+		this.name = name;
+	}
+
+	public List<StepExecutionListener> getStepExecutionListeners() {
+		return stepExecutionListeners;
+	}
+
+	public void addStepExecutionListeners(List<StepExecutionListener> stepExecutionListeners) {
+		this.stepExecutionListeners.addAll(stepExecutionListeners);
+	}
+
+	public void addStepExecutionListener(StepExecutionListener stepExecutionListener) {
+		this.stepExecutionListeners.add(stepExecutionListener);
+	}
+
+	public Integer getStartLimit() {
+		return startLimit;
+	}
+
+	public void setStartLimit(Integer startLimit) {
+		this.startLimit = startLimit;
+	}
+
+	public Boolean getAllowStartIfComplete() {
+		return allowStartIfComplete;
+	}
+
+	public void setAllowStartIfComplete(Boolean allowStartIfComplete) {
+		this.allowStartIfComplete = allowStartIfComplete;
+	}
+
+}

spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/AbstractTaskletStepBuilder.java

@@ -27,6 +27,8 @@
 import org.springframework.batch.core.annotation.AfterChunkError;
 import org.springframework.batch.core.annotation.BeforeChunk;
 import org.springframework.batch.core.listener.StepListenerFactoryBean;
+import org.springframework.batch.core.step.AbstractStep;
+import org.springframework.batch.core.step.StepProperties;
 import org.springframework.batch.core.step.tasklet.Tasklet;
 import org.springframework.batch.core.step.tasklet.TaskletStep;
 import org.springframework.batch.item.ItemStream;
@@ -49,6 +51,7 @@
  * @author Dave Syer
  * @author Michael Minella
  * @author Mahmoud Ben Hassine
+ * @author Taeik Lim
  * @since 2.2
  * @param <B> the type of builder represented
  */
@@ -78,8 +81,8 @@ public AbstractTaskletStepBuilder(StepBuilderHelper<?> parent) {
 
 	/**
 	 * Build the step from the components collected by the fluent setters. Delegates first
-	 * to {@link #enhance(Step)} and then to {@link #createTasklet()} in subclasses to
-	 * create the actual tasklet.
+	 * to {@link AbstractStep#enhance(StepProperties)} and then to
+	 * {@link #createTasklet()} in subclasses to create the actual tasklet.
 	 * @return a tasklet step fully configured and ready to execute
 	 */
 	public TaskletStep build() {
@@ -88,7 +91,7 @@ public TaskletStep build() {
 
 		TaskletStep step = new TaskletStep(getName());
 
-		super.enhance(step);
+		step.enhance(properties);
 
 		step.setChunkListeners(chunkListeners.toArray(new ChunkListener[0]));
 

spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/FlowStepBuilder.java

@@ -24,6 +24,7 @@
  * nested flow composed of other steps.
  *
  * @author Dave Syer
+ * @author Taeik Lim
  * @since 2.2
  */
 public class FlowStepBuilder extends StepBuilderHelper<FlowStepBuilder> {
@@ -59,7 +60,7 @@ public Step build() {
 		FlowStep step = new FlowStep();
 		step.setName(getName());
 		step.setFlow(flow);
-		super.enhance(step);
+		step.enhance(properties);
 		try {
 			step.afterPropertiesSet();
 		}

spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/JobStepBuilder.java

@@ -27,6 +27,7 @@
  * with parameters taken from the parent job or from the step execution.
  *
  * @author Dave Syer
+ * @author Taeik Lim
  * @since 2.2
  */
 public class JobStepBuilder extends StepBuilderHelper<JobStepBuilder> {
@@ -85,7 +86,7 @@ public Step build() {
 
 		JobStep step = new JobStep();
 		step.setName(getName());
-		super.enhance(step);
+		step.enhance(properties);
 		if (job != null) {
 			step.setJob(job);
 		}

spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/PartitionStepBuilder.java

@@ -34,6 +34,7 @@
  * @author Dave Syer
  * @author Mahmoud Ben Hassine
  * @author Dimitrios Liapis
+ * @author Taeik Lim
  * @since 2.2
  */
 public class PartitionStepBuilder extends StepBuilderHelper<PartitionStepBuilder> {
@@ -161,7 +162,7 @@ public PartitionStepBuilder aggregator(StepExecutionAggregator aggregator) {
 	public Step build() {
 		PartitionStep step = new PartitionStep();
 		step.setName(getName());
-		super.enhance(step);
+		step.enhance(properties);
 
 		if (partitionHandler != null) {
 			step.setPartitionHandler(partitionHandler);

spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/StepBuilderHelper.java

@@ -24,6 +24,7 @@
 import org.springframework.batch.core.listener.StepListenerFactoryBean;
 import org.springframework.batch.core.repository.JobRepository;
 import org.springframework.batch.core.step.AbstractStep;
+import org.springframework.batch.core.step.StepProperties;
 import org.springframework.batch.core.step.tasklet.TaskletStep;
 import org.springframework.batch.support.ReflectionUtils;
 import org.springframework.transaction.PlatformTransactionManager;
@@ -41,17 +42,18 @@
  * @author Dave Syer
  * @author Michael Minella
  * @author Mahmoud Ben Hassine
+ * @author Taeik Lim
  * @since 2.2
  */
 public abstract class StepBuilderHelper<B extends StepBuilderHelper<B>> {
 
 	protected final Log logger = LogFactory.getLog(getClass());
 
-	protected final CommonStepProperties properties;
+	protected final StepProperties properties;
 
 	public StepBuilderHelper(String name) {
-		this.properties = new CommonStepProperties();
-		properties.name = name;
+		this.properties = new StepProperties();
+		properties.setName(name);
 	}
 
 	/**
@@ -60,16 +62,16 @@ public StepBuilderHelper(String name) {
 	 * @param parent a parent helper containing common step properties
 	 */
 	protected StepBuilderHelper(StepBuilderHelper<?> parent) {
-		this.properties = new CommonStepProperties(parent.properties);
+		this.properties = new StepProperties(parent.properties);
 	}
 
 	public B repository(JobRepository jobRepository) {
-		properties.jobRepository = jobRepository;
+		properties.setJobRepository(jobRepository);
 		return self();
 	}
 
 	public B startLimit(int startLimit) {
-		properties.startLimit = startLimit;
+		properties.setStartLimit(startLimit);
 		return self();
 	}
 
@@ -98,114 +100,22 @@ public B listener(StepExecutionListener listener) {
 	}
 
 	public B allowStartIfComplete(boolean allowStartIfComplete) {
-		properties.allowStartIfComplete = allowStartIfComplete;
+		properties.setAllowStartIfComplete(allowStartIfComplete);
 		return self();
 	}
 
 	protected abstract B self();
 
 	protected String getName() {
-		return properties.name;
+		return properties.getName();
 	}
 
 	protected JobRepository getJobRepository() {
-		return properties.jobRepository;
+		return properties.getJobRepository();
 	}
 
 	protected boolean isAllowStartIfComplete() {
-		return properties.allowStartIfComplete != null ? properties.allowStartIfComplete : false;
-	}
-
-	protected void enhance(Step target) {
-
-		if (target instanceof AbstractStep) {
-
-			AbstractStep step = (AbstractStep) target;
-			step.setJobRepository(properties.getJobRepository());
-
-			Boolean allowStartIfComplete = properties.allowStartIfComplete;
-			if (allowStartIfComplete != null) {
-				step.setAllowStartIfComplete(allowStartIfComplete);
-			}
-
-			step.setStartLimit(properties.startLimit);
-
-			List<StepExecutionListener> listeners = properties.stepExecutionListeners;
-			if (!listeners.isEmpty()) {
-				step.setStepExecutionListeners(listeners.toArray(new StepExecutionListener[0]));
-			}
-
-		}
-
-	}
-
-	public static class CommonStepProperties {
-
-		private List<StepExecutionListener> stepExecutionListeners = new ArrayList<>();
-
-		private int startLimit = Integer.MAX_VALUE;
-
-		private Boolean allowStartIfComplete;
-
-		private JobRepository jobRepository;
-
-		public CommonStepProperties() {
-		}
-
-		public CommonStepProperties(CommonStepProperties properties) {
-			this.name = properties.name;
-			this.startLimit = properties.startLimit;
-			this.allowStartIfComplete = properties.allowStartIfComplete;
-			this.jobRepository = properties.jobRepository;
-			this.stepExecutionListeners = new ArrayList<>(properties.stepExecutionListeners);
-		}
-
-		public JobRepository getJobRepository() {
-			return jobRepository;
-		}
-
-		public void setJobRepository(JobRepository jobRepository) {
-			this.jobRepository = jobRepository;
-		}
-
-		public String getName() {
-			return name;
-		}
-
-		public void setName(String name) {
-			this.name = name;
-		}
-
-		public List<StepExecutionListener> getStepExecutionListeners() {
-			return stepExecutionListeners;
-		}
-
-		public void addStepExecutionListeners(List<StepExecutionListener> stepExecutionListeners) {
-			this.stepExecutionListeners.addAll(stepExecutionListeners);
-		}
-
-		public void addStepExecutionListener(StepExecutionListener stepExecutionListener) {
-			this.stepExecutionListeners.add(stepExecutionListener);
-		}
-
-		public Integer getStartLimit() {
-			return startLimit;
-		}
-
-		public void setStartLimit(Integer startLimit) {
-			this.startLimit = startLimit;
-		}
-
-		public Boolean getAllowStartIfComplete() {
-			return allowStartIfComplete;
-		}
-
-		public void setAllowStartIfComplete(Boolean allowStartIfComplete) {
-			this.allowStartIfComplete = allowStartIfComplete;
-		}
-
-		private String name;
-
+		return properties.getAllowStartIfComplete() != null ? properties.getAllowStartIfComplete() : false;
 	}
 
 }