Fix NullAway findings

Signed-off-by: Stefano Cordio <[email protected]>

Author: scordio

pom.xml

@@ -191,6 +191,7 @@
 							<!-- Check JSpecify annotations -->
 							-Xep:NullAway:ERROR
 							-XepOpt:NullAway:OnlyNullMarked
+							-XepOpt:NullAway:CustomContractAnnotations=org.springframework.lang.Contract
 						</compilerArg>
 					</compilerArgs>
 					<annotationProcessorPaths>

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java

@@ -222,7 +222,7 @@ private Collection<Job> doLoad(ApplicationContextFactory factory, boolean unregi
 	 * @return all the {@link Step} defined by the given step locator and context
 	 * @see StepLocator
 	 */
-	private Collection<Step> getSteps(final StepLocator stepLocator, final ApplicationContext jobApplicationContext) {
+	private Collection<Step> getSteps(StepLocator stepLocator, final ApplicationContext jobApplicationContext) {
 		final Collection<String> stepNames = stepLocator.getStepNames();
 		final Collection<Step> result = new ArrayList<>();
 		for (String stepName : stepNames) {

spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecutor.java

@@ -51,8 +51,7 @@ public interface FlowExecutor {
 	/**
 	 * @return the latest {@link StepExecution} or null if there is none
 	 */
-	@Nullable
-	StepExecution getStepExecution();
+	@Nullable StepExecution getStepExecution();
 
 	/**
 	 * Chance to clean up resources at the end of a flow (whether it completed

spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowJob.java

@@ -127,7 +127,7 @@ public Collection<String> getStepNames() {
 	 * @see AbstractJob#doExecute(JobExecution)
 	 */
 	@Override
-	protected void doExecute(final JobExecution execution) throws JobExecutionException {
+	protected void doExecute(JobExecution execution) throws JobExecutionException {
 		try {
 			JobFlowExecutor executor = new JobFlowExecutor(getJobRepository(),
 					new SimpleStepHandler(getJobRepository()), execution);

spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/SplitState.java

@@ -97,13 +97,13 @@ public Collection<Flow> getFlows() {
 	 * @see State#handle(FlowExecutor)
 	 */
 	@Override
-	public FlowExecutionStatus handle(final FlowExecutor executor) throws Exception {
+	public FlowExecutionStatus handle(FlowExecutor executor) throws Exception {
 
 		// TODO: collect the last StepExecution from the flows as well, so they
 		// can be abandoned if necessary
 		Collection<Future<FlowExecution>> tasks = new ArrayList<>();
 
-		for (final Flow flow : flows) {
+		for (Flow flow : flows) {
 
 			final FutureTask<FlowExecution> task = new FutureTask<>(() -> flow.start(executor));
 

spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/TaskExecutorJobLauncher.java

@@ -98,9 +98,8 @@ public class TaskExecutorJobLauncher implements JobLauncher, InitializingBean {
 	 * @throws JobParametersInvalidException thrown if jobParameters is invalid.
 	 */
 	@Override
-	public JobExecution run(final Job job, final JobParameters jobParameters)
-			throws JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException,
-			JobParametersInvalidException {
+	public JobExecution run(Job job, final JobParameters jobParameters) throws JobExecutionAlreadyRunningException,
+			JobRestartException, JobInstanceAlreadyCompleteException, JobParametersInvalidException {
 
 		Assert.notNull(job, "The Job must not be null.");
 		Assert.notNull(jobParameters, "The JobParameters must not be null.");

spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/AbstractPartitionHandler.java

@@ -52,7 +52,7 @@ protected abstract Set<StepExecution> doHandle(StepExecution managerStepExecutio
 	 * @see PartitionHandler#handle(StepExecutionSplitter, StepExecution)
 	 */
 	@Override
-	public Collection<StepExecution> handle(final StepExecutionSplitter stepSplitter,
+	public Collection<StepExecution> handle(StepExecutionSplitter stepSplitter,
 			final StepExecution managerStepExecution) throws Exception {
 		final Set<StepExecution> stepExecutions = stepSplitter.split(managerStepExecution, gridSize);
 

spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/TaskExecutorPartitionHandler.java

@@ -93,7 +93,7 @@ protected Set<StepExecution> doHandle(StepExecution managerStepExecution,
 		final Set<Future<StepExecution>> tasks = new HashSet<>(getGridSize());
 		final Set<StepExecution> result = new HashSet<>();
 
-		for (final StepExecution stepExecution : partitionStepExecutions) {
+		for (StepExecution stepExecution : partitionStepExecutions) {
 			final FutureTask<StepExecution> task = createTask(step, stepExecution);
 
 			try {
@@ -127,7 +127,7 @@ protected Set<StepExecution> doHandle(StepExecution managerStepExecution,
 	 * @param stepExecution the given execution
 	 * @return the task executing the given step
 	 */
-	protected FutureTask<StepExecution> createTask(final Step step, final StepExecution stepExecution) {
+	protected FutureTask<StepExecution> createTask(Step step, final StepExecution stepExecution) {
 		return new FutureTask<>(() -> {
 			step.execute(stepExecution);
 			return stepExecution;

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/ExecutionContextDao.java

@@ -48,36 +48,36 @@ public interface ExecutionContextDao {
 	 * entry for the context should not exist yet.
 	 * @param jobExecution {@link JobExecution} instance that contains the context.
 	 */
-	void saveExecutionContext(final JobExecution jobExecution);
+	void saveExecutionContext(JobExecution jobExecution);
 
 	/**
 	 * Persist the execution context associated with the given stepExecution, persistent
 	 * entry for the context should not exist yet.
 	 * @param stepExecution {@link StepExecution} instance that contains the context.
 	 */
-	void saveExecutionContext(final StepExecution stepExecution);
+	void saveExecutionContext(StepExecution stepExecution);
 
 	/**
 	 * Persist the execution context associated with each stepExecution in a given
 	 * collection, persistent entry for the context should not exist yet.
 	 * @param stepExecutions a collection of {@link StepExecution}s that contain the
 	 * contexts.
 	 */
-	void saveExecutionContexts(final Collection<StepExecution> stepExecutions);
+	void saveExecutionContexts(Collection<StepExecution> stepExecutions);
 
 	/**
 	 * Persist the updates of execution context associated with the given jobExecution.
 	 * Persistent entry should already exist for this context.
 	 * @param jobExecution {@link JobExecution} instance that contains the context.
 	 */
-	void updateExecutionContext(final JobExecution jobExecution);
+	void updateExecutionContext(JobExecution jobExecution);
 
 	/**
 	 * Persist the updates of execution context associated with the given stepExecution.
 	 * Persistent entry should already exist for this context.
 	 * @param stepExecution {@link StepExecution} instance that contains the context.
 	 */
-	void updateExecutionContext(final StepExecution stepExecution);
+	void updateExecutionContext(StepExecution stepExecution);
 
 	/**
 	 * Delete the execution context of the given {@link JobExecution}.

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobExecutionDao.java

@@ -19,13 +19,9 @@
 import java.util.List;
 import java.util.Set;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.batch.core.job.JobExecution;
 import org.springframework.batch.core.job.JobInstance;
-import org.springframework.lang.Nullable;
-import org.springframework.batch.core.JobExecution;
-
-import org.jspecify.annotations.Nullable;
-import org.springframework.batch.core.JobInstance;
 
 /**
  * Data Access Object for job executions.
@@ -68,8 +64,7 @@ public interface JobExecutionDao {
 	 * @return the last {@link JobExecution} to execute for this instance or {@code null}
 	 * if no job execution is found for the given job instance.
 	 */
-	@Nullable
-	JobExecution getLastJobExecution(JobInstance jobInstance);
+	@Nullable JobExecution getLastJobExecution(JobInstance jobInstance);
 
 	/**
 	 * @param jobName {@link String} containing the name of the job.
@@ -82,8 +77,7 @@ public interface JobExecutionDao {
 	 * @param executionId {@link Long} containing the id of the execution.
 	 * @return the {@link JobExecution} for given identifier.
 	 */
-	@Nullable
-	JobExecution getJobExecution(Long executionId);
+	@Nullable JobExecution getJobExecution(Long executionId);
 
 	/**
 	 * Because it may be possible that the status of a JobExecution is updated while

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobInstanceDao.java

@@ -58,25 +58,22 @@ public interface JobInstanceDao {
 	 * @return {@link JobInstance} object matching the job name and {@link JobParameters}
 	 * or {@code null}
 	 */
-	@Nullable
-	JobInstance getJobInstance(String jobName, JobParameters jobParameters);
+	@Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters);
 
 	/**
 	 * Fetch the job instance with the provided identifier.
 	 * @param instanceId the job identifier
 	 * @return the job instance with this identifier or {@code null} if it doesn't exist
 	 */
-	@Nullable
-	JobInstance getJobInstance(@Nullable Long instanceId);
+	@Nullable JobInstance getJobInstance(@Nullable Long instanceId);
 
 	/**
 	 * Fetch the JobInstance for the provided JobExecution.
 	 * @param jobExecution the JobExecution
 	 * @return the JobInstance for the provided execution or {@code null} if it doesn't
 	 * exist.
 	 */
-	@Nullable
-	JobInstance getJobInstance(JobExecution jobExecution);
+	@Nullable JobInstance getJobInstance(JobExecution jobExecution);
 
 	/**
 	 * Fetch the last job instances with the provided name, sorted backwards by primary

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/StepExecutionDao.java

@@ -60,8 +60,7 @@ public interface StepExecutionDao {
 	 * @param stepExecutionId the step execution id
 	 * @return a {@link StepExecution}
 	 */
-	@Nullable
-	StepExecution getStepExecution(JobExecution jobExecution, Long stepExecutionId);
+	@Nullable StepExecution getStepExecution(JobExecution jobExecution, Long stepExecutionId);
 
 	/**
 	 * Retrieve the last {@link StepExecution} for a given {@link JobInstance} ordered by

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcExecutionContextDao.java

@@ -172,7 +172,7 @@ public ExecutionContext getExecutionContext(StepExecution stepExecution) {
 	}
 
 	@Override
-	public void updateExecutionContext(final JobExecution jobExecution) {
+	public void updateExecutionContext(JobExecution jobExecution) {
 		Long executionId = jobExecution.getId();
 		ExecutionContext executionContext = jobExecution.getExecutionContext();
 		Assert.notNull(executionId, "ExecutionId must not be null.");
@@ -184,7 +184,7 @@ public void updateExecutionContext(final JobExecution jobExecution) {
 	}
 
 	@Override
-	public void updateExecutionContext(final StepExecution stepExecution) {
+	public void updateExecutionContext(StepExecution stepExecution) {
 		// Attempt to prevent concurrent modification errors by blocking here if
 		// someone is already trying to do it.
 		this.lock.lock();
@@ -271,7 +271,7 @@ public void afterPropertiesSet() throws Exception {
 	 * @param serializedContext the serialized context to persist
 	 * @param sql with parameters (shortContext, longContext, executionId)
 	 */
-	private void persistSerializedContext(final Long executionId, String serializedContext, String sql) {
+	private void persistSerializedContext(Long executionId, String serializedContext, String sql) {
 
 		final String shortContext;
 		final String longContext;
@@ -302,7 +302,7 @@ private void persistSerializedContext(final Long executionId, String serializedC
 	 * @param serializedContexts the execution contexts to serialize
 	 * @param sql with parameters (shortContext, longContext, executionId)
 	 */
-	private void persistSerializedContexts(final Map<Long, String> serializedContexts, String sql) {
+	private void persistSerializedContexts(Map<Long, String> serializedContexts, String sql) {
 		if (!serializedContexts.isEmpty()) {
 			final Iterator<Long> executionIdIterator = serializedContexts.keySet().iterator();
 

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobExecutionDao.java

@@ -207,7 +207,7 @@ public void afterPropertiesSet() throws Exception {
 	}
 
 	@Override
-	public List<JobExecution> findJobExecutions(final JobInstance job) {
+	public List<JobExecution> findJobExecutions(JobInstance job) {
 
 		Assert.notNull(job, "Job cannot be null.");
 		Assert.notNull(job.getId(), "Job Id cannot be null.");

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobInstanceDao.java

@@ -167,7 +167,7 @@ public JobInstance createJobInstance(String jobName, JobParameters jobParameters
 	 * @throws IllegalArgumentException if any {@link JobParameters} fields are null.
 	 */
 	@Override
-	public @Nullable JobInstance getJobInstance(final String jobName, final JobParameters jobParameters) {
+	public @Nullable JobInstance getJobInstance(String jobName, final JobParameters jobParameters) {
 
 		Assert.notNull(jobName, "Job name must not be null.");
 		Assert.notNull(jobParameters, "JobParameters must not be null.");

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcStepExecutionDao.java

@@ -176,7 +176,7 @@ public void saveStepExecution(StepExecution stepExecution) {
 	 * @see StepExecutionDao#saveStepExecutions(Collection)
 	 */
 	@Override
-	public void saveStepExecutions(final Collection<StepExecution> stepExecutions) {
+	public void saveStepExecutions(Collection<StepExecution> stepExecutions) {
 		Assert.notNull(stepExecutions, "Attempt to save a null collection of step executions");
 
 		if (!stepExecutions.isEmpty()) {

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

@@ -200,7 +200,7 @@ protected Chunk<O> getAdjustedOutputs(Chunk<I> inputs, Chunk<O> outputs) {
 	}
 
 	@Override
-	protected Chunk<O> transform(final StepContribution contribution, Chunk<I> inputs) throws Exception {
+	protected Chunk<O> transform(StepContribution contribution, Chunk<I> inputs) throws Exception {
 
 		Chunk<O> outputs = new Chunk<>();
 		@SuppressWarnings("unchecked")
@@ -211,7 +211,7 @@ protected Chunk<O> transform(final StepContribution contribution, Chunk<I> input
 		// final int scanLimit = processorTransactional && data.scanning() ? 1 :
 		// 0;
 
-		for (final Chunk<I>.ChunkIterator iterator = inputs.iterator(); iterator.hasNext();) {
+		for (Chunk<I>.ChunkIterator iterator = inputs.iterator(); iterator.hasNext();) {
 
 			final I item = iterator.next();
 
@@ -314,7 +314,7 @@ else if (shouldSkip(itemProcessSkipPolicy, e, contribution.getStepSkipCount()))
 	}
 
 	@Override
-	protected void write(final StepContribution contribution, final Chunk<I> inputs, final Chunk<O> outputs)
+	protected void write(StepContribution contribution, final Chunk<I> inputs, final Chunk<O> outputs)
 			throws Exception {
 		@SuppressWarnings("unchecked")
 		final UserData<O> data = (UserData<O>) inputs.getUserData();
@@ -432,7 +432,7 @@ protected void write(final StepContribution contribution, final Chunk<I> inputs,
 
 	}
 
-	private void callSkipListeners(final Chunk<I> inputs, final Chunk<O> outputs) {
+	private void callSkipListeners(Chunk<I> inputs, final Chunk<O> outputs) {
 
 		for (SkipWrapper<I> wrapper : inputs.getSkips()) {
 			I item = wrapper.getItem();
@@ -500,7 +500,7 @@ private Object getInputKey(I item) {
 		return keyGenerator.getKey(item);
 	}
 
-	private List<?> getInputKeys(final Chunk<I> inputs) {
+	private List<?> getInputKeys(Chunk<I> inputs) {
 		if (keyGenerator == null) {
 			return inputs.getItems();
 		}
@@ -539,7 +539,7 @@ else if (e instanceof Error error) {
 		}
 	}
 
-	private void scan(final StepContribution contribution, final Chunk<I> inputs, final Chunk<O> outputs,
+	private void scan(StepContribution contribution, final Chunk<I> inputs, final Chunk<O> outputs,
 			ChunkMonitor chunkMonitor, boolean recovery) throws Exception {
 
 		@SuppressWarnings("unchecked")

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

@@ -121,7 +121,7 @@ public void registerListener(StepListener listener) {
 	}
 
 	@Override
-	public Chunk<I> provide(final StepContribution contribution) throws Exception {
+	public Chunk<I> provide(StepContribution contribution) throws Exception {
 
 		final Chunk<I> inputs = new Chunk<>();
 		repeatOperations.iterate(context -> {

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

@@ -44,7 +44,6 @@ public interface Tasklet {
 	 * Returning {@code null} is interpreted as {@link RepeatStatus#FINISHED}
 	 * @throws Exception thrown if error occurs during execution.
 	 */
-	@Nullable
-	RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception;
+	@Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception;
 
 }

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

@@ -476,7 +476,7 @@ private void rollback(StepExecution stepExecution) {
 			}
 		}
 
-		private void copy(final StepExecution source, final StepExecution target) {
+		private void copy(StepExecution source, final StepExecution target) {
 			target.setVersion(source.getVersion());
 			target.setWriteCount(source.getWriteCount());
 			target.setFilterCount(source.getFilterCount());

spring-batch-core/src/test/java/org/springframework/batch/core/step/StepLocatorStepFactoryBeanTests.java

@@ -46,7 +46,7 @@ void testFoo() throws Exception {
 		assertEquals(testStep2, stepLocatorStepFactoryBean.getObject());
 	}
 
-	private Step buildTestStep(final String stepName) {
+	private Step buildTestStep(String stepName) {
 		return new Step() {
 			@Override
 			public String getName() {

spring-batch-core/src/test/java/org/springframework/batch/core/step/skip/ReprocessExceptionTests.java

@@ -56,7 +56,7 @@ public static class PersonProcessor implements ItemProcessor<Person, Person> {
 		private String mostRecentFirstName;
 
 		@Override
-		public @Nullable Person process(final Person person) throws Exception {
+		public @Nullable Person process(Person person) throws Exception {
 			if (person.getFirstName().equals(mostRecentFirstName)) {
 				throw new RuntimeException("throwing a exception during process after a rollback");
 			}

spring-batch-core/src/test/java/org/springframework/batch/core/step/tasklet/StepExecutorInterruptionTests.java

@@ -211,7 +211,7 @@ public void release() {
 		assertEquals(BatchStatus.FAILED, stepExecution.getStatus());
 	}
 
-	private Thread createThread(final StepExecution stepExecution) {
+	private Thread createThread(StepExecution stepExecution) {
 		Thread processingThread = new Thread(() -> {
 			try {
 				jobRepository.add(stepExecution);