From 37ce11036630edea5d4e6d73d3972379b3da6711 Mon Sep 17 00:00:00 2001 From: Stefano Cordio Date: Thu, 21 Aug 2025 19:56:34 +0200 Subject: [PATCH 1/2] Migrate `spring-batch-infrastructure` to JSpecify annotations Signed-off-by: Stefano Cordio --- pom.xml | 16 +- .../org/springframework/batch/item/Chunk.java | 14 +- .../batch/item/ExecutionContext.java | 14 +- .../batch/item/ItemProcessor.java | 6 +- .../batch/item/ItemReader.java | 5 +- .../batch/item/ItemStreamException.java | 8 +- .../batch/item/ItemStreamSupport.java | 4 +- .../batch/item/ItemWriter.java | 4 +- .../batch/item/KeyValueItemWriter.java | 14 +- .../batch/item/PeekableItemReader.java | 5 +- .../batch/item/SkipWrapper.java | 14 +- .../batch/item/SpELItemKeyMapper.java | 9 +- .../AbstractMethodInvokingDelegator.java | 35 +-- .../item/adapter/HippyMethodInvoker.java | 19 +- .../item/adapter/ItemProcessorAdapter.java | 6 +- .../batch/item/adapter/ItemReaderAdapter.java | 6 +- ...ropertyExtractingDelegatingItemWriter.java | 8 +- .../batch/item/adapter/package-info.java | 4 +- .../batch/item/amqp/AmqpItemReader.java | 11 +- .../batch/item/amqp/AmqpItemWriter.java | 4 +- .../amqp/builder/AmqpItemReaderBuilder.java | 6 +- .../amqp/builder/AmqpItemWriterBuilder.java | 8 +- .../batch/item/amqp/builder/package-info.java | 8 +- .../batch/item/amqp/package-info.java | 5 +- .../batch/item/avro/AvroItemReader.java | 16 +- .../batch/item/avro/AvroItemWriter.java | 12 +- .../avro/builder/AvroItemReaderBuilder.java | 24 +- .../avro/builder/AvroItemWriterBuilder.java | 8 +- .../batch/item/avro/builder/package-info.java | 25 ++ .../batch/item/avro/package-info.java | 9 + .../data/AbstractPaginatedDataItemReader.java | 22 +- .../item/data/MongoCursorItemReader.java | 74 +++--- .../batch/item/data/MongoItemWriter.java | 55 ++--- .../item/data/MongoPagingItemReader.java | 38 ++-- .../batch/item/data/RepositoryItemReader.java | 18 +- .../batch/item/data/RepositoryItemWriter.java | 10 +- .../builder/MongoCursorItemReaderBuilder.java | 51 +++-- .../data/builder/MongoItemWriterBuilder.java | 7 +- .../builder/MongoPagingItemReaderBuilder.java | 48 ++-- .../builder/RepositoryItemReaderBuilder.java | 19 +- .../builder/RepositoryItemWriterBuilder.java | 25 +- .../batch/item/data/builder/package-info.java | 5 +- .../batch/item/data/package-info.java | 5 +- .../database/AbstractCursorItemReader.java | 42 ++-- .../database/AbstractPagingItemReader.java | 10 +- .../ExtendedConnectionDataSourceProxy.java | 69 +++--- .../item/database/JdbcBatchItemWriter.java | 16 +- .../item/database/JdbcCursorItemReader.java | 22 +- .../item/database/JdbcPagingItemReader.java | 38 ++-- .../item/database/JpaCursorItemReader.java | 28 ++- .../batch/item/database/JpaItemWriter.java | 6 +- .../item/database/JpaPagingItemReader.java | 44 ++-- .../database/StoredProcedureItemReader.java | 32 ++- .../builder/JdbcBatchItemWriterBuilder.java | 24 +- .../builder/JdbcCursorItemReaderBuilder.java | 16 +- .../builder/JdbcPagingItemReaderBuilder.java | 68 +++--- .../builder/JpaCursorItemReaderBuilder.java | 34 ++- .../builder/JpaItemWriterBuilder.java | 4 +- .../builder/JpaPagingItemReaderBuilder.java | 34 ++- .../StoredProcedureItemReaderBuilder.java | 15 +- .../item/database/builder/package-info.java | 4 +- .../orm/AbstractJpaQueryProvider.java | 11 +- .../database/orm/JpaNamedQueryProvider.java | 9 +- .../database/orm/JpaNativeQueryProvider.java | 14 +- .../item/database/orm/JpaQueryProvider.java | 7 +- .../batch/item/database/orm/package-info.java | 4 +- .../batch/item/database/package-info.java | 4 +- .../AbstractSqlPagingQueryProvider.java | 33 ++- .../SqlPagingQueryProviderFactoryBean.java | 22 +- .../database/support/SqlPagingQueryUtils.java | 3 +- .../item/database/support/package-info.java | 4 +- .../batch/item/file/FlatFileItemReader.java | 33 ++- .../batch/item/file/FlatFileItemWriter.java | 5 +- .../item/file/MultiResourceItemReader.java | 21 +- .../item/file/MultiResourceItemWriter.java | 10 +- .../file/NonTransientFlatFileException.java | 7 +- .../batch/item/file/ResourcesItemReader.java | 6 +- .../SimpleBinaryBufferedReaderFactory.java | 4 +- .../builder/FlatFileItemReaderBuilder.java | 77 +++---- .../builder/FlatFileItemWriterBuilder.java | 56 +++-- .../MultiResourceItemReaderBuilder.java | 10 +- .../MultiResourceItemWriterBuilder.java | 13 +- .../batch/item/file/builder/package-info.java | 5 +- .../mapping/BeanWrapperFieldSetMapper.java | 26 +-- .../item/file/mapping/DefaultLineMapper.java | 6 +- .../PatternMatchingCompositeLineMapper.java | 4 +- .../file/mapping/RecordFieldSetMapper.java | 18 +- .../batch/item/file/mapping/package-info.java | 4 +- .../batch/item/file/package-info.java | 4 +- .../DefaultRecordSeparatorPolicy.java | 32 ++- .../separator/JsonRecordSeparatorPolicy.java | 5 +- .../file/separator/RecordSeparatorPolicy.java | 8 +- .../SimpleRecordSeparatorPolicy.java | 6 +- .../SuffixRecordSeparatorPolicy.java | 19 +- .../item/file/separator/package-info.java | 4 +- .../file/transform/AbstractLineTokenizer.java | 39 ++-- .../transform/BeanWrapperFieldExtractor.java | 6 +- .../item/file/transform/DefaultFieldSet.java | 214 ++++++++---------- .../transform/DefaultFieldSetFactory.java | 34 +-- .../transform/DelimitedLineTokenizer.java | 15 +- .../item/file/transform/FieldExtractor.java | 4 +- .../batch/item/file/transform/FieldSet.java | 26 ++- .../file/transform/FixedLengthTokenizer.java | 11 +- .../transform/FlatFileFormatException.java | 6 +- .../transform/FormatterLineAggregator.java | 4 +- .../IncorrectTokenCountException.java | 19 +- .../item/file/transform/LineTokenizer.java | 2 +- ...PatternMatchingCompositeLineTokenizer.java | 6 +- .../transform/RangeArrayPropertyEditor.java | 2 +- .../file/transform/RecordFieldExtractor.java | 14 +- .../file/transform/RegexLineTokenizer.java | 5 +- .../item/file/transform/package-info.java | 4 +- .../item/function/FunctionItemProcessor.java | 6 +- .../PredicateFilteringItemProcessor.java | 4 +- .../batch/item/function/package-info.java | 4 +- .../batch/item/jms/JmsItemReader.java | 12 +- .../batch/item/jms/JmsItemWriter.java | 4 +- .../jms/JmsMethodInvocationRecoverer.java | 8 +- .../jms/builder/JmsItemReaderBuilder.java | 10 +- .../jms/builder/JmsItemWriterBuilder.java | 3 +- .../batch/item/jms/builder/package-info.java | 5 +- .../batch/item/jms/package-info.java | 5 +- .../batch/item/json/GsonJsonObjectReader.java | 14 +- .../item/json/JacksonJsonObjectReader.java | 14 +- .../batch/item/json/JsonFileItemWriter.java | 4 +- .../batch/item/json/JsonItemReader.java | 12 +- .../batch/item/json/JsonObjectReader.java | 6 +- .../builder/JsonFileItemWriterBuilder.java | 15 +- .../json/builder/JsonItemReaderBuilder.java | 20 +- .../batch/item/json/builder/package-info.java | 5 +- .../batch/item/json/package-info.java | 5 +- .../batch/item/kafka/KafkaItemReader.java | 15 +- .../batch/item/kafka/KafkaItemWriter.java | 8 +- .../kafka/builder/KafkaItemReaderBuilder.java | 17 +- .../kafka/builder/KafkaItemWriterBuilder.java | 5 +- .../item/kafka/builder/package-info.java | 4 +- .../batch/item/kafka/package-info.java | 4 +- .../batch/item/ldif/LdifReader.java | 13 +- .../batch/item/ldif/MappingLdifReader.java | 15 +- .../batch/item/ldif/RecordMapper.java | 6 +- .../item/ldif/builder/LdifReaderBuilder.java | 11 +- .../builder/MappingLdifReaderBuilder.java | 13 +- .../batch/item/ldif/builder/package-info.java | 5 +- .../batch/item/ldif/package-info.java | 5 +- .../mail/SimpleMailMessageItemWriter.java | 4 +- .../SimpleMailMessageItemWriterBuilder.java | 8 +- .../batch/item/mail/builder/package-info.java | 5 +- .../mail/javamail/MimeMessageItemWriter.java | 4 +- .../item/mail/javamail/package-info.java | 5 +- .../batch/item/mail/package-info.java | 5 +- .../batch/item/package-info.java | 4 +- .../item/queue/BlockingQueueItemReader.java | 2 +- .../batch/item/redis/RedisItemReader.java | 8 +- .../batch/item/redis/RedisItemWriter.java | 5 +- .../batch/item/redis/package-info.java | 25 ++ .../item/support/AbstractFileItemWriter.java | 25 +- ...tractItemCountingItemStreamItemReader.java | 9 +- .../ClassifierCompositeItemProcessor.java | 8 +- .../item/support/CompositeItemProcessor.java | 12 +- .../item/support/CompositeItemReader.java | 6 +- .../item/support/CompositeItemWriter.java | 7 +- .../item/support/IteratorItemReader.java | 6 +- .../batch/item/support/ListItemReader.java | 6 +- .../support/PassThroughItemProcessor.java | 6 +- .../item/support/ScriptItemProcessor.java | 34 ++- .../support/SingleItemPeekableItemReader.java | 18 +- .../item/support/SynchronizedItemReader.java | 6 +- .../support/SynchronizedItemStreamReader.java | 14 +- .../support/SynchronizedItemStreamWriter.java | 7 +- ...assifierCompositeItemProcessorBuilder.java | 3 +- .../ClassifierCompositeItemWriterBuilder.java | 3 +- .../CompositeItemProcessorBuilder.java | 3 +- .../builder/CompositeItemWriterBuilder.java | 3 +- .../builder/ScriptItemProcessorBuilder.java | 10 +- .../SingleItemPeekableItemReaderBuilder.java | 3 +- .../SynchronizedItemReaderBuilder.java | 3 +- .../SynchronizedItemStreamReaderBuilder.java | 3 +- .../SynchronizedItemStreamWriterBuilder.java | 3 +- .../SynchronizedItemWriterBuilder.java | 3 +- .../item/support/builder/package-info.java | 4 +- .../batch/item/support/package-info.java | 4 +- .../util/ExecutionContextUserSupport.java | 6 +- .../batch/item/util/package-info.java | 5 +- .../batch/item/validator/SpringValidator.java | 8 +- .../validator/ValidatingItemProcessor.java | 9 +- .../batch/item/validator/package-info.java | 4 +- .../batch/item/xml/StaxEventItemReader.java | 28 ++- .../batch/item/xml/StaxEventItemWriter.java | 43 ++-- .../builder/StaxEventItemReaderBuilder.java | 28 ++- .../builder/StaxEventItemWriterBuilder.java | 39 ++-- .../batch/item/xml/builder/package-info.java | 5 +- .../batch/item/xml/package-info.java | 4 +- .../xml/stax/AbstractEventReaderWrapper.java | 4 +- .../xml/stax/DefaultFragmentEventReader.java | 6 +- .../batch/item/xml/stax/package-info.java | 5 +- .../springframework/batch/package-info.java | 4 +- .../batch/poller/DirectPoller.java | 6 +- .../batch/poller/package-info.java | 4 +- .../batch/repeat/RepeatContext.java | 5 +- .../batch/repeat/callback/package-info.java | 4 +- .../repeat/context/RepeatContextCounter.java | 58 ++--- .../repeat/context/RepeatContextSupport.java | 3 +- .../SynchronizedAttributeAccessor.java | 12 +- .../batch/repeat/context/package-info.java | 4 +- .../SimpleLimitExceptionHandler.java | 2 +- .../batch/repeat/exception/package-info.java | 4 +- .../RepeatOperationsInterceptor.java | 13 +- .../repeat/interceptor/package-info.java | 4 +- .../batch/repeat/listener/package-info.java | 4 +- .../batch/repeat/package-info.java | 4 +- .../batch/repeat/policy/package-info.java | 4 +- .../batch/repeat/support/RepeatTemplate.java | 41 ++-- .../batch/repeat/support/ResultHolder.java | 5 +- .../support/TaskExecutorRepeatTemplate.java | 19 +- .../batch/repeat/support/package-info.java | 4 +- .../support/AnnotationMethodResolver.java | 9 +- .../batch/support/DatabaseType.java | 26 +-- .../DefaultPropertyEditorRegistrar.java | 12 +- .../batch/support/MethodInvoker.java | 5 +- .../batch/support/MethodInvokerUtils.java | 52 ++--- .../batch/support/MethodResolver.java | 8 +- .../batch/support/PropertiesConverter.java | 6 +- .../batch/support/SimpleMethodInvoker.java | 28 ++- .../batch/support/package-info.java | 4 +- .../ResourcelessTransactionManager.java | 3 + .../TransactionAwareBufferedWriter.java | 3 +- .../TransactionAwareProxyFactory.java | 3 +- .../support/transaction/package-info.java | 4 +- .../jms/BatchMessageListenerContainer.java | 2 +- .../support/AvroItemWriterTestSupport.java | 14 +- ...bstractPagingItemReaderParameterTests.java | 8 +- ...dbcBatchItemWriterNamedParameterTests.java | 3 +- .../JdbcPagingItemReaderCommonTests.java | 4 + .../JdbcPagingItemReaderIntegrationTests.java | 20 +- .../JdbcPagingQueryIntegrationTests.java | 3 +- .../orm/JpaNamedQueryProviderTests.java | 4 +- .../support/SqlPagingQueryUtilsTests.java | 5 +- .../item/file/FlatFileItemReaderTests.java | 3 +- .../item/file/FlatFileItemWriterTests.java | 2 +- ...ltiResourceItemReaderIntegrationTests.java | 6 +- .../MultiResourceItemWriterFlatFileTests.java | 3 +- .../BeanWrapperFieldSetMapperTests.java | 9 +- .../file/transform/DefaultFieldSetTests.java | 2 +- .../function/SupplierItemReaderTests.java | 3 +- .../batch/item/json/JsonItemReaderTests.java | 5 +- .../batch/item/sample/FooService.java | 4 +- ...ClassifierCompositeItemProcessorTests.java | 22 +- ...ItemCountingItemStreamItemReaderTests.java | 5 +- .../SingleItemPeekableItemReaderTests.java | 5 +- .../item/xml/StaxEventItemReaderTests.java | 5 +- .../batch/poller/DirectPollerTests.java | 2 +- .../RepeatOperationsInterceptorTests.java | 3 +- .../repeat/support/ChunkedRepeatTests.java | 5 +- .../support/ResultHolderResultQueueTests.java | 3 +- .../ConcurrentTransactionAwareProxyTests.java | 12 +- 255 files changed, 1856 insertions(+), 1543 deletions(-) create mode 100644 spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/package-info.java create mode 100644 spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/package-info.java create mode 100644 spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/package-info.java diff --git a/pom.xml b/pom.xml index 06b2eb92d1..9ee51be285 100644 --- a/pom.xml +++ b/pom.xml @@ -148,7 +148,8 @@ 3.7.1 3.4.2 0.0.47 - 2.41.0 + 2.42.0 + 0.12.10 @@ -180,6 +181,14 @@ --should-stop=ifError=FLOW -Xplugin:ErrorProne + + -Xep:NullAway:ERROR + -XepOpt:NullAway:OnlyNullMarked + + -XepOpt:NullAway:CustomContractAnnotations=org.springframework.lang.Contract + -XepOpt:NullAway:SuppressionNameAliases=DataFlowIssue + + -XepExcludedPaths:.*/src/test/java/.* @@ -188,6 +197,11 @@ error_prone_core ${error-prone.version} + + com.uber.nullaway + nullaway + ${nullaway.version} + diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/Chunk.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/Chunk.java index 42c0b6bb82..4d2789424a 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/Chunk.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/Chunk.java @@ -16,6 +16,8 @@ package org.springframework.batch.item; +import org.jspecify.annotations.Nullable; + import java.io.Serializable; import java.util.ArrayList; import java.util.Arrays; @@ -34,6 +36,7 @@ * @author Dave Syer * @author Mahmoud Ben Hassine * @author Jinwoo Bae + * @author Stefano Cordio * @since 2.0 */ public class Chunk implements Iterable, Serializable { @@ -44,7 +47,7 @@ public class Chunk implements Iterable, Serializable { private final List errors = new ArrayList<>(); - private Object userData; + private @Nullable Object userData; private boolean end; @@ -65,8 +68,7 @@ public Chunk(List items) { } @Deprecated(since = "6.0", forRemoval = true) - public Chunk(List items, List> skips) { - super(); + public Chunk(@Nullable List items, @Nullable List> skips) { if (items != null) { this.items.addAll(items); } @@ -218,7 +220,7 @@ public void clearSkips() { } @Deprecated(since = "6.0", forRemoval = true) - public Object getUserData() { + public @Nullable Object getUserData() { return userData; } @@ -266,9 +268,9 @@ public int hashCode() { */ public class ChunkIterator implements Iterator { - final private Iterator iterator; + private final Iterator iterator; - private W next; + private @Nullable W next; public ChunkIterator(List items) { iterator = items.iterator(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ExecutionContext.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ExecutionContext.java index 8f000c4656..66ff7d881d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ExecutionContext.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ExecutionContext.java @@ -23,7 +23,7 @@ import java.util.Set; import java.util.concurrent.ConcurrentHashMap; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Object representing a context for an {@link ItemStream}. It is a thin wrapper for a map @@ -254,8 +254,7 @@ public double getDouble(String key, double defaultDouble) { * @return The value represented by the given key or {@code null} if the key is not * present */ - @Nullable - public Object get(String key) { + public @Nullable Object get(String key) { return this.map.get(key); } @@ -269,8 +268,7 @@ public Object get(String key) { * key is not present * @since 5.1 */ - @Nullable - public V get(String key, Class type) { + public @Nullable V get(String key, Class type) { Object value = this.map.get(key); if (value == null) { return null; @@ -289,8 +287,7 @@ public V get(String key, Class type) { * if the key is not present * @since 5.1 */ - @Nullable - public V get(String key, Class type, @Nullable V defaultValue) { + public @Nullable V get(String key, Class type, @Nullable V defaultValue) { Object value = this.map.get(key); if (value == null) { return defaultValue; @@ -373,8 +370,7 @@ public boolean containsKey(String key) { * * @see java.util.Map#remove(Object) */ - @Nullable - public Object remove(String key) { + public @Nullable Object remove(String key) { return this.map.remove(key); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemProcessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemProcessor.java index 83ec8c45b6..a9a3bb975b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemProcessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemProcessor.java @@ -16,8 +16,7 @@ package org.springframework.batch.item; -import org.springframework.lang.NonNull; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Interface for item transformation. Given an item as input, this interface provides an @@ -53,7 +52,6 @@ public interface ItemProcessor { * processing of the provided item should not continue. * @throws Exception thrown if exception occurs during processing. */ - @Nullable - O process(@NonNull I item) throws Exception; + @Nullable O process(I item) throws Exception; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemReader.java index 1bc56ecaaa..a3cab2656e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemReader.java @@ -16,7 +16,7 @@ package org.springframework.batch.item; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Strategy interface for providing the data.
@@ -57,7 +57,6 @@ public interface ItemReader { * @throws Exception if an there is a non-specific error. * @return T the item to be processed or {@code null} if the data source is exhausted */ - @Nullable - T read() throws Exception, UnexpectedInputException, ParseException, NonTransientResourceException; + @Nullable T read() throws Exception, UnexpectedInputException, ParseException, NonTransientResourceException; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemStreamException.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemStreamException.java index ef0e5af611..0dc3d7a72d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemStreamException.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemStreamException.java @@ -15,12 +15,15 @@ */ package org.springframework.batch.item; +import org.jspecify.annotations.Nullable; + /** * Exception representing any errors encountered while processing a stream. * * @author Dave Syer * @author Lucas Ward * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public class ItemStreamException extends RuntimeException { @@ -33,11 +36,10 @@ public ItemStreamException(String message) { /** * Constructs a new instance with a message and nested exception. - * @param msg the exception message. + * @param msg the exception message (can be {@code null}). * @param nested the cause of the exception. - * */ - public ItemStreamException(String msg, Throwable nested) { + public ItemStreamException(@Nullable String msg, Throwable nested) { super(msg, nested); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemStreamSupport.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemStreamSupport.java index 86446bc0ca..b3d246c9d6 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemStreamSupport.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemStreamSupport.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.item; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.util.ExecutionContextUserSupport; /** @@ -23,6 +24,7 @@ * @author Dave Syer * @author Dean de Bree * @author Mahmoud Ben Hassine + * @author Stefano Cordio * */ public abstract class ItemStreamSupport implements ItemStream { @@ -43,7 +45,7 @@ public void setName(String name) { * Get the name of the component * @return the name of the component */ - public String getName() { + public @Nullable String getName() { return executionContextUserSupport.getName(); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemWriter.java index 674153ea17..76edb408b3 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ItemWriter.java @@ -16,8 +16,6 @@ package org.springframework.batch.item; -import org.springframework.lang.NonNull; - /** *

* Basic interface for generic output operations. Class implementing this interface will @@ -48,6 +46,6 @@ public interface ItemWriter { * @throws Exception if there are errors. The framework will catch the exception and * convert or rethrow it as appropriate. */ - void write(@NonNull Chunk chunk) throws Exception; + void write(Chunk chunk) throws Exception; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/KeyValueItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/KeyValueItemWriter.java index 6354fb1358..fdbc445c78 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/KeyValueItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/KeyValueItemWriter.java @@ -12,6 +12,7 @@ */ package org.springframework.batch.item; +import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.InitializingBean; import org.springframework.core.convert.converter.Converter; import org.springframework.util.Assert; @@ -22,21 +23,20 @@ * * @author David Turanski * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 2.2 * */ public abstract class KeyValueItemWriter implements ItemWriter, InitializingBean { - protected Converter itemKeyMapper; + protected @Nullable Converter itemKeyMapper; protected boolean delete; @Override - public void write(Chunk items) throws Exception { - if (items == null) { - return; - } - for (V item : items) { + public void write(Chunk chunk) throws Exception { + for (V item : chunk) { + @SuppressWarnings("DataFlowIssue") K key = itemKeyMapper.convert(item); writeKeyValue(key, item); } @@ -55,7 +55,7 @@ protected void flush() throws Exception { * @param key the key * @param value the item */ - protected abstract void writeKeyValue(K key, V value); + protected abstract void writeKeyValue(@Nullable K key, V value); /** * afterPropertiesSet() hook diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/PeekableItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/PeekableItemReader.java index 4bf053738a..088c6688b0 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/PeekableItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/PeekableItemReader.java @@ -15,7 +15,7 @@ */ package org.springframework.batch.item; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** *

@@ -45,7 +45,6 @@ public interface PeekableItemReader extends ItemReader { * @return the next item or {@code null} if the data source is exhausted * @throws Exception if there is a problem */ - @Nullable - T peek() throws Exception, UnexpectedInputException, ParseException; + @Nullable T peek() throws Exception, UnexpectedInputException, ParseException; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/SkipWrapper.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/SkipWrapper.java index fe94f012e4..ea3673c884 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/SkipWrapper.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/SkipWrapper.java @@ -16,21 +16,22 @@ package org.springframework.batch.item; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Wrapper for an item and its exception if it failed processing. * * @author Dave Syer * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @deprecated since 6.0 with no replacement. Scheduled for removal in 7.0. */ @Deprecated(since = "6.0", forRemoval = true) public class SkipWrapper { - final private Throwable exception; + private final @Nullable Throwable exception; - final private T item; + private final @Nullable T item; /** * @param item the item being wrapped. @@ -39,7 +40,7 @@ public SkipWrapper(T item) { this(item, null); } - public SkipWrapper(T item, @Nullable Throwable e) { + public SkipWrapper(@Nullable T item, @Nullable Throwable e) { this.item = item; this.exception = e; } @@ -48,8 +49,7 @@ public SkipWrapper(T item, @Nullable Throwable e) { * Public getter for the exception. * @return the exception */ - @Nullable - public Throwable getException() { + public @Nullable Throwable getException() { return exception; } @@ -57,7 +57,7 @@ public Throwable getException() { * Public getter for the item. * @return the item */ - public T getItem() { + public @Nullable T getItem() { return item; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/SpELItemKeyMapper.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/SpELItemKeyMapper.java index 13c4f49539..ac4a802ca1 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/SpELItemKeyMapper.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/SpELItemKeyMapper.java @@ -12,30 +12,29 @@ */ package org.springframework.batch.item; +import org.jspecify.annotations.Nullable; import org.springframework.core.convert.converter.Converter; import org.springframework.expression.Expression; -import org.springframework.expression.ExpressionParser; import org.springframework.expression.spel.standard.SpelExpressionParser; /** * An implementation of {@link Converter} that uses SpEL to map a Value to a key * * @author David Turanski + * @author Stefano Cordio * @since 2.2 */ public class SpELItemKeyMapper implements Converter { - private final ExpressionParser parser = new SpelExpressionParser(); - private final Expression parsedExpression; public SpELItemKeyMapper(String keyExpression) { - parsedExpression = parser.parseExpression(keyExpression); + parsedExpression = new SpelExpressionParser().parseExpression(keyExpression); } @SuppressWarnings("unchecked") @Override - public K convert(V item) { + public @Nullable K convert(V item) { return (K) parsedExpression.getValue(item); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/AbstractMethodInvokingDelegator.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/AbstractMethodInvokingDelegator.java index 4a0665ab12..f214c76c64 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/AbstractMethodInvokingDelegator.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/AbstractMethodInvokingDelegator.java @@ -22,6 +22,7 @@ import java.util.Arrays; import java.util.List; +import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.InitializingBean; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -41,21 +42,22 @@ * @author Robert Kasanicky * @author Mahmoud Ben Hassine * @author Glenn Renfro + * @author Stefano Cordio */ public abstract class AbstractMethodInvokingDelegator implements InitializingBean { - private Object targetObject; + private @Nullable Object targetObject; - private String targetMethod; + private @Nullable String targetMethod; - private Object[] arguments; + private @Nullable Object @Nullable [] arguments; /** * Invoker the target method with arguments set by {@link #setArguments(Object[])}. * @return object returned by invoked method * @throws Exception exception thrown when executing the delegate method. */ - protected T invokeDelegateMethod() throws Exception { + protected @Nullable T invokeDelegateMethod() throws Exception { MethodInvoker invoker = createMethodInvoker(targetObject, targetMethod); invoker.setArguments(arguments); return doInvoke(invoker); @@ -67,7 +69,7 @@ protected T invokeDelegateMethod() throws Exception { * @return object returned by target method * @throws Exception exception thrown when executing the delegate method. */ - protected T invokeDelegateMethodWithArgument(Object object) throws Exception { + protected @Nullable T invokeDelegateMethodWithArgument(Object object) throws Exception { MethodInvoker invoker = createMethodInvoker(targetObject, targetMethod); invoker.setArguments(object); return doInvoke(invoker); @@ -79,7 +81,7 @@ protected T invokeDelegateMethodWithArgument(Object object) throws Exception { * @return object returned by invoked method * @throws Exception exception thrown when executing the delegate method. */ - protected T invokeDelegateMethodWithArguments(Object[] args) throws Exception { + protected @Nullable T invokeDelegateMethodWithArguments(@Nullable Object[] args) throws Exception { MethodInvoker invoker = createMethodInvoker(targetObject, targetMethod); invoker.setArguments(args); return doInvoke(invoker); @@ -88,7 +90,7 @@ protected T invokeDelegateMethodWithArguments(Object[] args) throws Exception { /** * Create a new configured instance of {@link MethodInvoker}. */ - private MethodInvoker createMethodInvoker(Object targetObject, String targetMethod) { + private MethodInvoker createMethodInvoker(@Nullable Object targetObject, @Nullable String targetMethod) { HippyMethodInvoker invoker = new HippyMethodInvoker(); invoker.setTargetObject(targetObject); invoker.setTargetMethod(targetMethod); @@ -102,7 +104,7 @@ private MethodInvoker createMethodInvoker(Object targetObject, String targetMeth * @return return value of the invoked method */ @SuppressWarnings("unchecked") - private T doInvoke(MethodInvoker invoker) throws Exception { + private @Nullable T doInvoke(MethodInvoker invoker) throws Exception { try { invoker.prepare(); } @@ -141,6 +143,7 @@ public void afterPropertiesSet() throws Exception { private boolean targetClassDeclaresTargetMethod() { MethodInvoker invoker = createMethodInvoker(targetObject, targetMethod); + @SuppressWarnings("DataFlowIssue") Method[] memberMethods = invoker.getTargetClass().getMethods(); Method[] declaredMethods = invoker.getTargetClass().getDeclaredMethods(); @@ -200,11 +203,11 @@ public void setTargetMethod(String targetMethod) { * providing explicit argument values. *

* If arguments are set to not-null value {@link #afterPropertiesSet()} will check the - * values are compatible with target method's signature. In case arguments are null - * (not set) method signature will not be checked and it is assumed correct values - * will be supplied at runtime. + * values are compatible with target method's signature. In case arguments are + * {@code null} (not set), the method signature will not be checked, and it is assumed + * correct values will be supplied at runtime. */ - public void setArguments(Object[] arguments) { + public void setArguments(Object @Nullable [] arguments) { this.arguments = arguments == null ? null : arguments.clone(); } @@ -212,7 +215,7 @@ public void setArguments(Object[] arguments) { * Return arguments. * @return arguments */ - protected Object[] getArguments() { + protected @Nullable Object @Nullable [] getArguments() { return arguments; } @@ -220,7 +223,7 @@ protected Object[] getArguments() { * @return the object on which the method will be invoked. * @since 5.1 */ - protected Object getTargetObject() { + protected @Nullable Object getTargetObject() { return targetObject; } @@ -228,7 +231,7 @@ protected Object getTargetObject() { * @return the name of the method to be invoked. * @since 5.1 */ - protected String getTargetMethod() { + protected @Nullable String getTargetMethod() { return targetMethod; } @@ -240,7 +243,7 @@ protected String getTargetMethod() { */ public static class InvocationTargetThrowableWrapper extends RuntimeException { - public InvocationTargetThrowableWrapper(Throwable cause) { + public InvocationTargetThrowableWrapper(@Nullable Throwable cause) { super(cause); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/HippyMethodInvoker.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/HippyMethodInvoker.java index 452c60ddcf..8673a916b5 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/HippyMethodInvoker.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/HippyMethodInvoker.java @@ -17,14 +17,16 @@ import java.lang.reflect.Method; +import org.jspecify.annotations.Nullable; +import org.springframework.util.Assert; import org.springframework.util.ClassUtils; import org.springframework.util.MethodInvoker; import org.springframework.util.ReflectionUtils; /** * A {@link MethodInvoker} that is a bit relaxed about its arguments. You can give it - * arguments in the wrong order or you can give it too many arguments and it will try and - * find a method that matches a subset. + * arguments in the wrong order, or you can give it too many arguments, and it will try + * and find a method that matches a subset. * * @author Dave Syer * @since 2.1 @@ -32,20 +34,23 @@ public class HippyMethodInvoker extends MethodInvoker { @Override - protected Method findMatchingMethod() { + protected @Nullable Method findMatchingMethod() { String targetMethod = getTargetMethod(); - Object[] arguments = getArguments(); - Method[] candidates = ReflectionUtils.getAllDeclaredMethods(getTargetClass()); + @Nullable Object[] arguments = getArguments(); + + Class targetClass = getTargetClass(); + Assert.state(targetClass != null, "No target class set"); + Method[] candidates = ReflectionUtils.getAllDeclaredMethods(targetClass); int minTypeDiffWeight = Integer.MAX_VALUE; Method matchingMethod = null; - Object[] transformedArguments = null; + @Nullable Object[] transformedArguments = null; for (Method candidate : candidates) { if (candidate.getName().equals(targetMethod)) { Class[] paramTypes = candidate.getParameterTypes(); - Object[] candidateArguments = new Object[paramTypes.length]; + @Nullable Object[] candidateArguments = new Object[paramTypes.length]; int assignedParameterCount = 0; for (Object argument : arguments) { for (int i = 0; i < paramTypes.length; i++) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/ItemProcessorAdapter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/ItemProcessorAdapter.java index 1a640383c7..3d58930164 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/ItemProcessorAdapter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/ItemProcessorAdapter.java @@ -16,8 +16,9 @@ package org.springframework.batch.item.adapter; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; /** * Invokes a custom method on a delegate plain old Java object which itself processes an @@ -32,9 +33,8 @@ public class ItemProcessorAdapter extends AbstractMethodInvokingDelegator< * * @see ItemProcessor#process(Object) */ - @Nullable @Override - public O process(I item) throws Exception { + public @Nullable O process(I item) throws Exception { return invokeDelegateMethodWithArgument(item); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/ItemReaderAdapter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/ItemReaderAdapter.java index 862d793d21..6d7e70bfce 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/ItemReaderAdapter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/ItemReaderAdapter.java @@ -16,8 +16,9 @@ package org.springframework.batch.item.adapter; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemReader; -import org.springframework.lang.Nullable; /** * Invokes a custom method on a delegate plain old Java object which itself provides an @@ -35,9 +36,8 @@ public class ItemReaderAdapter extends AbstractMethodInvokingDelegator imp /** * @return return value of the target method. */ - @Nullable @Override - public T read() throws Exception { + public @Nullable T read() throws Exception { return invokeDelegateMethod(); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/PropertyExtractingDelegatingItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/PropertyExtractingDelegatingItemWriter.java index 545d44e888..1e01fb29ea 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/PropertyExtractingDelegatingItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/PropertyExtractingDelegatingItemWriter.java @@ -16,6 +16,8 @@ package org.springframework.batch.item.adapter; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemWriter; import org.springframework.beans.BeanWrapper; @@ -39,12 +41,13 @@ public class PropertyExtractingDelegatingItemWriter extends AbstractMethodInvokingDelegator implements ItemWriter { - private String[] fieldsUsedAsTargetMethodArguments; + private @Nullable String @Nullable [] fieldsUsedAsTargetMethodArguments; /** * Extracts values from item's fields named in fieldsUsedAsTargetMethodArguments and * passes them as arguments to the delegate method. */ + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk items) throws Exception { for (T item : items) { @@ -52,7 +55,8 @@ public void write(Chunk items) throws Exception { // helper for extracting property values from a bean BeanWrapper beanWrapper = new BeanWrapperImpl(item); - Object[] methodArguments = new Object[fieldsUsedAsTargetMethodArguments.length]; + @Nullable Object[] methodArguments = new Object[fieldsUsedAsTargetMethodArguments.length]; + for (int i = 0; i < fieldsUsedAsTargetMethodArguments.length; i++) { methodArguments[i] = beanWrapper.getPropertyValue(fieldsUsedAsTargetMethodArguments[i]); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/package-info.java index db2847283f..cc768b5f1e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/package-info.java @@ -3,7 +3,7 @@ * Adapters for Plain Old Java Objects. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.adapter; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/AmqpItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/AmqpItemReader.java index 8e1e4a654c..b1a33a0182 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/AmqpItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/AmqpItemReader.java @@ -16,10 +16,11 @@ package org.springframework.batch.item.amqp; +import org.jspecify.annotations.Nullable; + import org.springframework.amqp.core.AmqpTemplate; import org.springframework.amqp.core.Message; import org.springframework.batch.item.ItemReader; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -35,27 +36,27 @@ * * @author Chris Schaefer * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public class AmqpItemReader implements ItemReader { private final AmqpTemplate amqpTemplate; - private Class itemType; + private @Nullable Class itemType; /** * Initialize the AmqpItemReader. * @param amqpTemplate the template to be used. Must not be null. */ - public AmqpItemReader(final AmqpTemplate amqpTemplate) { + public AmqpItemReader(AmqpTemplate amqpTemplate) { Assert.notNull(amqpTemplate, "AmqpTemplate must not be null"); this.amqpTemplate = amqpTemplate; } - @Nullable @Override @SuppressWarnings("unchecked") - public T read() { + public @Nullable T read() { if (itemType != null && itemType.isAssignableFrom(Message.class)) { return (T) amqpTemplate.receive(); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/AmqpItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/AmqpItemWriter.java index c825635cf8..1e591d7ee9 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/AmqpItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/AmqpItemWriter.java @@ -45,14 +45,14 @@ public class AmqpItemWriter implements ItemWriter { private final Log log = LogFactory.getLog(getClass()); - public AmqpItemWriter(final AmqpTemplate amqpTemplate) { + public AmqpItemWriter(AmqpTemplate amqpTemplate) { Assert.notNull(amqpTemplate, "AmqpTemplate must not be null"); this.amqpTemplate = amqpTemplate; } @Override - public void write(final Chunk items) throws Exception { + public void write(Chunk items) throws Exception { if (log.isDebugEnabled()) { log.debug("Writing to AMQP with " + items.size() + " items."); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/AmqpItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/AmqpItemReaderBuilder.java index 6f1619ad79..03eda92a92 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/AmqpItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/AmqpItemReaderBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.amqp.builder; +import org.jspecify.annotations.Nullable; import org.springframework.amqp.core.AmqpTemplate; import org.springframework.batch.item.amqp.AmqpItemReader; import org.springframework.util.Assert; @@ -24,14 +25,15 @@ * A builder implementation for the {@link AmqpItemReader} * * @author Glenn Renfro + * @author Stefano Cordio * @since 4.0 * @see AmqpItemReader */ public class AmqpItemReaderBuilder { - private AmqpTemplate amqpTemplate; + private @Nullable AmqpTemplate amqpTemplate; - private Class itemType; + private @Nullable Class itemType; /** * Establish the amqpTemplate to be used by the AmqpItemReader. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/AmqpItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/AmqpItemWriterBuilder.java index 979a6ad993..a349a54a8e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/AmqpItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/AmqpItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.amqp.builder; +import org.jspecify.annotations.Nullable; import org.springframework.amqp.core.AmqpTemplate; import org.springframework.batch.item.amqp.AmqpItemWriter; import org.springframework.util.Assert; @@ -24,12 +25,13 @@ * A builder implementation for the {@link AmqpItemWriter} * * @author Glenn Renfro + * @author Stefano Cordio * @since 4.0 * @see AmqpItemWriter */ public class AmqpItemWriterBuilder { - private AmqpTemplate amqpTemplate; + private @Nullable AmqpTemplate amqpTemplate; /** * Establish the amqpTemplate to be used by the AmqpItemWriter. @@ -50,9 +52,7 @@ public AmqpItemWriterBuilder amqpTemplate(AmqpTemplate amqpTemplate) { public AmqpItemWriter build() { Assert.notNull(this.amqpTemplate, "amqpTemplate is required."); - AmqpItemWriter writer = new AmqpItemWriter<>(this.amqpTemplate); - - return writer; + return new AmqpItemWriter<>(this.amqpTemplate); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/package-info.java index 250e32146f..573347cc1f 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/builder/package-info.java @@ -1,5 +1,5 @@ /* - * Copyright 2018 the original author or authors. + * Copyright 2018-2025 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. @@ -18,9 +18,9 @@ * Builders for AMQP item reader and writer. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ - -@NonNullApi +@NullMarked package org.springframework.batch.item.amqp.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/package-info.java index aa419383c0..8724014cca 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/amqp/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.amqp; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/AvroItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/AvroItemReader.java index ab39d81571..34cc2cb45f 100755 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/AvroItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/AvroItemReader.java @@ -28,12 +28,12 @@ import org.apache.avro.reflect.ReflectDatumReader; import org.apache.avro.specific.SpecificDatumReader; import org.apache.avro.specific.SpecificRecordBase; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ItemStreamException; import org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -54,9 +54,9 @@ public class AvroItemReader extends AbstractItemCountingItemStreamItemReader< private boolean embeddedSchema = true; - private InputStreamReader inputStreamReader; + private @Nullable InputStreamReader inputStreamReader; - private DataFileStream dataFileReader; + private @Nullable DataFileStream dataFileReader; private final InputStream inputStream; @@ -104,15 +104,16 @@ public AvroItemReader(Resource data, Resource schema) { /** * Disable or enable reading an embedded Avro schema. True by default. - * @param embeddedSchema set to false to if the input does not embed an Avro schema. + * @param embeddedSchema set to {@code false} if the input does not embed an Avro + * schema. */ public void setEmbeddedSchema(boolean embeddedSchema) { this.embeddedSchema = embeddedSchema; } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { if (this.inputStreamReader != null) { return this.inputStreamReader.read(); } @@ -124,6 +125,7 @@ protected void doOpen() throws Exception { initializeReader(); } + @SuppressWarnings("DataFlowIssue") @Override protected void doClose() throws Exception { if (this.inputStreamReader != null) { @@ -171,7 +173,7 @@ private InputStreamReader(InputStream inputStream, DatumReader datumReader) { this.binaryDecoder = DecoderFactory.get().binaryDecoder(inputStream, null); } - private T read() throws Exception { + private @Nullable T read() throws Exception { if (!this.binaryDecoder.isEnd()) { return this.datumReader.read(null, this.binaryDecoder); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/AvroItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/AvroItemWriter.java index 99a63b04bf..0ebbee5b2c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/AvroItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/AvroItemWriter.java @@ -30,6 +30,7 @@ import org.apache.avro.specific.SpecificDatumWriter; import org.apache.avro.specific.SpecificRecordBase; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamException; @@ -54,13 +55,13 @@ */ public class AvroItemWriter extends AbstractItemStreamItemWriter { - private DataFileWriter dataFileWriter; + private @Nullable DataFileWriter dataFileWriter; - private OutputStreamWriter outputStreamWriter; + private @Nullable OutputStreamWriter outputStreamWriter; private final WritableResource resource; - private final Resource schemaResource; + private final @Nullable Resource schemaResource; private final Class clazz; @@ -71,7 +72,7 @@ public class AvroItemWriter extends AbstractItemStreamItemWriter { * @param schema a {@link Resource} containing the Avro schema. * @param clazz the data type to be serialized. */ - public AvroItemWriter(WritableResource resource, Resource schema, Class clazz) { + public AvroItemWriter(WritableResource resource, @Nullable Resource schema, Class clazz) { this.schemaResource = schema; this.resource = resource; this.clazz = clazz; @@ -87,6 +88,7 @@ public AvroItemWriter(WritableResource resource, Class clazz) { embedSchema = false; } + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk items) throws Exception { items.forEach(item -> { @@ -118,6 +120,7 @@ public void open(ExecutionContext executionContext) { } } + @SuppressWarnings("DataFlowIssue") @Override public void close() { try { @@ -155,7 +158,6 @@ private void initializeWriter() throws IOException { this.outputStreamWriter = createOutputStreamWriter(this.resource.getOutputStream(), datumWriterForClass(this.clazz)); } - } private static DatumWriter datumWriterForClass(Class clazz) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/AvroItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/AvroItemReaderBuilder.java index c9803e2590..eab6ee661e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/AvroItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/AvroItemReaderBuilder.java @@ -18,6 +18,7 @@ import org.apache.avro.Schema; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.avro.AvroItemReader; import org.springframework.core.io.ByteArrayResource; import org.springframework.core.io.Resource; @@ -29,6 +30,7 @@ * * @author David Turanski * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 4.2 */ public class AvroItemReaderBuilder { @@ -41,11 +43,11 @@ public class AvroItemReaderBuilder { private int currentItemCount; - private Resource schema; + private @Nullable Resource schema; - private Resource resource; + private @Nullable Resource resource; - private Class type; + private @Nullable Class type; private boolean embeddedSchema = true; @@ -162,10 +164,12 @@ public AvroItemReader build() { Assert.notNull(this.resource, "A 'resource' is required."); if (this.type != null) { - avroItemReader = buildForType(); + Assert.isNull(this.schema, "You cannot specify a schema and 'type'."); + avroItemReader = new AvroItemReader<>(this.resource, this.type); } else { - avroItemReader = buildForSchema(); + Assert.notNull(this.schema, "'schema' is required."); + avroItemReader = new AvroItemReader<>(this.resource, this.schema); } avroItemReader.setSaveState(this.saveState); @@ -182,14 +186,4 @@ public AvroItemReader build() { return avroItemReader; } - private AvroItemReader buildForType() { - Assert.isNull(this.schema, "You cannot specify a schema and 'type'."); - return new AvroItemReader<>(this.resource, this.type); - } - - private AvroItemReader buildForSchema() { - Assert.notNull(this.schema, "'schema' is required."); - return new AvroItemReader<>(this.resource, this.schema); - } - } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/AvroItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/AvroItemWriterBuilder.java index 69c9eb85cc..7bd72ba3c8 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/AvroItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/AvroItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.avro.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.avro.AvroItemWriter; import org.springframework.core.io.ByteArrayResource; import org.springframework.core.io.Resource; @@ -27,15 +28,16 @@ * * @author David Turanski * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 4.2 */ public class AvroItemWriterBuilder { - private Class type; + private @Nullable Class type; - private WritableResource resource; + private @Nullable WritableResource resource; - private Resource schema; + private @Nullable Resource schema; private String name = AvroItemWriter.class.getSimpleName(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/package-info.java new file mode 100644 index 0000000000..a24fd63cab --- /dev/null +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/builder/package-info.java @@ -0,0 +1,25 @@ +/* + * Copyright 2025 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. + */ + +/** + * Builders for Avro item reader and writer. + * + * @author Stefano Cordio + */ +@NullMarked +package org.springframework.batch.item.avro.builder; + +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/package-info.java new file mode 100644 index 0000000000..78781b2c36 --- /dev/null +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/avro/package-info.java @@ -0,0 +1,9 @@ +/** + * Avro related reader and writer. + * + * @author Stefano Cordio + */ +@NullMarked +package org.springframework.batch.item.avro; + +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/AbstractPaginatedDataItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/AbstractPaginatedDataItemReader.java index 043e54b7ba..eca601e1ad 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/AbstractPaginatedDataItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/AbstractPaginatedDataItemReader.java @@ -18,13 +18,14 @@ import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ItemStreamReader; import org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import java.util.Iterator; import java.util.concurrent.locks.Lock; import java.util.concurrent.locks.ReentrantLock; +import org.jspecify.annotations.Nullable; + /** * A base class that handles basic reading logic based on the paginated semantics of * Spring Data's paginated facilities. It also handles the semantics required for @@ -35,6 +36,7 @@ * @author Michael Minella * @author Glenn Renfro * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 2.2 * @param Type of item to be read */ @@ -44,7 +46,7 @@ public abstract class AbstractPaginatedDataItemReader extends AbstractItemCou protected int pageSize = 10; - protected Iterator results; + protected @Nullable Iterator results; private final Lock lock = new ReentrantLock(); @@ -57,9 +59,8 @@ public void setPageSize(int pageSize) { this.pageSize = pageSize; } - @Nullable @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { this.lock.lock(); try { @@ -69,17 +70,12 @@ protected T doRead() throws Exception { page++; - if (results == null || !results.hasNext()) { + if (!results.hasNext()) { return null; } } - if (results.hasNext()) { - return results.next(); - } - else { - return null; - } + return results.next(); } finally { this.lock.unlock(); @@ -91,8 +87,8 @@ protected T doRead() throws Exception { * page. Each time this method is called, the resulting {@link Iterator} should * contain the items read within the next page.
*
- * If the {@link Iterator} is empty or null when it is returned, this - * {@link ItemReader} will assume that the input has been exhausted. + * If the {@link Iterator} is empty when it is returned, this {@link ItemReader} will + * assume that the input has been exhausted. * @return an {@link Iterator} containing the items within a page. */ protected abstract Iterator doPageRead(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoCursorItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoCursorItemReader.java index 1759557d61..535c157f2b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoCursorItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoCursorItemReader.java @@ -25,6 +25,7 @@ import org.bson.Document; import org.bson.codecs.DecoderContext; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader; import org.springframework.beans.factory.InitializingBean; @@ -48,37 +49,36 @@ */ public class MongoCursorItemReader extends AbstractItemCountingItemStreamItemReader implements InitializingBean { - private MongoOperations template; + private @Nullable MongoOperations template; - private Class targetType; + private @Nullable Class targetType; - private String collection; + private @Nullable String collection; - private Query query; + private @Nullable Query query; - private String queryString; + private @Nullable String queryString; private List parameterValues = new ArrayList<>(); - private String fields; + private @Nullable String fields; - private Sort sort; + private @Nullable Sort sort; - private String hint; + private @Nullable String hint; private int batchSize; private int limit; - private Duration maxTime; + private @Nullable Duration maxTime; - private CloseableIterator cursor; + private @Nullable CloseableIterator cursor; /** * Create a new {@link MongoCursorItemReader}. */ public MongoCursorItemReader() { - super(); setName(ClassUtils.getShortName(MongoCursorItemReader.class)); } @@ -206,15 +206,10 @@ public void afterPropertiesSet() { } } + @SuppressWarnings("DataFlowIssue") @Override protected void doOpen() throws Exception { - Query mongoQuery; - if (queryString != null) { - mongoQuery = createQuery(); - } - else { - mongoQuery = query; - } + Query mongoQuery = queryString != null ? createQuery() : query; Stream stream; if (StringUtils.hasText(collection)) { @@ -227,27 +222,8 @@ protected void doOpen() throws Exception { this.cursor = streamToIterator(stream); } - @Override - protected T doRead() throws Exception { - return cursor.hasNext() ? cursor.next() : null; - } - - @Override - protected void doClose() throws Exception { - this.cursor.close(); - } - - private Sort convertToSort(Map sorts) { - List sortValues = new ArrayList<>(sorts.size()); - - for (Map.Entry curSort : sorts.entrySet()) { - sortValues.add(new Sort.Order(curSort.getValue(), curSort.getKey())); - } - - return Sort.by(sortValues); - } - private Query createQuery() { + @SuppressWarnings("DataFlowIssue") String populatedQuery = replacePlaceholders(queryString, parameterValues); Query mongoQuery; @@ -276,6 +252,28 @@ private Query createQuery() { return mongoQuery; } + @SuppressWarnings("DataFlowIssue") + @Override + protected T doRead() throws Exception { + return cursor.hasNext() ? cursor.next() : null; + } + + @SuppressWarnings("DataFlowIssue") + @Override + protected void doClose() throws Exception { + this.cursor.close(); + } + + private Sort convertToSort(Map sorts) { + List sortValues = new ArrayList<>(sorts.size()); + + for (Map.Entry curSort : sorts.entrySet()) { + sortValues.add(new Sort.Order(curSort.getValue(), curSort.getKey())); + } + + return Sort.by(sortValues); + } + private String replacePlaceholders(String input, List values) { ParameterBindingJsonReader reader = new ParameterBindingJsonReader(input, values.toArray()); DecoderContext decoderContext = DecoderContext.builder().build(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoItemWriter.java index 7018ee6244..64bfd8c5e7 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoItemWriter.java @@ -22,6 +22,7 @@ import org.bson.Document; import org.bson.types.ObjectId; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemWriter; @@ -33,7 +34,6 @@ import org.springframework.data.mongodb.core.convert.MongoConverter; import org.springframework.data.mongodb.core.query.Criteria; import org.springframework.data.mongodb.core.query.Query; -import org.springframework.lang.Nullable; import org.springframework.transaction.support.TransactionSynchronization; import org.springframework.transaction.support.TransactionSynchronizationManager; import org.springframework.util.Assert; @@ -57,6 +57,7 @@ * @author Michael Minella * @author Parikshit Dutta * @author Mahmoud Ben Hassine + * @author Stefano Cordio * */ public class MongoItemWriter implements ItemWriter, InitializingBean { @@ -88,11 +89,11 @@ public enum Mode { private static final String ID_KEY = "_id"; - private MongoOperations template; + private @Nullable MongoOperations template; private final Object bufferKey; - private String collection; + private @Nullable String collection; private Mode mode = Mode.UPSERT; @@ -109,7 +110,7 @@ public MongoItemWriter() { * @param mode the mode to be used. * @since 5.1 */ - public void setMode(final Mode mode) { + public void setMode(Mode mode) { this.mode = mode; } @@ -135,7 +136,7 @@ public void setTemplate(MongoOperations template) { * called by a subclass if necessary. * @return template the template implementation to be used. */ - protected MongoOperations getTemplate() { + protected @Nullable MongoOperations getTemplate() { return template; } @@ -143,7 +144,7 @@ protected MongoOperations getTemplate() { * Set the name of the Mongo collection to be written to. * @param collection the name of the collection. */ - public void setCollection(String collection) { + public void setCollection(@Nullable String collection) { this.collection = collection; } @@ -152,7 +153,7 @@ public void setCollection(String collection) { * @return the collection name * @since 5.1 */ - public String getCollection() { + public @Nullable String getCollection() { return collection; } @@ -192,7 +193,9 @@ public void write(Chunk chunk) throws Exception { } Chunk bufferedItems = getCurrentBuffer(); - bufferedItems.addAll(chunk.getItems()); + if (bufferedItems != null) { + bufferedItems.addAll(chunk.getItems()); + } } /** @@ -210,11 +213,12 @@ protected void doWrite(Chunk chunk) { } } - private void insert(final Chunk chunk) { - final BulkOperations bulkOperations = initBulkOperations(BulkMode.ORDERED, chunk.getItems().get(0)); - final MongoConverter mongoConverter = this.template.getConverter(); - for (final Object item : chunk) { - final Document document = new Document(); + private void insert(Chunk chunk) { + BulkOperations bulkOperations = initBulkOperations(chunk.getItems().get(0)); + @SuppressWarnings("DataFlowIssue") + MongoConverter mongoConverter = this.template.getConverter(); + for (Object item : chunk) { + Document document = new Document(); mongoConverter.write(item, document); bulkOperations.insert(document); } @@ -222,7 +226,8 @@ private void insert(final Chunk chunk) { } private void remove(Chunk chunk) { - BulkOperations bulkOperations = initBulkOperations(BulkMode.ORDERED, chunk.getItems().get(0)); + BulkOperations bulkOperations = initBulkOperations(chunk.getItems().get(0)); + @SuppressWarnings("DataFlowIssue") MongoConverter mongoConverter = this.template.getConverter(); for (Object item : chunk) { Document document = new Document(); @@ -242,7 +247,8 @@ private void remove(Chunk chunk) { } private void upsert(Chunk chunk) { - BulkOperations bulkOperations = initBulkOperations(BulkMode.ORDERED, chunk.getItems().get(0)); + BulkOperations bulkOperations = initBulkOperations(chunk.getItems().get(0)); + @SuppressWarnings("DataFlowIssue") MongoConverter mongoConverter = this.template.getConverter(); FindAndReplaceOptions upsert = new FindAndReplaceOptions().upsert(); for (Object item : chunk) { @@ -268,15 +274,11 @@ private void upsert(Chunk chunk) { bulkOperations.execute(); } - private BulkOperations initBulkOperations(BulkMode bulkMode, Object item) { - BulkOperations bulkOperations; - if (StringUtils.hasText(this.collection)) { - bulkOperations = this.template.bulkOps(bulkMode, this.collection); - } - else { - bulkOperations = this.template.bulkOps(bulkMode, ClassUtils.getUserClass(item)); - } - return bulkOperations; + @SuppressWarnings("DataFlowIssue") + private BulkOperations initBulkOperations(Object item) { + return StringUtils.hasText(this.collection) // + ? this.template.bulkOps(BulkMode.ORDERED, this.collection) + : this.template.bulkOps(BulkMode.ORDERED, ClassUtils.getUserClass(item)); } private boolean transactionActive() { @@ -284,8 +286,7 @@ private boolean transactionActive() { } @SuppressWarnings("unchecked") - @Nullable - private Chunk getCurrentBuffer() { + private @Nullable Chunk getCurrentBuffer() { if (!TransactionSynchronizationManager.hasResource(bufferKey)) { TransactionSynchronizationManager.bindResource(bufferKey, new Chunk()); @@ -294,7 +295,7 @@ private Chunk getCurrentBuffer() { public void beforeCommit(boolean readOnly) { Chunk chunk = (Chunk) TransactionSynchronizationManager.getResource(bufferKey); - if (!chunk.isEmpty()) { + if (chunk != null && !chunk.isEmpty()) { if (!readOnly) { doWrite(chunk); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoPagingItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoPagingItemReader.java index e9e8ff83d0..e2a342d81b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoPagingItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoPagingItemReader.java @@ -22,6 +22,7 @@ import org.bson.Document; import org.bson.codecs.DecoderContext; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemReader; import org.springframework.beans.factory.InitializingBean; @@ -80,26 +81,25 @@ */ public class MongoPagingItemReader extends AbstractPaginatedDataItemReader implements InitializingBean { - protected MongoOperations template; + protected @Nullable MongoOperations template; - protected Query query; + protected @Nullable Query query; - protected String queryString; + protected @Nullable String queryString; - protected Class type; + protected @Nullable Class type; - protected Sort sort; + protected @Nullable Sort sort; - protected String hint; + protected @Nullable String hint; - protected String fields; + protected @Nullable String fields; - protected String collection; + protected @Nullable String collection; protected List parameterValues = new ArrayList<>(); public MongoPagingItemReader() { - super(); setName(ClassUtils.getShortName(MongoPagingItemReader.class)); } @@ -183,8 +183,8 @@ public void setHint(String hint) { this.hint = hint; } + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) @Override - @SuppressWarnings("unchecked") protected Iterator doPageRead() { if (queryString != null) { Pageable pageRequest = PageRequest.of(page, pageSize, sort); @@ -206,24 +206,18 @@ protected Iterator doPageRead() { mongoQuery.withHint(hint); } - if (StringUtils.hasText(collection)) { - return (Iterator) template.find(mongoQuery, type, collection).iterator(); - } - else { - return (Iterator) template.find(mongoQuery, type).iterator(); - } + return StringUtils.hasText(collection) // + ? (Iterator) template.find(mongoQuery, type, collection).iterator() + : (Iterator) template.find(mongoQuery, type).iterator(); } else { Pageable pageRequest = PageRequest.of(page, pageSize); query.with(pageRequest); - if (StringUtils.hasText(collection)) { - return (Iterator) template.find(query, type, collection).iterator(); - } - else { - return (Iterator) template.find(query, type).iterator(); - } + return StringUtils.hasText(collection) // + ? (Iterator) template.find(query, type, collection).iterator() + : (Iterator) template.find(query, type).iterator(); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java index 2e12b299c0..1a0c0852a2 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java @@ -24,6 +24,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.adapter.AbstractMethodInvokingDelegator.InvocationTargetThrowableWrapper; @@ -35,7 +36,6 @@ import org.springframework.data.domain.Slice; import org.springframework.data.domain.Sort; import org.springframework.data.repository.PagingAndSortingRepository; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; import org.springframework.util.MethodInvoker; @@ -85,9 +85,9 @@ public class RepositoryItemReader extends AbstractItemCountingItemStreamItemR protected Log logger = LogFactory.getLog(getClass()); - private PagingAndSortingRepository repository; + private @Nullable PagingAndSortingRepository repository; - private Sort sort; + private @Nullable Sort sort; private volatile int page = 0; @@ -95,13 +95,13 @@ public class RepositoryItemReader extends AbstractItemCountingItemStreamItemR private volatile int current = 0; - private List arguments; + private @Nullable List arguments; - private volatile List results; + private volatile @Nullable List results; private final Lock lock = new ReentrantLock(); - private String methodName; + private @Nullable String methodName; public RepositoryItemReader() { setName(ClassUtils.getShortName(RepositoryItemReader.class)); @@ -160,9 +160,8 @@ public void afterPropertiesSet() throws Exception { } } - @Nullable @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { this.lock.lock(); try { @@ -221,8 +220,10 @@ protected void jumpToItem(int itemLastIndex) throws Exception { */ @SuppressWarnings("unchecked") protected List doPageRead() throws Exception { + @SuppressWarnings("DataFlowIssue") Pageable pageRequest = PageRequest.of(page, pageSize, sort); + @SuppressWarnings("DataFlowIssue") MethodInvoker invoker = createMethodInvoker(repository, methodName); List parameters = new ArrayList<>(); @@ -267,6 +268,7 @@ private Sort convertToSort(Map sorts) { return Sort.by(sortValues); } + @SuppressWarnings("DataFlowIssue") private Object doInvoke(MethodInvoker invoker) throws Exception { try { invoker.prepare(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemWriter.java index 996bdf5fd3..e62fb103b7 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemWriter.java @@ -20,6 +20,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemWriter; import org.springframework.batch.item.adapter.AbstractMethodInvokingDelegator.InvocationTargetThrowableWrapper; @@ -63,9 +64,9 @@ public class RepositoryItemWriter implements ItemWriter, InitializingBean protected static final Log logger = LogFactory.getLog(RepositoryItemWriter.class); - private CrudRepository repository; + private @Nullable CrudRepository repository; - private String methodName; + private @Nullable String methodName; /** * Specifies what method on the repository to call. This method must have the type of @@ -103,6 +104,7 @@ public void write(Chunk chunk) throws Exception { * @param items the list of items to be persisted. * @throws Exception thrown if error occurs during writing. */ + @SuppressWarnings("DataFlowIssue") protected void doWrite(Chunk items) throws Exception { if (logger.isDebugEnabled()) { logger.debug("Writing to the repository with " + items.size() + " items."); @@ -135,7 +137,7 @@ public void afterPropertiesSet() throws Exception { } } - private Object doInvoke(MethodInvoker invoker) throws Exception { + private void doInvoke(MethodInvoker invoker) throws Exception { try { invoker.prepare(); } @@ -144,7 +146,7 @@ private Object doInvoke(MethodInvoker invoker) throws Exception { } try { - return invoker.invoke(); + invoker.invoke(); } catch (InvocationTargetException e) { if (e.getCause() instanceof Exception) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoCursorItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoCursorItemReaderBuilder.java index b7c09835b7..667a5d8dd8 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoCursorItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoCursorItemReaderBuilder.java @@ -21,6 +21,7 @@ import java.util.List; import java.util.Map; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.data.MongoCursorItemReader; import org.springframework.data.domain.Sort; import org.springframework.data.mongodb.core.MongoOperations; @@ -31,6 +32,7 @@ /** * @author LEE Juchan * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 5.1 * @see MongoCursorItemReader */ @@ -38,35 +40,35 @@ public class MongoCursorItemReaderBuilder { private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; private int currentItemCount; - private MongoOperations template; + private @Nullable MongoOperations template; - private Class targetType; + private @Nullable Class targetType; - private String collection; + private @Nullable String collection; - private Query query; + private @Nullable Query query; - private String jsonQuery; + private @Nullable String jsonQuery; private List parameterValues = new ArrayList<>(); - private String fields; + private @Nullable String fields; - private Map sorts; + private @Nullable Map sorts; - private String hint; + private @Nullable String hint; private int batchSize; private int limit; - private Duration maxTime; + private @Nullable Duration maxTime; /** * Configure if the state of the @@ -279,26 +281,35 @@ public MongoCursorItemReader build() { } Assert.notNull(this.targetType, "targetType is required."); Assert.state(StringUtils.hasText(this.jsonQuery) || this.query != null, "A query is required"); - - if (StringUtils.hasText(this.jsonQuery) || this.query != null) { - Assert.notNull(this.sorts, "sorts map is required."); - } + Assert.notNull(this.sorts, "sorts map is required."); MongoCursorItemReader reader = new MongoCursorItemReader<>(); reader.setSaveState(this.saveState); - reader.setName(this.name); + if (this.name != null) { + reader.setName(this.name); + } reader.setCurrentItemCount(this.currentItemCount); reader.setMaxItemCount(this.maxItemCount); reader.setTemplate(this.template); reader.setTargetType(this.targetType); - reader.setCollection(this.collection); - reader.setQuery(this.query); - reader.setQuery(this.jsonQuery); + if (this.collection != null) { + reader.setCollection(this.collection); + } + if (this.query != null) { + reader.setQuery(this.query); + } + if (StringUtils.hasText(this.jsonQuery)) { + reader.setQuery(this.jsonQuery); + } reader.setParameterValues(this.parameterValues); - reader.setFields(this.fields); + if (this.fields != null) { + reader.setFields(this.fields); + } reader.setSort(this.sorts); - reader.setHint(this.hint); + if (this.hint != null) { + reader.setHint(this.hint); + } reader.setBatchSize(this.batchSize); reader.setLimit(this.limit); if (this.maxTime != null) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoItemWriterBuilder.java index 27f6f6b080..7a5ce18ffd 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoItemWriterBuilder.java @@ -18,6 +18,7 @@ import java.util.List; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.data.MongoItemWriter; import org.springframework.batch.item.data.MongoItemWriter.Mode; import org.springframework.data.mongodb.core.MongoOperations; @@ -33,9 +34,9 @@ */ public class MongoItemWriterBuilder { - private MongoOperations template; + private @Nullable MongoOperations template; - private String collection; + private @Nullable String collection; private Mode mode = Mode.UPSERT; @@ -49,7 +50,7 @@ public class MongoItemWriterBuilder { * @see MongoItemWriter#setMode(Mode) * @since 5.1 */ - public MongoItemWriterBuilder mode(final Mode mode) { + public MongoItemWriterBuilder mode(Mode mode) { this.mode = mode; return this; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoPagingItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoPagingItemReaderBuilder.java index 480b3a7c92..21cdc9c6cc 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoPagingItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoPagingItemReaderBuilder.java @@ -20,6 +20,7 @@ import java.util.List; import java.util.Map; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.data.MongoPagingItemReader; import org.springframework.data.domain.Sort; import org.springframework.data.mongodb.core.MongoOperations; @@ -35,23 +36,24 @@ * @author Mahmoud Ben Hassine * @author Drummond Dawson * @author Parikshit Dutta + * @author Stefano Cordio * @since 5.1 */ public class MongoPagingItemReaderBuilder { - protected MongoOperations template; + protected @Nullable MongoOperations template; - protected String jsonQuery; + protected @Nullable String jsonQuery; - protected Class targetType; + protected @Nullable Class targetType; - protected Map sorts; + protected @Nullable Map sorts; - protected String hint; + protected @Nullable String hint; - protected String fields; + protected @Nullable String fields; - protected String collection; + protected @Nullable String collection; protected List parameterValues = new ArrayList<>(); @@ -59,13 +61,13 @@ public class MongoPagingItemReaderBuilder { protected boolean saveState = true; - protected String name; + protected @Nullable String name; protected int maxItemCount = Integer.MAX_VALUE; protected int currentItemCount; - protected Query query; + protected @Nullable Query query; /** * Configure if the state of the @@ -272,16 +274,30 @@ public MongoPagingItemReader build() { MongoPagingItemReader reader = new MongoPagingItemReader<>(); reader.setTemplate(this.template); reader.setTargetType(this.targetType); - reader.setQuery(this.jsonQuery); - reader.setSort(this.sorts); - reader.setHint(this.hint); - reader.setFields(this.fields); - reader.setCollection(this.collection); + if (StringUtils.hasText(this.jsonQuery)) { + reader.setQuery(this.jsonQuery); + } + if (this.sorts != null) { + reader.setSort(this.sorts); + } + if (this.hint != null) { + reader.setHint(this.hint); + } + if (this.fields != null) { + reader.setFields(this.fields); + } + if (this.collection != null) { + reader.setCollection(this.collection); + } reader.setParameterValues(this.parameterValues); - reader.setQuery(this.query); + if (this.query != null) { + reader.setQuery(this.query); + } reader.setPageSize(this.pageSize); - reader.setName(this.name); + if (this.name != null) { + reader.setName(this.name); + } reader.setSaveState(this.saveState); reader.setCurrentItemCount(this.currentItemCount); reader.setMaxItemCount(this.maxItemCount); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/RepositoryItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/RepositoryItemReaderBuilder.java index 8b51679673..27b052403b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/RepositoryItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/RepositoryItemReaderBuilder.java @@ -20,6 +20,7 @@ import java.util.List; import java.util.Map; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.data.RepositoryItemReader; import org.springframework.data.domain.Sort; import org.springframework.data.repository.PagingAndSortingRepository; @@ -37,19 +38,19 @@ */ public class RepositoryItemReaderBuilder { - private PagingAndSortingRepository repository; + private @Nullable PagingAndSortingRepository repository; - private Map sorts; + private @Nullable Map sorts; - private List arguments; + private @Nullable List arguments; private int pageSize = 10; - private String methodName; + private @Nullable String methodName; private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; @@ -194,7 +195,9 @@ public RepositoryItemReader build() { } RepositoryItemReader reader = new RepositoryItemReader<>(); - reader.setArguments(this.arguments); + if (this.arguments != null) { + reader.setArguments(this.arguments); + } reader.setRepository(this.repository); reader.setMethodName(this.methodName); reader.setPageSize(this.pageSize); @@ -202,7 +205,9 @@ public RepositoryItemReader build() { reader.setMaxItemCount(this.maxItemCount); reader.setSaveState(this.saveState); reader.setSort(this.sorts); - reader.setName(this.name); + if (this.name != null) { + reader.setName(this.name); + } return reader; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/RepositoryItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/RepositoryItemWriterBuilder.java index ed7fbe229e..fd231b500b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/RepositoryItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/RepositoryItemWriterBuilder.java @@ -20,6 +20,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.data.RepositoryItemWriter; import org.springframework.cglib.proxy.Enhancer; @@ -40,11 +41,11 @@ public class RepositoryItemWriterBuilder { private static final Log logger = LogFactory.getLog(RepositoryItemWriterBuilder.class.getName()); - private CrudRepository repository; + private @Nullable CrudRepository repository; - private String methodName; + private @Nullable String methodName; - private RepositoryMethodReference repositoryMethodReference; + private @Nullable RepositoryMethodReference repositoryMethodReference; /** * Specifies what method on the repository to call. This method must have the type of @@ -121,27 +122,26 @@ public RepositoryItemWriter build() { } /** - * Establishes a proxy that will capture a the Repository and the associated - * methodName that will be used by the writer. + * Establishes a proxy that will capture the Repository and the associated methodName + * that will be used by the writer. * * @param The type of repository that will be used by the writer. The class must * not be final. */ public static class RepositoryMethodReference { - private final RepositoryMethodInterceptor repositoryInvocationHandler; + private final RepositoryMethodInterceptor repositoryInvocationHandler = new RepositoryMethodInterceptor(); private final CrudRepository repository; public RepositoryMethodReference(CrudRepository repository) { this.repository = repository; - this.repositoryInvocationHandler = new RepositoryMethodInterceptor(); } /** - * The proxy returned prevents actual method execution and is only used to gather, + * The proxy returned prevents actual method execution and is only used to gather * information about the method. - * @return T is a proxy of the object passed in in the constructor + * @return T a proxy of the object passed in the constructor */ @SuppressWarnings("unchecked") public T methodIs() { @@ -155,6 +155,7 @@ public T methodIs() { return this.repository; } + @SuppressWarnings("DataFlowIssue") String getMethodName() { return this.repositoryInvocationHandler.getMethodName(); } @@ -163,15 +164,15 @@ String getMethodName() { private static class RepositoryMethodInterceptor implements MethodInterceptor { - private String methodName; + private @Nullable String methodName; @Override - public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable { + public @Nullable Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) { this.methodName = method.getName(); return null; } - String getMethodName() { + @Nullable String getMethodName() { return this.methodName; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/package-info.java index d1aa6bacce..56bc198dba 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/package-info.java @@ -18,8 +18,9 @@ * Builders for Spring Data item readers and writers. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.data.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/package-info.java index b4029d2f33..baa1352fea 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.data; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractCursorItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractCursorItemReader.java index 534339748d..d820ca4151 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractCursorItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractCursorItemReader.java @@ -27,6 +27,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStream; import org.springframework.batch.item.ReaderNotOpenException; @@ -42,7 +44,6 @@ import org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator; import org.springframework.jdbc.support.SQLExceptionTranslator; import org.springframework.jdbc.support.SQLStateSQLExceptionTranslator; -import org.springframework.lang.Nullable; import org.springframework.transaction.support.TransactionSynchronizationManager; import org.springframework.util.Assert; @@ -53,10 +54,10 @@ *

* *

- * By default the cursor will be opened using a separate connection. The ResultSet for the - * cursor is held open regardless of commits or roll backs in a surrounding transaction. - * Clients of this reader are responsible for buffering the items in the case that they - * need to be re-presented on a rollback. This buffering is handled by the step + * By default, the cursor will be opened using a separate connection. The ResultSet for + * the cursor is held open regardless of commits or rollbacks in a surrounding + * transaction. Clients of this reader are responsible for buffering the items in the case + * that they need to be re-presented on a rollback. This buffering is handled by the step * implementations provided and is only a concern for anyone writing their own step * implementations. *

@@ -111,6 +112,7 @@ * @author Thomas Risberg * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public abstract class AbstractCursorItemReader extends AbstractItemCountingItemStreamItemReader implements InitializingBean { @@ -120,11 +122,11 @@ public abstract class AbstractCursorItemReader extends AbstractItemCountingIt public static final int VALUE_NOT_SET = -1; - private Connection con; + private @Nullable Connection con; - protected ResultSet rs; + protected @Nullable ResultSet rs; - private DataSource dataSource; + private @Nullable DataSource dataSource; private int fetchSize = VALUE_NOT_SET; @@ -136,7 +138,7 @@ public abstract class AbstractCursorItemReader extends AbstractItemCountingIt private boolean verifyCursorPosition = true; - private SQLExceptionTranslator exceptionTranslator; + private @Nullable SQLExceptionTranslator exceptionTranslator; private boolean initialized = false; @@ -144,14 +146,10 @@ public abstract class AbstractCursorItemReader extends AbstractItemCountingIt private boolean useSharedExtendedConnection = false; - private Boolean connectionAutoCommit; + private @Nullable Boolean connectionAutoCommit; private boolean initialConnectionAutoCommit; - public AbstractCursorItemReader() { - super(); - } - /** * Assert that mandatory properties are set. * @throws IllegalArgumentException if either data source or SQL properties not set. @@ -173,7 +171,7 @@ public void setDataSource(DataSource dataSource) { * Public getter for the data source. * @return the dataSource */ - public DataSource getDataSource() { + public @Nullable DataSource getDataSource() { return this.dataSource; } @@ -261,6 +259,7 @@ protected void handleWarnings(Statement statement) throws SQLWarningException, S * traversing the ResultSet. * @param row The index of the row to move to */ + @SuppressWarnings("DataFlowIssue") private void moveCursorToRow(int row) { try { int count = 0; @@ -377,6 +376,7 @@ public void setConnectionAutoCommit(boolean autoCommit) { * Check the result set is in sync with the currentRow attribute. This is important to * ensure that the user hasn't modified the current row. */ + @SuppressWarnings("DataFlowIssue") private void verifyCursorPosition(long expectedCurrentRow) throws SQLException { if (verifyCursorPosition) { if (expectedCurrentRow != this.rs.getRow()) { @@ -389,6 +389,7 @@ private void verifyCursorPosition(long expectedCurrentRow) throws SQLException { * Close the cursor and database connection. Make call to cleanupOnClose so sub * classes can cleanup any resources they have allocated. */ + @SuppressWarnings("DataFlowIssue") @Override protected void doClose() throws Exception { initialized = false; @@ -421,18 +422,18 @@ protected void doClose() throws Exception { /** * Execute the statement to open the cursor. */ + @SuppressWarnings("DataFlowIssue") @Override protected void doOpen() throws Exception { - Assert.state(!initialized, "Stream is already initialized. Close before re-opening."); Assert.isNull(rs, "ResultSet still open! Close before re-opening."); initializeConnection(); openCursor(con); initialized = true; - } + @SuppressWarnings("DataFlowIssue") protected void initializeConnection() { Assert.state(getDataSource() != null, "DataSource must not be null."); @@ -468,9 +469,8 @@ protected void initializeConnection() { * Read next row and map it to item, verify cursor position if * {@link #setVerifyCursorPosition(boolean)} is true. */ - @Nullable @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { if (rs == null) { throw new ReaderNotOpenException("Reader must be open before it can be read."); } @@ -497,13 +497,13 @@ protected T doRead() throws Exception { * @return the mapped object at the cursor position * @throws SQLException if interactions with the current result set fail */ - @Nullable - protected abstract T readCursor(ResultSet rs, int currentRow) throws SQLException; + protected abstract @Nullable T readCursor(ResultSet rs, int currentRow) throws SQLException; /** * Use {@link ResultSet#absolute(int)} if possible, otherwise scroll by calling * {@link ResultSet#next()}. */ + @SuppressWarnings("DataFlowIssue") @Override protected void jumpToItem(int itemIndex) throws Exception { if (driverSupportsAbsolute) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractPagingItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractPagingItemReader.java index e66dc2bc28..060aa5b9eb 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractPagingItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractPagingItemReader.java @@ -21,9 +21,10 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -43,6 +44,7 @@ * @author Thomas Risberg * @author Dave Syer * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 2.0 */ public abstract class AbstractPagingItemReader extends AbstractItemCountingItemStreamItemReader @@ -58,7 +60,7 @@ public abstract class AbstractPagingItemReader extends AbstractItemCountingIt private volatile int page = 0; - protected volatile List results; + protected volatile @Nullable List results; private final Lock lock = new ReentrantLock(); @@ -99,9 +101,9 @@ public void afterPropertiesSet() throws Exception { Assert.state(pageSize > 0, "pageSize must be greater than zero"); } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { this.lock.lock(); try { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/ExtendedConnectionDataSourceProxy.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/ExtendedConnectionDataSourceProxy.java index fad274bcfc..b85b5e2b37 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/ExtendedConnectionDataSourceProxy.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/ExtendedConnectionDataSourceProxy.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2023 the original author or authors. + * Copyright 2002-2025 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. @@ -31,12 +31,13 @@ import javax.sql.DataSource; import org.springframework.beans.factory.InitializingBean; + +import org.jspecify.annotations.Nullable; import org.springframework.jdbc.datasource.ConnectionProxy; import org.springframework.jdbc.datasource.DataSourceUtils; import org.springframework.jdbc.datasource.SmartDataSource; import org.springframework.transaction.support.TransactionSynchronizationManager; import org.springframework.util.Assert; -import org.springframework.util.MethodInvoker; /** * Implementation of {@link SmartDataSource} that is capable of keeping a single JDBC @@ -72,23 +73,24 @@ * The connection returned will be a close-suppressing proxy instead of the physical * {@link Connection}. Be aware that you will not be able to cast this to a native * OracleConnection or the like anymore; you'd be required to use - * {@link java.sql.Connection#unwrap(Class)}. + * {@link Connection#unwrap(Class)}. * * @author Thomas Risberg * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @see #getConnection() - * @see java.sql.Connection#close() + * @see Connection#close() * @see DataSourceUtils#releaseConnection - * @see java.sql.Connection#unwrap(Class) + * @see Connection#unwrap(Class) * @since 2.0 */ public class ExtendedConnectionDataSourceProxy implements SmartDataSource, InitializingBean { /** Provided DataSource */ - private DataSource dataSource; + private @Nullable DataSource dataSource; /** The connection to suppress close calls for */ - private Connection closeSuppressedConnection = null; + private @Nullable Connection closeSuppressedConnection; /** The connection to suppress close calls for */ private boolean borrowedConnection = false; @@ -123,11 +125,10 @@ public void setDataSource(DataSource dataSource) { */ @Override public boolean shouldClose(Connection connection) { - boolean shouldClose = !isCloseSuppressionActive(connection); - if (borrowedConnection && closeSuppressedConnection.equals(connection)) { + if (borrowedConnection && isCloseSuppressionActive(connection)) { borrowedConnection = false; } - return shouldClose; + return !isCloseSuppressionActive(connection); } /** @@ -138,7 +139,7 @@ public boolean shouldClose(Connection connection) { * @return true or false */ public boolean isCloseSuppressionActive(Connection connection) { - return connection != null && connection.equals(closeSuppressedConnection); + return connection.equals(closeSuppressedConnection); } /** @@ -194,14 +195,8 @@ public Connection getConnection(String username, String password) throws SQLExce } } - private boolean completeCloseCall(Connection connection) { - if (borrowedConnection && closeSuppressedConnection.equals(connection)) { - borrowedConnection = false; - } - return isCloseSuppressionActive(connection); - } - - private Connection initConnection(String username, String password) throws SQLException { + @SuppressWarnings("DataFlowIssue") + private Connection initConnection(@Nullable String username, @Nullable String password) throws SQLException { if (closeSuppressedConnection != null) { if (!borrowedConnection) { borrowedConnection = true; @@ -219,21 +214,25 @@ private Connection initConnection(String username, String password) throws SQLEx return getCloseSuppressingConnectionProxy(target); } + @SuppressWarnings("DataFlowIssue") @Override public PrintWriter getLogWriter() throws SQLException { return dataSource.getLogWriter(); } + @SuppressWarnings("DataFlowIssue") @Override public int getLoginTimeout() throws SQLException { return dataSource.getLoginTimeout(); } + @SuppressWarnings("DataFlowIssue") @Override public void setLogWriter(PrintWriter out) throws SQLException { dataSource.setLogWriter(out); } + @SuppressWarnings("DataFlowIssue") @Override public void setLoginTimeout(int seconds) throws SQLException { dataSource.setLoginTimeout(seconds); @@ -267,7 +266,7 @@ public CloseSuppressingInvocationHandler(Connection target, ExtendedConnectionDa } @Override - public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + public @Nullable Object invoke(Object proxy, Method method, Object[] args) throws Throwable { // Invocation on ConnectionProxy interface coming in... switch (method.getName()) { @@ -282,13 +281,10 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl case "close" -> { // Handle close method: don't pass the call on if we are // suppressing close calls. - if (dataSource.completeCloseCall((Connection) proxy)) { - return null; - } - else { - target.close(); - return null; + if (dataSource.shouldClose((Connection) proxy)) { + this.target.close(); } + return null; } case "getTargetConnection" -> { // Handle getTargetConnection method: return underlying @@ -312,8 +308,9 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl * Performs only a 'shallow' non-recursive check of self's and delegate's class to * retain Java 5 compatibility. */ + @SuppressWarnings("DataFlowIssue") @Override - public boolean isWrapperFor(Class iface) throws SQLException { + public boolean isWrapperFor(Class iface) { return iface.isAssignableFrom(SmartDataSource.class) || iface.isAssignableFrom(dataSource.getClass()); } @@ -322,6 +319,7 @@ public boolean isWrapperFor(Class iface) throws SQLException { * supplied parameter class. Does *not* support recursive unwrapping of the delegate * to retain Java 5 compatibility. */ + @SuppressWarnings("DataFlowIssue") @Override public T unwrap(Class iface) throws SQLException { if (iface.isAssignableFrom(SmartDataSource.class)) { @@ -342,23 +340,10 @@ public void afterPropertiesSet() throws Exception { Assert.state(dataSource != null, "DataSource is required"); } - /** - * Added due to JDK 7 compatibility. - */ + @SuppressWarnings("DataFlowIssue") @Override public Logger getParentLogger() throws SQLFeatureNotSupportedException { - MethodInvoker invoker = new MethodInvoker(); - invoker.setTargetObject(dataSource); - invoker.setTargetMethod("getParentLogger"); - - try { - invoker.prepare(); - return (Logger) invoker.invoke(); - } - catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException - | InvocationTargetException nsme) { - throw new SQLFeatureNotSupportedException(nsme); - } + return dataSource.getParentLogger(); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcBatchItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcBatchItemWriter.java index be5d04eeb3..70151f55a0 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcBatchItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcBatchItemWriter.java @@ -23,6 +23,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemWriter; import org.springframework.beans.factory.InitializingBean; @@ -58,19 +59,20 @@ * @author Thomas Risberg * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 2.0 */ public class JdbcBatchItemWriter implements ItemWriter, InitializingBean { protected static final Log logger = LogFactory.getLog(JdbcBatchItemWriter.class); - protected NamedParameterJdbcOperations namedParameterJdbcTemplate; + protected @Nullable NamedParameterJdbcOperations namedParameterJdbcTemplate; - protected ItemPreparedStatementSetter itemPreparedStatementSetter; + protected @Nullable ItemPreparedStatementSetter itemPreparedStatementSetter; - protected ItemSqlParameterSourceProvider itemSqlParameterSourceProvider; + protected @Nullable ItemSqlParameterSourceProvider itemSqlParameterSourceProvider; - protected String sql; + protected @Nullable String sql; protected boolean assertUpdates = true; @@ -143,7 +145,7 @@ public void afterPropertiesSet() { Assert.state(sql != null, "An SQL statement is required."); List namedParameters = new ArrayList<>(); parameterCount = JdbcParameterUtils.countParameterPlaceholders(sql, namedParameters); - if (namedParameters.size() > 0) { + if (!namedParameters.isEmpty()) { if (parameterCount != namedParameters.size()) { throw new InvalidDataAccessApiUsageException( "You can't use both named parameters and classic \"?\" placeholders: " + sql); @@ -156,9 +158,9 @@ public void afterPropertiesSet() { } } - @SuppressWarnings("unchecked") + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) @Override - public void write(final Chunk chunk) throws Exception { + public void write(Chunk chunk) throws Exception { if (!chunk.isEmpty()) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcCursorItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcCursorItemReader.java index 3bf215430f..0292046e90 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcCursorItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcCursorItemReader.java @@ -20,11 +20,13 @@ import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; +import java.util.Objects; import org.springframework.jdbc.core.PreparedStatementSetter; + +import org.jspecify.annotations.Nullable; import org.springframework.jdbc.core.RowMapper; import org.springframework.jdbc.support.JdbcUtils; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -37,7 +39,7 @@ *

* The statement used to open the cursor is created with the 'READ_ONLY' option since a * non read-only cursor may unnecessarily lock tables or rows. It is also opened with - * 'TYPE_FORWARD_ONLY' option. By default the cursor will be opened using a separate + * 'TYPE_FORWARD_ONLY' option. By default, the cursor will be opened using a separate * connection which means that it will not participate in any transactions created as part * of the step processing. *

@@ -56,19 +58,19 @@ * @author Robert Kasanicky * @author Thomas Risberg * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public class JdbcCursorItemReader extends AbstractCursorItemReader { - private PreparedStatement preparedStatement; + private @Nullable PreparedStatement preparedStatement; - private PreparedStatementSetter preparedStatementSetter; + private @Nullable PreparedStatementSetter preparedStatementSetter; - private String sql; + private @Nullable String sql; - private RowMapper rowMapper; + private @Nullable RowMapper rowMapper; public JdbcCursorItemReader() { - super(); setName(ClassUtils.getShortName(JdbcCursorItemReader.class)); } @@ -135,9 +137,9 @@ protected void openCursor(Connection con) { } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - protected T readCursor(ResultSet rs, int currentRow) throws SQLException { + protected @Nullable T readCursor(ResultSet rs, int currentRow) throws SQLException { return rowMapper.mapRow(rs, currentRow); } @@ -153,7 +155,7 @@ protected void cleanupOnClose(Connection connection) { @Override public String getSql() { - return this.sql; + return Objects.requireNonNull(this.sql); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcPagingItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcPagingItemReader.java index 547c8e3ff9..8904123335 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcPagingItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcPagingItemReader.java @@ -29,6 +29,7 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamException; import org.springframework.beans.factory.InitializingBean; @@ -49,14 +50,14 @@ * data. The query is executed using paged requests of a size specified in * {@link #setPageSize(int)}. Additional pages are requested when needed as * {@link #read()} method is called, returning an object corresponding to current - * position. On restart it uses the last sort key value to locate the first page to read + * position. On restart, it uses the last sort key value to locate the first page to read * (so it doesn't matter if the successfully processed items have been removed or * modified). It is important to have a unique key constraint on the sort key to guarantee * that no data is lost between executions. *

* *

- * The performance of the paging depends on the database specific features available to + * The performance of the paging depends on the database-specific features available to * limit the number of returned rows. Setting a fairly large page size and using a commit * interval that matches the page size should provide better performance. *

@@ -71,6 +72,7 @@ * @author Dave Syer * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 2.0 */ public class JdbcPagingItemReader extends AbstractPagingItemReader implements InitializingBean { @@ -79,23 +81,23 @@ public class JdbcPagingItemReader extends AbstractPagingItemReader impleme public static final int VALUE_NOT_SET = -1; - private DataSource dataSource; + private @Nullable DataSource dataSource; - private PagingQueryProvider queryProvider; + private @Nullable PagingQueryProvider queryProvider; - private Map parameterValues; + private @Nullable Map parameterValues; - private NamedParameterJdbcTemplate namedParameterJdbcTemplate; + private @Nullable NamedParameterJdbcTemplate namedParameterJdbcTemplate; - private RowMapper rowMapper; + private @Nullable RowMapper rowMapper; - private String firstPageSql; + private @Nullable String firstPageSql; - private String remainingPagesSql; + private @Nullable String remainingPagesSql; - private Map startAfterValues; + private @Nullable Map startAfterValues; - private Map previousStartAfterValues; + private @Nullable Map previousStartAfterValues; private int fetchSize = VALUE_NOT_SET; @@ -168,6 +170,7 @@ public void afterPropertiesSet() throws Exception { this.remainingPagesSql = queryProvider.generateRemainingPagesQuery(getPageSize()); } + @SuppressWarnings("DataFlowIssue") @Override protected void doReadPage() { if (results == null) { @@ -254,7 +257,8 @@ public void open(ExecutionContext executionContext) { super.open(executionContext); } - private Map getParameterMap(Map values, Map sortKeyValues) { + private Map getParameterMap(@Nullable Map values, + @Nullable Map sortKeyValues) { Map parameterMap = new LinkedHashMap<>(); if (values != null) { parameterMap.putAll(values); @@ -270,13 +274,13 @@ private Map getParameterMap(Map values, Map getParameterList(Map values, Map sortKeyValue) { + private List getParameterList(@Nullable Map values, + @Nullable Map sortKeyValue) { SortedMap sm = new TreeMap<>(); if (values != null) { sm.putAll(values); } - List parameterList = new ArrayList<>(); - parameterList.addAll(sm.values()); + List parameterList = new ArrayList<>(sm.values()); if (sortKeyValue != null && !sortKeyValue.isEmpty()) { List> keys = new ArrayList<>(sortKeyValue.entrySet()); @@ -297,8 +301,9 @@ private List getParameterList(Map values, Map { + @SuppressWarnings("DataFlowIssue") @Override - public T mapRow(ResultSet rs, int rowNum) throws SQLException { + public @Nullable T mapRow(ResultSet rs, int rowNum) throws SQLException { startAfterValues = new LinkedHashMap<>(); for (Map.Entry sortKey : queryProvider.getSortKeys().entrySet()) { startAfterValues.put(sortKey.getKey(), rs.getObject(sortKey.getKey())); @@ -309,6 +314,7 @@ public T mapRow(ResultSet rs, int rowNum) throws SQLException { } + @SuppressWarnings("DataFlowIssue") private JdbcTemplate getJdbcTemplate() { return (JdbcTemplate) namedParameterJdbcTemplate.getJdbcOperations(); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaCursorItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaCursorItemReader.java index aafdc63eed..8533cc033e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaCursorItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaCursorItemReader.java @@ -22,6 +22,7 @@ import jakarta.persistence.EntityManagerFactory; import jakarta.persistence.Query; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamException; import org.springframework.batch.item.database.orm.JpaQueryProvider; @@ -44,24 +45,25 @@ * * @author Mahmoud Ben Hassine * @author Jinwoo Bae + * @author Stefano Cordio * @param type of items to read * @since 4.3 */ public class JpaCursorItemReader extends AbstractItemCountingItemStreamItemReader implements InitializingBean { - private EntityManagerFactory entityManagerFactory; + private @Nullable EntityManagerFactory entityManagerFactory; - private EntityManager entityManager; + private @Nullable EntityManager entityManager; - private String queryString; + private @Nullable String queryString; - private JpaQueryProvider queryProvider; + private @Nullable JpaQueryProvider queryProvider; - private Map parameterValues; + private @Nullable Map parameterValues; - private Map hintValues; + private @Nullable Map hintValues; - private Iterator iterator; + private @Nullable Iterator iterator; /** * Create a new {@link JpaCursorItemReader}. @@ -124,7 +126,7 @@ public void afterPropertiesSet() throws Exception { } @Override - @SuppressWarnings("unchecked") + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) protected void doOpen() throws Exception { this.entityManager = this.entityManagerFactory.createEntityManager(); if (this.entityManager == null) { @@ -144,6 +146,7 @@ protected void doOpen() throws Exception { this.iterator = query.getResultStream().iterator(); } + @SuppressWarnings("DataFlowIssue") private Query createQuery() { if (this.queryProvider == null) { return this.entityManager.createQuery(this.queryString); @@ -153,22 +156,23 @@ private Query createQuery() { } } + @SuppressWarnings("DataFlowIssue") @Override - protected T doRead() { + protected @Nullable T doRead() { return this.iterator.hasNext() ? this.iterator.next() : null; } + @SuppressWarnings("DataFlowIssue") @Override public void update(ExecutionContext executionContext) throws ItemStreamException { super.update(executionContext); this.entityManager.clear(); } + @SuppressWarnings("DataFlowIssue") @Override protected void doClose() { - if (this.entityManager != null) { - this.entityManager.close(); - } + this.entityManager.close(); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaItemWriter.java index 7cc9496e08..4076d67113 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaItemWriter.java @@ -22,6 +22,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemWriter; import org.springframework.beans.factory.InitializingBean; @@ -44,13 +45,13 @@ * @author Thomas Risberg * @author Mahmoud Ben Hassine * @author Jinwoo Bae - * + * @author Stefano Cordio */ public class JpaItemWriter implements ItemWriter, InitializingBean { protected static final Log logger = LogFactory.getLog(JpaItemWriter.class); - private EntityManagerFactory entityManagerFactory; + private @Nullable EntityManagerFactory entityManagerFactory; private boolean usePersist = false; @@ -98,6 +99,7 @@ public void afterPropertiesSet() throws Exception { */ @Override public void write(Chunk items) { + @SuppressWarnings("DataFlowIssue") EntityManager entityManager = EntityManagerFactoryUtils.getTransactionalEntityManager(entityManagerFactory); if (entityManager == null) { throw new DataAccessResourceFailureException("Unable to obtain a transactional EntityManager"); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaPagingItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaPagingItemReader.java index d99d3c9245..3ace19d445 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaPagingItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaPagingItemReader.java @@ -26,6 +26,7 @@ import jakarta.persistence.EntityTransaction; import jakarta.persistence.Query; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.database.orm.JpaQueryProvider; import org.springframework.dao.DataAccessResourceFailureException; @@ -85,19 +86,19 @@ */ public class JpaPagingItemReader extends AbstractPagingItemReader { - private EntityManagerFactory entityManagerFactory; + private @Nullable EntityManagerFactory entityManagerFactory; - private EntityManager entityManager; + private @Nullable EntityManager entityManager; private final Map jpaPropertyMap = new HashMap<>(); - private String queryString; + private @Nullable String queryString; - private JpaQueryProvider queryProvider; + private @Nullable JpaQueryProvider queryProvider; - private Map parameterValues; + private @Nullable Map parameterValues; - private Map hintValues; + private @Nullable Map hintValues; private boolean transacted = true;// default value @@ -105,19 +106,6 @@ public JpaPagingItemReader() { setName(ClassUtils.getShortName(JpaPagingItemReader.class)); } - /** - * Create a query using an appropriate query provider (entityManager OR - * queryProvider). - */ - private Query createQuery() { - if (queryProvider == null) { - return entityManager.createQuery(queryString); - } - else { - return queryProvider.createQuery(); - } - } - public void setEntityManagerFactory(EntityManagerFactory entityManagerFactory) { this.entityManagerFactory = entityManagerFactory; } @@ -178,6 +166,7 @@ public void setQueryProvider(JpaQueryProvider queryProvider) { this.queryProvider = queryProvider; } + @SuppressWarnings("DataFlowIssue") @Override protected void doOpen() throws Exception { super.doOpen(); @@ -194,8 +183,8 @@ protected void doOpen() throws Exception { } + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) @Override - @SuppressWarnings("unchecked") protected void doReadPage() { EntityTransaction tx = null; @@ -240,6 +229,21 @@ protected void doReadPage() { } // end if } + /** + * Create a query using an appropriate query provider (entityManager OR + * queryProvider). + */ + @SuppressWarnings("DataFlowIssue") + private Query createQuery() { + if (queryProvider == null) { + return entityManager.createQuery(queryString); + } + else { + return queryProvider.createQuery(); + } + } + + @SuppressWarnings("DataFlowIssue") @Override protected void doClose() throws Exception { entityManager.close(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/StoredProcedureItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/StoredProcedureItemReader.java index 77cc360a6c..68fda8aa78 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/StoredProcedureItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/StoredProcedureItemReader.java @@ -24,12 +24,13 @@ import java.util.Arrays; import org.springframework.jdbc.core.PreparedStatementSetter; + +import org.jspecify.annotations.Nullable; import org.springframework.jdbc.core.RowMapper; import org.springframework.jdbc.core.SqlOutParameter; import org.springframework.jdbc.core.SqlParameter; import org.springframework.jdbc.core.metadata.CallMetaDataContext; import org.springframework.jdbc.support.JdbcUtils; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -64,15 +65,15 @@ */ public class StoredProcedureItemReader extends AbstractCursorItemReader { - private CallableStatement callableStatement; + private @Nullable CallableStatement callableStatement; - private PreparedStatementSetter preparedStatementSetter; + private @Nullable PreparedStatementSetter preparedStatementSetter; - private String procedureName; + private @Nullable String procedureName; - private String callString; + private @Nullable String callString; - private RowMapper rowMapper; + private @Nullable RowMapper rowMapper; private SqlParameter[] parameters = new SqlParameter[0]; @@ -81,7 +82,6 @@ public class StoredProcedureItemReader extends AbstractCursorItemReader { private int refCursorPosition = 0; public StoredProcedureItemReader() { - super(); setName(ClassUtils.getShortName(StoredProcedureItemReader.class)); } @@ -97,10 +97,10 @@ public void setRowMapper(RowMapper rowMapper) { * Set the SQL statement to be used when creating the cursor. This statement should be * a complete and valid SQL statement, as it will be run directly without any * modification. - * @param sprocedureName the SQL used to call the statement + * @param procedureName the SQL used to call the statement */ - public void setProcedureName(String sprocedureName) { - this.procedureName = sprocedureName; + public void setProcedureName(String procedureName) { + this.procedureName = procedureName; } /** @@ -151,6 +151,7 @@ public void afterPropertiesSet() throws Exception { Assert.state(rowMapper != null, "RowMapper must be provided"); } + @SuppressWarnings("DataFlowIssue") @Override protected void openCursor(Connection con) { @@ -228,9 +229,9 @@ protected void openCursor(Connection con) { } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - protected T readCursor(ResultSet rs, int currentRow) throws SQLException { + protected @Nullable T readCursor(ResultSet rs, int currentRow) throws SQLException { return rowMapper.mapRow(rs, currentRow); } @@ -246,12 +247,7 @@ protected void cleanupOnClose(Connection connection) { @Override public String getSql() { - if (callString != null) { - return this.callString; - } - else { - return "PROCEDURE NAME: " + procedureName; - } + return callString != null ? callString : "PROCEDURE NAME: " + procedureName; } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcBatchItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcBatchItemWriterBuilder.java index ab74683bc3..e8abd04b8d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcBatchItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcBatchItemWriterBuilder.java @@ -19,6 +19,7 @@ import java.util.Map; import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.BeanPropertyItemSqlParameterSourceProvider; import org.springframework.batch.item.database.ItemPreparedStatementSetter; import org.springframework.batch.item.database.ItemSqlParameterSourceProvider; @@ -32,6 +33,7 @@ * A builder implementation for the {@link JdbcBatchItemWriter}. * * @author Michael Minella + * @author Stefano Cordio * @since 4.0 * @see JdbcBatchItemWriter */ @@ -39,15 +41,15 @@ public class JdbcBatchItemWriterBuilder { private boolean assertUpdates = true; - private String sql; + private @Nullable String sql; - private ItemPreparedStatementSetter itemPreparedStatementSetter; + private @Nullable ItemPreparedStatementSetter itemPreparedStatementSetter; - private ItemSqlParameterSourceProvider itemSqlParameterSourceProvider; + private @Nullable ItemSqlParameterSourceProvider itemSqlParameterSourceProvider; - private DataSource dataSource; + private @Nullable DataSource dataSource; - private NamedParameterJdbcOperations namedParameterJdbcTemplate; + private @Nullable NamedParameterJdbcOperations namedParameterJdbcTemplate; private BigInteger mapped = new BigInteger("0"); @@ -172,8 +174,12 @@ public JdbcBatchItemWriter build() { JdbcBatchItemWriter writer = new JdbcBatchItemWriter<>(); writer.setSql(this.sql); writer.setAssertUpdates(this.assertUpdates); - writer.setItemSqlParameterSourceProvider(this.itemSqlParameterSourceProvider); - writer.setItemPreparedStatementSetter(this.itemPreparedStatementSetter); + if (this.itemSqlParameterSourceProvider != null) { + writer.setItemSqlParameterSourceProvider(this.itemSqlParameterSourceProvider); + } + if (this.itemPreparedStatementSetter != null) { + writer.setItemPreparedStatementSetter(this.itemPreparedStatementSetter); + } if (mappedValue == 1) { ((JdbcBatchItemWriter>) writer) @@ -187,7 +193,9 @@ else if (mappedValue == 2) { this.namedParameterJdbcTemplate = new NamedParameterJdbcTemplate(this.dataSource); } - writer.setJdbcTemplate(this.namedParameterJdbcTemplate); + if (this.namedParameterJdbcTemplate != null) { + writer.setJdbcTemplate(this.namedParameterJdbcTemplate); + } return writer; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcCursorItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcCursorItemReaderBuilder.java index 48bb8b91b8..6c0ec2509e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcCursorItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcCursorItemReaderBuilder.java @@ -18,6 +18,7 @@ import java.util.List; import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.AbstractCursorItemReader; import org.springframework.batch.item.database.JdbcCursorItemReader; import org.springframework.jdbc.core.ArgumentPreparedStatementSetter; @@ -40,11 +41,12 @@ * @author Parikshit Dutta * @author Fabio Molignoni * @author Juyoung Kim + * @author Stefano Cordio * @since 4.0 */ public class JdbcCursorItemReaderBuilder { - private DataSource dataSource; + private @Nullable DataSource dataSource; private int fetchSize = AbstractCursorItemReader.VALUE_NOT_SET; @@ -60,15 +62,15 @@ public class JdbcCursorItemReaderBuilder { private boolean useSharedExtendedConnection; - private PreparedStatementSetter preparedStatementSetter; + private @Nullable PreparedStatementSetter preparedStatementSetter; - private String sql; + private @Nullable String sql; - private RowMapper rowMapper; + private @Nullable RowMapper rowMapper; private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; @@ -360,7 +362,9 @@ public JdbcCursorItemReader build() { } reader.setSaveState(this.saveState); - reader.setPreparedStatementSetter(this.preparedStatementSetter); + if (this.preparedStatementSetter != null) { + reader.setPreparedStatementSetter(this.preparedStatementSetter); + } reader.setRowMapper(this.rowMapper); reader.setSql(this.sql); reader.setCurrentItemCount(this.currentItemCount); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcPagingItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcPagingItemReaderBuilder.java index 408263ea42..b8f649037a 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcPagingItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JdbcPagingItemReaderBuilder.java @@ -18,6 +18,7 @@ import java.util.Map; import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.JdbcPagingItemReader; import org.springframework.batch.item.database.Order; import org.springframework.batch.item.database.PagingQueryProvider; @@ -54,36 +55,37 @@ * @author Mahmoud Ben Hassine * @author Minsoo Kim * @author Juyoung Kim + * @author Stefano Cordio * @since 4.0 * @see JdbcPagingItemReader */ public class JdbcPagingItemReaderBuilder { - protected DataSource dataSource; + protected @Nullable DataSource dataSource; protected int fetchSize = JdbcPagingItemReader.VALUE_NOT_SET; - protected PagingQueryProvider queryProvider; + protected @Nullable PagingQueryProvider queryProvider; - protected RowMapper rowMapper; + protected @Nullable RowMapper rowMapper; - protected Map parameterValues; + protected @Nullable Map parameterValues; protected int pageSize = 10; - protected String groupClause; + protected @Nullable String groupClause; - protected String selectClause; + protected @Nullable String selectClause; - protected String fromClause; + protected @Nullable String fromClause; - protected String whereClause; + protected @Nullable String whereClause; - protected Map sortKeys; + protected @Nullable Map sortKeys; protected boolean saveState = true; - protected String name; + protected @Nullable String name; protected int maxItemCount = Integer.MAX_VALUE; @@ -296,7 +298,7 @@ public JdbcPagingItemReaderBuilder sortKeys(Map sortKeys) { * fragments configured via {@link #selectClause(String)}, * {@link #fromClause(String)}, {@link #whereClause(String)}, {@link #groupClause}, * and {@link #sortKeys(Map)} are ignored. - * @param provider the db specific query provider + * @param provider the db-specific query provider * @return this instance for method chaining * @see JdbcPagingItemReader#setQueryProvider(PagingQueryProvider) */ @@ -311,41 +313,41 @@ public JdbcPagingItemReaderBuilder queryProvider(PagingQueryProvider provider * @return a {@link JdbcPagingItemReader} */ public JdbcPagingItemReader build() { - Assert.isTrue(this.pageSize > 0, "pageSize must be greater than zero"); - Assert.notNull(this.dataSource, "dataSource is required"); + Assert.isTrue(pageSize > 0, "pageSize must be greater than zero"); + Assert.notNull(dataSource, "dataSource is required"); - if (this.saveState) { - Assert.hasText(this.name, "A name is required when saveState is set to true"); + if (saveState) { + Assert.hasText(name, "A name is required when saveState is set to true"); } JdbcPagingItemReader reader = new JdbcPagingItemReader<>(); - reader.setMaxItemCount(this.maxItemCount); - reader.setCurrentItemCount(this.currentItemCount); - reader.setName(this.name); - reader.setSaveState(this.saveState); - reader.setDataSource(this.dataSource); - reader.setFetchSize(this.fetchSize); - reader.setParameterValues(this.parameterValues); - - if (this.queryProvider == null) { - Assert.hasLength(this.selectClause, "selectClause is required when not providing a PagingQueryProvider"); - Assert.hasLength(this.fromClause, "fromClause is required when not providing a PagingQueryProvider"); - Assert.notEmpty(this.sortKeys, "sortKeys are required when not providing a PagingQueryProvider"); - - reader.setQueryProvider(determineQueryProvider(this.dataSource)); + reader.setMaxItemCount(maxItemCount); + reader.setCurrentItemCount(currentItemCount); + if (name != null) { + reader.setName(name); } - else { - reader.setQueryProvider(this.queryProvider); + reader.setSaveState(saveState); + reader.setDataSource(dataSource); + reader.setFetchSize(fetchSize); + if (parameterValues != null) { + reader.setParameterValues(parameterValues); } - reader.setRowMapper(this.rowMapper); - reader.setPageSize(this.pageSize); + reader.setQueryProvider(queryProvider == null ? determineQueryProvider(dataSource) : queryProvider); + + if (rowMapper != null) { + reader.setRowMapper(rowMapper); + } + reader.setPageSize(pageSize); return reader; } protected PagingQueryProvider determineQueryProvider(DataSource dataSource) { + Assert.hasLength(this.selectClause, "selectClause is required when not providing a PagingQueryProvider"); + Assert.hasLength(this.fromClause, "fromClause is required when not providing a PagingQueryProvider"); + Assert.notEmpty(this.sortKeys, "sortKeys are required when not providing a PagingQueryProvider"); try { DatabaseType databaseType = DatabaseType.fromMetaData(dataSource); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaCursorItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaCursorItemReaderBuilder.java index 571a5b0a4f..c005227760 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaCursorItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaCursorItemReaderBuilder.java @@ -19,6 +19,7 @@ import jakarta.persistence.EntityManagerFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamSupport; import org.springframework.batch.item.database.JpaCursorItemReader; @@ -31,23 +32,24 @@ * * @author Mahmoud Ben Hassine * @author Jinwoo Bae + * @author Stefano Cordio * @since 4.3 */ public class JpaCursorItemReaderBuilder { - private EntityManagerFactory entityManagerFactory; + private @Nullable EntityManagerFactory entityManagerFactory; - private String queryString; + private @Nullable String queryString; - private JpaQueryProvider queryProvider; + private @Nullable JpaQueryProvider queryProvider; - private Map parameterValues; + private @Nullable Map parameterValues; - private Map hintValues; + private @Nullable Map hintValues; private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; @@ -182,14 +184,24 @@ public JpaCursorItemReader build() { JpaCursorItemReader reader = new JpaCursorItemReader<>(); reader.setEntityManagerFactory(this.entityManagerFactory); - reader.setQueryProvider(this.queryProvider); - reader.setQueryString(this.queryString); - reader.setParameterValues(this.parameterValues); - reader.setHintValues(this.hintValues); + if (this.queryProvider != null) { + reader.setQueryProvider(this.queryProvider); + } + if (this.queryString != null) { + reader.setQueryString(this.queryString); + } + if (this.parameterValues != null) { + reader.setParameterValues(this.parameterValues); + } + if (this.hintValues != null) { + reader.setHintValues(this.hintValues); + } reader.setCurrentItemCount(this.currentItemCount); reader.setMaxItemCount(this.maxItemCount); reader.setSaveState(this.saveState); - reader.setName(this.name); + if (this.name != null) { + reader.setName(this.name); + } return reader; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaItemWriterBuilder.java index 4c04071c99..ff510c96b8 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaItemWriterBuilder.java @@ -17,6 +17,7 @@ import jakarta.persistence.EntityManagerFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.JpaItemWriter; import org.springframework.util.Assert; @@ -25,12 +26,13 @@ * * @author Mahmoud Ben Hassine * @author Jinwoo Bae + * @author Stefano Cordio * @since 4.1 * @see JpaItemWriter */ public class JpaItemWriterBuilder { - private EntityManagerFactory entityManagerFactory; + private @Nullable EntityManagerFactory entityManagerFactory; private boolean usePersist = false; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaPagingItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaPagingItemReaderBuilder.java index 0bb2a85c46..8689c104dc 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaPagingItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/JpaPagingItemReaderBuilder.java @@ -18,6 +18,7 @@ import java.util.Map; import jakarta.persistence.EntityManagerFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.JpaPagingItemReader; import org.springframework.batch.item.database.orm.JpaQueryProvider; import org.springframework.util.Assert; @@ -28,6 +29,7 @@ * @author Michael Minella * @author Glenn Renfro * @author Jinwoo Bae + * @author Stefano Cordio * @since 4.0 */ @@ -35,21 +37,21 @@ public class JpaPagingItemReaderBuilder { private int pageSize = 10; - private EntityManagerFactory entityManagerFactory; + private @Nullable EntityManagerFactory entityManagerFactory; - private Map parameterValues; + private @Nullable Map parameterValues; - private Map hintValues; + private @Nullable Map hintValues; private boolean transacted = true; - private String queryString; + private @Nullable String queryString; - private JpaQueryProvider queryProvider; + private @Nullable JpaQueryProvider queryProvider; private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; @@ -217,17 +219,27 @@ public JpaPagingItemReader build() { JpaPagingItemReader reader = new JpaPagingItemReader<>(); - reader.setQueryString(this.queryString); + if (this.queryString != null) { + reader.setQueryString(this.queryString); + } + if (this.parameterValues != null) { + reader.setParameterValues(this.parameterValues); + } + if (this.hintValues != null) { + reader.setHintValues(this.hintValues); + } + if (this.name != null) { + reader.setName(this.name); + } reader.setPageSize(this.pageSize); - reader.setParameterValues(this.parameterValues); - reader.setHintValues(this.hintValues); reader.setEntityManagerFactory(this.entityManagerFactory); - reader.setQueryProvider(this.queryProvider); + if (this.queryProvider != null) { + reader.setQueryProvider(this.queryProvider); + } reader.setTransacted(this.transacted); reader.setCurrentItemCount(this.currentItemCount); reader.setMaxItemCount(this.maxItemCount); reader.setSaveState(this.saveState); - reader.setName(this.name); return reader; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/StoredProcedureItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/StoredProcedureItemReaderBuilder.java index f359e8e873..3fc3ac9277 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/StoredProcedureItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/StoredProcedureItemReaderBuilder.java @@ -17,6 +17,7 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.AbstractCursorItemReader; import org.springframework.batch.item.database.StoredProcedureItemReader; @@ -45,7 +46,7 @@ public class StoredProcedureItemReaderBuilder { private boolean saveState = true; - private DataSource dataSource; + private @Nullable DataSource dataSource; private int fetchSize = VALUE_NOT_SET; @@ -61,11 +62,11 @@ public class StoredProcedureItemReaderBuilder { private boolean useSharedExtendedConnection = false; - private PreparedStatementSetter preparedStatementSetter; + private @Nullable PreparedStatementSetter preparedStatementSetter; - private RowMapper rowMapper; + private @Nullable RowMapper rowMapper; - private String procedureName; + private @Nullable String procedureName; private SqlParameter[] parameters = new SqlParameter[0]; @@ -73,7 +74,7 @@ public class StoredProcedureItemReaderBuilder { private int refCursorPosition = 0; - private String name; + private @Nullable String name; /** * Configure if the state of the @@ -322,7 +323,9 @@ public StoredProcedureItemReader build() { itemReader.setProcedureName(this.procedureName); itemReader.setRowMapper(this.rowMapper); itemReader.setParameters(this.parameters); - itemReader.setPreparedStatementSetter(this.preparedStatementSetter); + if (this.preparedStatementSetter != null) { + itemReader.setPreparedStatementSetter(this.preparedStatementSetter); + } itemReader.setFunction(this.function); itemReader.setRefCursorPosition(this.refCursorPosition); itemReader.setCurrentItemCount(this.currentItemCount); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/package-info.java index 13b752fc84..b0c189793b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/builder/package-info.java @@ -19,7 +19,7 @@ * * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.item.database.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/AbstractJpaQueryProvider.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/AbstractJpaQueryProvider.java index f44cb4da39..b6175f71e3 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/AbstractJpaQueryProvider.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/AbstractJpaQueryProvider.java @@ -19,7 +19,9 @@ import jakarta.persistence.EntityManager; import jakarta.persistence.Query; +import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.InitializingBean; +import org.springframework.util.Assert; /** *

@@ -34,7 +36,7 @@ */ public abstract class AbstractJpaQueryProvider implements JpaQueryProvider, InitializingBean { - private EntityManager entityManager; + private @Nullable EntityManager entityManager; /** *

@@ -55,8 +57,13 @@ public void setEntityManager(EntityManager entityManager) { *

* @return entityManager the injected {@link EntityManager} */ - protected EntityManager getEntityManager() { + protected @Nullable EntityManager getEntityManager() { return entityManager; } + @Override + public void afterPropertiesSet() throws Exception { + Assert.state(entityManager != null, "Entity manager must be set"); + } + } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaNamedQueryProvider.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaNamedQueryProvider.java index da2bae86f5..117030d7b4 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaNamedQueryProvider.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaNamedQueryProvider.java @@ -17,25 +17,26 @@ import jakarta.persistence.Query; +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** - *

* This query provider creates JPA named {@link Query}s. - *

* * @author Mahmoud Ben Hassine * @author Parikshit Dutta + * @author Stefano Cordio * @since 4.3 * @param entity returned by executing the query */ public class JpaNamedQueryProvider extends AbstractJpaQueryProvider { - private Class entityClass; + private @Nullable Class entityClass; - private String namedQuery; + private @Nullable String namedQuery; + @SuppressWarnings("DataFlowIssue") @Override public Query createQuery() { return getEntityManager().createNamedQuery(this.namedQuery, this.entityClass); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaNativeQueryProvider.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaNativeQueryProvider.java index 8ed7421217..89f20f92e4 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaNativeQueryProvider.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaNativeQueryProvider.java @@ -18,26 +18,28 @@ import jakarta.persistence.Query; +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** + * This query provider creates JPA {@link Query queries} from injected native SQL queries. *

- * This query provider creates JPA {@link Query}s from injected native SQL queries. This - * is useful if there is a need to utilize database-specific features such as query hints, - * the CONNECT keyword in Oracle, etc. - *

+ * This is useful if there is a need to utilize database-specific features such as query + * hints, the {@code CONNECT} keyword in Oracle, etc. * * @author Anatoly Polinsky * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @param entity returned by executing the query */ public class JpaNativeQueryProvider extends AbstractJpaQueryProvider { - private Class entityClass; + private @Nullable Class entityClass; - private String sqlQuery; + private @Nullable String sqlQuery; + @SuppressWarnings("DataFlowIssue") @Override public Query createQuery() { return getEntityManager().createNativeQuery(sqlQuery, entityClass); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaQueryProvider.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaQueryProvider.java index 1ccdd8f94d..1d8dcfcdd3 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaQueryProvider.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/JpaQueryProvider.java @@ -22,23 +22,18 @@ import org.springframework.batch.item.ItemReader; /** - *

* Interface defining the functionality to be provided for generating queries for use with - * JPA {@link ItemReader}s or other custom built artifacts. - *

+ * JPA {@link ItemReader}s or other custom-built artifacts. * * @author Anatoly Polinsky * @author Dave Syer * @author Mahmoud Ben Hassine * @since 2.1 - * */ public interface JpaQueryProvider { /** - *

* Create the query object. - *

* @return created query */ Query createQuery(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/package-info.java index 97d032d38b..fbd741436f 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/orm/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.item.database.orm; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/package-info.java index 801309e020..7cfc92bd04 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of database based item readers and writers. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.database; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/AbstractSqlPagingQueryProvider.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/AbstractSqlPagingQueryProvider.java index b60cdfadf9..efa0729dc9 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/AbstractSqlPagingQueryProvider.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/AbstractSqlPagingQueryProvider.java @@ -22,6 +22,7 @@ import java.util.Map; import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.JdbcParameterUtils; import org.springframework.batch.item.database.Order; import org.springframework.batch.item.database.PagingQueryProvider; @@ -50,19 +51,20 @@ * @author Michael Minella * @author Mahmoud Ben Hassine * @author Benjamin Hetz + * @author Stefano Cordio * @since 2.0 */ public abstract class AbstractSqlPagingQueryProvider implements PagingQueryProvider { - private String selectClause; + private @Nullable String selectClause; - private String fromClause; + private @Nullable String fromClause; - private String whereClause; + private @Nullable String whereClause; private Map sortKeys = new LinkedHashMap<>(); - private String groupClause; + private @Nullable String groupClause; private int parameterCount; @@ -72,20 +74,15 @@ public abstract class AbstractSqlPagingQueryProvider implements PagingQueryProvi * The setter for the group by clause * @param groupClause SQL GROUP BY clause part of the SQL query string */ - public void setGroupClause(String groupClause) { - if (StringUtils.hasText(groupClause)) { - this.groupClause = removeKeyWord("group by", groupClause); - } - else { - this.groupClause = null; - } + public void setGroupClause(@Nullable String groupClause) { + this.groupClause = StringUtils.hasText(groupClause) ? removeKeyWord("group by", groupClause) : null; } /** * The getter for the group by clause * @return SQL GROUP BY clause part of the SQL query string */ - public String getGroupClause() { + public @Nullable String getGroupClause() { return this.groupClause; } @@ -99,7 +96,7 @@ public void setSelectClause(String selectClause) { /** * @return SQL SELECT clause part of SQL query string */ - protected String getSelectClause() { + protected @Nullable String getSelectClause() { return selectClause; } @@ -113,14 +110,14 @@ public void setFromClause(String fromClause) { /** * @return SQL FROM clause part of SQL query string */ - protected String getFromClause() { + protected @Nullable String getFromClause() { return fromClause; } /** * @param whereClause WHERE clause part of SQL query string */ - public void setWhereClause(String whereClause) { + public void setWhereClause(@Nullable String whereClause) { if (StringUtils.hasText(whereClause)) { this.whereClause = removeKeyWord("where", whereClause); } @@ -132,7 +129,7 @@ public void setWhereClause(String whereClause) { /** * @return SQL WHERE clause part of SQL query string */ - protected String getWhereClause() { + protected @Nullable String getWhereClause() { return whereClause; } @@ -166,7 +163,7 @@ public boolean isUsingNamedParameters() { /** * The sort key placeholder will vary depending on whether named parameters or * traditional placeholders are used in query strings. - * @return place holder for sortKey. + * @return placeholder for sortKey. */ @Override public String getSortKeyPlaceHolder(String keyName) { @@ -205,7 +202,7 @@ public void init(DataSource dataSource) throws Exception { /** * Method generating the query string to be used for retrieving the first page. This - * method must be implemented in sub classes. + * method must be implemented in subclasses. * @param pageSize number of rows to read per page * @return query string */ diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryProviderFactoryBean.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryProviderFactoryBean.java index 608e0f2e5b..bf51c4bfdc 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryProviderFactoryBean.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryProviderFactoryBean.java @@ -37,6 +37,7 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.Order; import org.springframework.batch.item.database.PagingQueryProvider; import org.springframework.batch.support.DatabaseType; @@ -56,19 +57,19 @@ */ public class SqlPagingQueryProviderFactoryBean implements FactoryBean { - private DataSource dataSource; + private @Nullable DataSource dataSource; - private String databaseType; + private @Nullable String databaseType; - private String fromClause; + private @Nullable String fromClause; - private String whereClause; + private @Nullable String whereClause; - private String selectClause; + private @Nullable String selectClause; - private String groupClause; + private @Nullable String groupClause; - private Map sortKeys; + private @Nullable Map sortKeys; private final Map providers = new HashMap<>(); @@ -141,11 +142,7 @@ public void setSortKeys(Map sortKeys) { public void setSortKey(String key) { Assert.doesNotContain(key, ",", "String setter is valid for a single ASC key only"); - - Map keys = new LinkedHashMap<>(); - keys.put(key, Order.ASCENDING); - - this.sortKeys = keys; + this.sortKeys = Map.of(key, Order.ASCENDING); } /** @@ -154,6 +151,7 @@ public void setSortKey(String key) { * * @see FactoryBean#getObject() */ + @SuppressWarnings("DataFlowIssue") @Override public PagingQueryProvider getObject() throws Exception { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryUtils.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryUtils.java index 265c6275c3..43cc12bdc2 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryUtils.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryUtils.java @@ -21,6 +21,7 @@ import java.util.Map; import java.util.Map.Entry; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.database.Order; import org.springframework.util.StringUtils; @@ -155,7 +156,7 @@ public static String generateRowNumSqlQuery(AbstractSqlPagingQueryProvider provi * @param rowNumClause the implementation specific row num clause to be used * @return the generated query */ - public static String generateRowNumSqlQuery(AbstractSqlPagingQueryProvider provider, String selectClause, + public static String generateRowNumSqlQuery(AbstractSqlPagingQueryProvider provider, @Nullable String selectClause, boolean remainingPageQuery, String rowNumClause) { StringBuilder sql = new StringBuilder(); sql.append("SELECT * FROM (SELECT ").append(selectClause); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/package-info.java index 67d58af49e..d12a3ee574 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.item.database.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/FlatFileItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/FlatFileItemReader.java index c990d97708..eb7cc3421b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/FlatFileItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/FlatFileItemReader.java @@ -22,6 +22,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ReaderNotOpenException; @@ -30,7 +31,6 @@ import org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader; import org.springframework.beans.factory.InitializingBean; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; @@ -49,6 +49,7 @@ * * @author Robert Kasanicky * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public class FlatFileItemReader extends AbstractItemCountingItemStreamItemReader implements ResourceAwareItemReaderItemStream, InitializingBean { @@ -61,9 +62,9 @@ public class FlatFileItemReader extends AbstractItemCountingItemStreamItemRea private RecordSeparatorPolicy recordSeparatorPolicy = new SimpleRecordSeparatorPolicy(); - private Resource resource; + private @Nullable Resource resource; - private BufferedReader reader; + private @Nullable BufferedReader reader; private int lineCount = 0; @@ -73,11 +74,11 @@ public class FlatFileItemReader extends AbstractItemCountingItemStreamItemRea private String encoding = DEFAULT_CHARSET; - private LineMapper lineMapper; + private @Nullable LineMapper lineMapper; private int linesToSkip = 0; - private LineCallbackHandler skippedLinesCallback; + private @Nullable LineCallbackHandler skippedLinesCallback; private boolean strict = true; @@ -158,7 +159,7 @@ public void setComments(String[] comments) { * Public setter for the input resource. */ @Override - public void setResource(Resource resource) { + public void setResource(@Nullable Resource resource) { this.resource = resource; } @@ -177,9 +178,9 @@ public void setRecordSeparatorPolicy(RecordSeparatorPolicy recordSeparatorPolicy * {@link #setRecordSeparatorPolicy(RecordSeparatorPolicy)} (might span multiple lines * in file). */ - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { if (noInput) { return null; } @@ -203,8 +204,7 @@ protected T doRead() throws Exception { /** * @return next line (skip comments).getCurrentResource */ - @Nullable - private String readLine() { + private @Nullable String readLine() { if (reader == null) { throw new ReaderNotOpenException("Reader must be open before it can be read."); @@ -213,18 +213,14 @@ private String readLine() { String line = null; try { - line = this.reader.readLine(); - if (line == null) { - return null; - } - lineCount++; - while (isComment(line)) { + do { line = reader.readLine(); if (line == null) { return null; } lineCount++; } + while (isComment(line)); line = applyRecordSeparatorPolicy(line); } @@ -281,7 +277,7 @@ protected void doOpen() throws Exception { reader = bufferedReaderFactory.create(resource, encoding); for (int i = 0; i < linesToSkip; i++) { String line = readLine(); - if (skippedLinesCallback != null) { + if (skippedLinesCallback != null && line != null) { skippedLinesCallback.handleLine(line); } } @@ -300,10 +296,11 @@ protected void jumpToItem(int itemIndex) throws Exception { } } + @SuppressWarnings("DataFlowIssue") private String applyRecordSeparatorPolicy(String line) throws IOException { String record = line; - while (line != null && !recordSeparatorPolicy.isEndOfRecord(record)) { + while (!recordSeparatorPolicy.isEndOfRecord(record)) { line = this.reader.readLine(); if (line == null) { if (StringUtils.hasText(record)) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/FlatFileItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/FlatFileItemWriter.java index 889e4ff5dc..6cd5970580 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/FlatFileItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/FlatFileItemWriter.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.file; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.file.transform.LineAggregator; import org.springframework.batch.item.support.AbstractFileItemWriter; @@ -38,10 +39,11 @@ * @author Dave Syer * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public class FlatFileItemWriter extends AbstractFileItemWriter { - protected LineAggregator lineAggregator; + protected @Nullable LineAggregator lineAggregator; public FlatFileItemWriter() { this.setExecutionContextName(ClassUtils.getShortName(FlatFileItemWriter.class)); @@ -69,6 +71,7 @@ public void setLineAggregator(LineAggregator lineAggregator) { this.lineAggregator = lineAggregator; } + @SuppressWarnings("DataFlowIssue") @Override public String doWrite(Chunk items) { StringBuilder lines = new StringBuilder(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/MultiResourceItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/MultiResourceItemReader.java index 63ebf7617e..610882dc8e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/MultiResourceItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/MultiResourceItemReader.java @@ -21,6 +21,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStream; import org.springframework.batch.item.ItemStreamException; @@ -29,7 +31,6 @@ import org.springframework.batch.item.UnexpectedInputException; import org.springframework.batch.item.support.AbstractItemStreamItemReader; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -51,9 +52,9 @@ public class MultiResourceItemReader extends AbstractItemStreamItemReader private static final String RESOURCE_KEY = "resourceIndex"; - private ResourceAwareItemReaderItemStream delegate; + private @Nullable ResourceAwareItemReaderItemStream delegate; - private Resource[] resources; + private Resource @Nullable [] resources; private boolean saveState = true; @@ -79,6 +80,7 @@ public void setStrict(boolean strict) { /** * Compares resource filenames. */ + @SuppressWarnings("DataFlowIssue") @Override public int compare(Resource r1, Resource r2) { return r1.getFilename().compareTo(r2.getFilename()); @@ -93,9 +95,9 @@ public MultiResourceItemReader() { /** * Reads the next item, jumping to next resource if necessary. */ - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - public T read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable T read() throws Exception { if (noInput) { return null; @@ -117,7 +119,8 @@ public T read() throws Exception, UnexpectedInputException, ParseException { * exhausted. Items are appended to the buffer. * @return next item from input */ - private T readNextItem() throws Exception { + @SuppressWarnings("DataFlowIssue") + private @Nullable T readNextItem() throws Exception { T item = readFromDelegate(); @@ -139,7 +142,8 @@ private T readNextItem() throws Exception { return item; } - private T readFromDelegate() throws Exception { + @SuppressWarnings("DataFlowIssue") + private @Nullable T readFromDelegate() throws Exception { T item = delegate.read(); if (item instanceof ResourceAware resourceAware) { resourceAware.setResource(resources[currentResource]); @@ -151,6 +155,7 @@ private T readFromDelegate() throws Exception { * Close the {@link #setDelegate(ResourceAwareItemReaderItemStream)} reader and reset * instance variable values. */ + @SuppressWarnings("DataFlowIssue") @Override public void close() throws ItemStreamException { super.close(); @@ -166,6 +171,7 @@ public void close() throws ItemStreamException { * Figure out which resource to start with in case of restart, open the delegate and * restore delegate's position in the resource. */ + @SuppressWarnings("DataFlowIssue") @Override public void open(ExecutionContext executionContext) throws ItemStreamException { super.open(executionContext); @@ -205,6 +211,7 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { /** * Store the current resource index and position in the resource. */ + @SuppressWarnings("DataFlowIssue") @Override public void update(ExecutionContext executionContext) throws ItemStreamException { super.update(executionContext); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/MultiResourceItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/MultiResourceItemWriter.java index d07cbda99d..989127c6e4 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/MultiResourceItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/MultiResourceItemWriter.java @@ -19,6 +19,7 @@ import java.io.File; import java.io.IOException; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamException; @@ -50,9 +51,9 @@ public class MultiResourceItemWriter extends AbstractItemStreamItemWriter final static private String CURRENT_RESOURCE_ITEM_COUNT = "resource.item.count"; - private Resource resource; + private @Nullable Resource resource; - private ResourceAwareItemWriterItemStream delegate; + private @Nullable ResourceAwareItemWriterItemStream delegate; private int itemCountLimitPerResource = Integer.MAX_VALUE; @@ -70,6 +71,7 @@ public MultiResourceItemWriter() { this.setExecutionContextName(ClassUtils.getShortName(MultiResourceItemWriter.class)); } + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk items) throws Exception { int writtenItems = 0; @@ -144,6 +146,7 @@ public void setSaveState(boolean saveState) { this.saveState = saveState; } + @SuppressWarnings("DataFlowIssue") @Override public void close() throws ItemStreamException { super.close(); @@ -154,6 +157,7 @@ public void close() throws ItemStreamException { } } + @SuppressWarnings("DataFlowIssue") @Override public void open(ExecutionContext executionContext) throws ItemStreamException { super.open(executionContext); @@ -177,6 +181,7 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { } } + @SuppressWarnings("DataFlowIssue") @Override public void update(ExecutionContext executionContext) throws ItemStreamException { super.update(executionContext); @@ -192,6 +197,7 @@ public void update(ExecutionContext executionContext) throws ItemStreamException /** * Create output resource (if necessary) and point the delegate to it. */ + @SuppressWarnings("DataFlowIssue") private File setResourceToDelegate() throws IOException { String path = resource.getFile().getAbsolutePath() + suffixCreator.getSuffix(resourceIndex); File file = new File(path); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/NonTransientFlatFileException.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/NonTransientFlatFileException.java index 0e322610c1..9fff9e7768 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/NonTransientFlatFileException.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/NonTransientFlatFileException.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.item.file; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.NonTransientResourceException; /** @@ -25,7 +26,7 @@ */ public class NonTransientFlatFileException extends NonTransientResourceException { - private final String input; + private final @Nullable String input; private int lineNumber; @@ -40,13 +41,13 @@ public NonTransientFlatFileException(String message, String input, int lineNumbe this.lineNumber = lineNumber; } - public NonTransientFlatFileException(String message, Throwable cause, String input, int lineNumber) { + public NonTransientFlatFileException(String message, Throwable cause, @Nullable String input, int lineNumber) { super(message, cause); this.input = input; this.lineNumber = lineNumber; } - public String getInput() { + public @Nullable String getInput() { return input; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/ResourcesItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/ResourcesItemReader.java index 9f675de38b..209c07cd27 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/ResourcesItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/ResourcesItemReader.java @@ -21,11 +21,12 @@ import org.springframework.batch.item.support.AbstractItemStreamItemReader; import org.springframework.core.io.Resource; import org.springframework.core.io.support.ResourceArrayPropertyEditor; -import org.springframework.lang.Nullable; import java.util.Arrays; import java.util.concurrent.atomic.AtomicInteger; +import org.jspecify.annotations.Nullable; + /** * {@link ItemReader} which produces {@link Resource} instances from an array. This can be * used conveniently with a configuration entry that injects a pattern (e.g. @@ -72,8 +73,7 @@ public void setResources(Resource[] resources) { * or {@code null} if none remain. */ @Override - @Nullable - public synchronized Resource read() throws Exception { + public synchronized @Nullable Resource read() throws Exception { int index = counter.incrementAndGet() - 1; if (index >= resources.length) { return null; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/SimpleBinaryBufferedReaderFactory.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/SimpleBinaryBufferedReaderFactory.java index fe6f2e3f7c..5555182c8b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/SimpleBinaryBufferedReaderFactory.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/SimpleBinaryBufferedReaderFactory.java @@ -24,6 +24,8 @@ import org.springframework.core.io.Resource; +import org.jspecify.annotations.Nullable; + /** * A {@link BufferedReaderFactory} useful for reading simple binary (or text) files with * no line endings, such as those produced by mainframe copy books. The reader splits a @@ -76,7 +78,7 @@ private BinaryBufferedReader(Reader in, String ending) { } @Override - public String readLine() throws IOException { + public @Nullable String readLine() throws IOException { StringBuilder buffer; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/FlatFileItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/FlatFileItemReaderBuilder.java index e52d4dbde9..a38ae322bb 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/FlatFileItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/FlatFileItemReaderBuilder.java @@ -29,6 +29,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.BufferedReaderFactory; import org.springframework.batch.item.file.DefaultBufferedReaderFactory; import org.springframework.batch.item.file.FlatFileItemReader; @@ -60,6 +61,7 @@ * @author Drummond Dawson * @author Patrick Baumgartner * @author François Martin + * @author Stefano Cordio * @since 4.0 * @see FlatFileItemReader */ @@ -75,29 +77,29 @@ public class FlatFileItemReaderBuilder { private BufferedReaderFactory bufferedReaderFactory = new DefaultBufferedReaderFactory(); - private Resource resource; + private @Nullable Resource resource; private List comments = new ArrayList<>(Arrays.asList(FlatFileItemReader.DEFAULT_COMMENT_PREFIXES)); private int linesToSkip = 0; - private LineCallbackHandler skippedLinesCallback; + private @Nullable LineCallbackHandler skippedLinesCallback; - private LineMapper lineMapper; + private @Nullable LineMapper lineMapper; - private FieldSetMapper fieldSetMapper; + private @Nullable FieldSetMapper fieldSetMapper; - private LineTokenizer lineTokenizer; + private @Nullable LineTokenizer lineTokenizer; - private DelimitedBuilder delimitedBuilder; + private @Nullable DelimitedBuilder delimitedBuilder; - private FixedLengthBuilder fixedLengthBuilder; + private @Nullable FixedLengthBuilder fixedLengthBuilder; - private Class targetType; + private @Nullable Class targetType; - private String prototypeBeanName; + private @Nullable String prototypeBeanName; - private BeanFactory beanFactory; + private @Nullable BeanFactory beanFactory; private final Map, PropertyEditor> customEditors = new HashMap<>(); @@ -109,7 +111,7 @@ public class FlatFileItemReaderBuilder { private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; @@ -299,8 +301,7 @@ public FlatFileItemReaderBuilder fieldSetMapper(FieldSetMapper mapper) { * @see DefaultLineMapper#setLineTokenizer(LineTokenizer) */ public FlatFileItemReaderBuilder lineTokenizer(LineTokenizer tokenizer) { - updateTokenizerValidation(tokenizer, 0); - + this.tokenizerValidator = this.tokenizerValidator.flipBit(0); this.lineTokenizer = tokenizer; return this; } @@ -315,7 +316,7 @@ public FlatFileItemReaderBuilder lineTokenizer(LineTokenizer tokenizer) { */ public DelimitedBuilder delimited() { this.delimitedBuilder = new DelimitedBuilder<>(this); - updateTokenizerValidation(this.delimitedBuilder, 1); + this.tokenizerValidator = this.tokenizerValidator.flipBit(1); return this.delimitedBuilder; } @@ -328,15 +329,15 @@ public DelimitedBuilder delimited() { */ public FixedLengthBuilder fixedLength() { this.fixedLengthBuilder = new FixedLengthBuilder<>(this); - updateTokenizerValidation(this.fixedLengthBuilder, 2); + this.tokenizerValidator = this.tokenizerValidator.flipBit(2); return this.fixedLengthBuilder; } /** * The class that will represent the "item" to be returned from the reader. This class * is used via the {@link BeanWrapperFieldSetMapper}. If more complex logic is - * required, providing your own {@link FieldSetMapper} via - * {@link FlatFileItemReaderBuilder#fieldSetMapper} is required. + * required, providing your own {@link FieldSetMapper} via {@link #fieldSetMapper} is + * required. * @param targetType The class to map to * @return The current instance of the builder. * @see BeanWrapperFieldSetMapper#setTargetType(Class) @@ -377,10 +378,7 @@ public FlatFileItemReaderBuilder beanFactory(BeanFactory beanFactory) { * @see BeanWrapperFieldSetMapper#setCustomEditors(Map) */ public FlatFileItemReaderBuilder customEditors(Map, PropertyEditor> customEditors) { - if (customEditors != null) { - this.customEditors.putAll(customEditors); - } - + this.customEditors.putAll(customEditors); return this; } @@ -471,10 +469,16 @@ else if (this.delimitedBuilder != null) { } else { BeanWrapperFieldSetMapper mapper = new BeanWrapperFieldSetMapper<>(); - mapper.setTargetType(this.targetType); - mapper.setPrototypeBeanName(this.prototypeBeanName); + if (this.prototypeBeanName != null) { + mapper.setPrototypeBeanName(this.prototypeBeanName); + } + if (this.beanFactory != null) { + mapper.setBeanFactory(this.beanFactory); + } + if (this.targetType != null) { + mapper.setTargetType(this.targetType); + } mapper.setStrict(this.beanMapperStrict); - mapper.setBeanFactory(this.beanFactory); mapper.setDistanceLimit(this.distanceLimit); mapper.setCustomEditors(this.customEditors); try { @@ -497,9 +501,11 @@ else if (this.fieldSetMapper != null) { } reader.setLinesToSkip(this.linesToSkip); - reader.setComments(this.comments.toArray(new String[this.comments.size()])); + reader.setComments(this.comments.toArray(new String[0])); - reader.setSkippedLinesCallback(this.skippedLinesCallback); + if (this.skippedLinesCallback != null) { + reader.setSkippedLinesCallback(this.skippedLinesCallback); + } reader.setRecordSeparatorPolicy(this.recordSeparatorPolicy); reader.setBufferedReaderFactory(this.bufferedReaderFactory); reader.setMaxItemCount(this.maxItemCount); @@ -510,15 +516,6 @@ else if (this.fieldSetMapper != null) { return reader; } - private void updateTokenizerValidation(Object tokenizer, int index) { - if (tokenizer != null) { - this.tokenizerValidator = this.tokenizerValidator.flipBit(index); - } - else { - this.tokenizerValidator = this.tokenizerValidator.clearBit(index); - } - } - /** * A builder for constructing a {@link DelimitedLineTokenizer} * @@ -530,9 +527,9 @@ public static class DelimitedBuilder { private final List names = new ArrayList<>(); - private String delimiter; + private @Nullable String delimiter; - private Character quoteCharacter; + private @Nullable Character quoteCharacter; private final List includedFields = new ArrayList<>(); @@ -638,7 +635,7 @@ public DelimitedLineTokenizer build() { DelimitedLineTokenizer tokenizer = new DelimitedLineTokenizer(); - tokenizer.setNames(this.names.toArray(new String[this.names.size()])); + tokenizer.setNames(this.names.toArray(new String[0])); if (StringUtils.hasLength(this.delimiter)) { tokenizer.setDelimiter(this.delimiter); @@ -780,8 +777,8 @@ public FixedLengthTokenizer build() { FixedLengthTokenizer tokenizer = new FixedLengthTokenizer(); - tokenizer.setNames(this.names.toArray(new String[this.names.size()])); - tokenizer.setColumns(this.ranges.toArray(new Range[this.ranges.size()])); + tokenizer.setNames(this.names.toArray(new String[0])); + tokenizer.setColumns(this.ranges.toArray(new Range[0])); tokenizer.setFieldSetFactory(this.fieldSetFactory); tokenizer.setStrict(this.strict); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/FlatFileItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/FlatFileItemWriterBuilder.java index 7de7de5301..0ffc9262a4 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/FlatFileItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/FlatFileItemWriterBuilder.java @@ -23,6 +23,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.FlatFileFooterCallback; import org.springframework.batch.item.file.FlatFileHeaderCallback; import org.springframework.batch.item.file.FlatFileItemWriter; @@ -43,6 +44,7 @@ * @author Glenn Renfro * @author Mahmoud Ben Hassine * @author Drummond Dawson + * @author Stefano Cordio * @since 4.0 * @see FlatFileItemWriter */ @@ -50,13 +52,13 @@ public class FlatFileItemWriterBuilder { protected Log logger = LogFactory.getLog(getClass()); - private WritableResource resource; + private @Nullable WritableResource resource; private boolean forceSync = false; private String lineSeparator = FlatFileItemWriter.DEFAULT_LINE_SEPARATOR; - private LineAggregator lineAggregator; + private @Nullable LineAggregator lineAggregator; private String encoding = FlatFileItemWriter.DEFAULT_CHARSET; @@ -66,19 +68,19 @@ public class FlatFileItemWriterBuilder { private boolean shouldDeleteIfEmpty = false; - private FlatFileHeaderCallback headerCallback; + private @Nullable FlatFileHeaderCallback headerCallback; - private FlatFileFooterCallback footerCallback; + private @Nullable FlatFileFooterCallback footerCallback; private boolean transactional = FlatFileItemWriter.DEFAULT_TRANSACTIONAL; private boolean saveState = true; - private String name; + private @Nullable String name; - private DelimitedBuilder delimitedBuilder; + private @Nullable DelimitedBuilder delimitedBuilder; - private FormattedBuilder formattedBuilder; + private @Nullable FormattedBuilder formattedBuilder; /** * Configure if the state of the @@ -280,7 +282,7 @@ public static class FormattedBuilder { private final FlatFileItemWriterBuilder parent; - private String format; + private @Nullable String format; private Locale locale = Locale.getDefault(); @@ -288,11 +290,11 @@ public static class FormattedBuilder { private int minimumLength = 0; - private FieldExtractor fieldExtractor; + private @Nullable FieldExtractor fieldExtractor; private final List names = new ArrayList<>(); - private Class sourceType; + private @Nullable Class sourceType; protected FormattedBuilder(FlatFileItemWriterBuilder parent) { this.parent = parent; @@ -380,7 +382,7 @@ public FlatFileItemWriterBuilder names(String... names) { public FormatterLineAggregator build() { Assert.notNull(this.format, "A format is required"); - Assert.isTrue((this.names != null && !this.names.isEmpty()) || this.fieldExtractor != null, + Assert.isTrue(!this.names.isEmpty() || this.fieldExtractor != null, "A list of field names or a field extractor is required"); FormatterLineAggregator formatterLineAggregator = new FormatterLineAggregator<>(); @@ -395,7 +397,7 @@ public FormatterLineAggregator build() { } else { BeanWrapperFieldExtractor beanWrapperFieldExtractor = new BeanWrapperFieldExtractor<>(); - beanWrapperFieldExtractor.setNames(this.names.toArray(new String[this.names.size()])); + beanWrapperFieldExtractor.setNames(this.names.toArray(new String[0])); try { beanWrapperFieldExtractor.afterPropertiesSet(); this.fieldExtractor = beanWrapperFieldExtractor; @@ -427,9 +429,9 @@ public static class DelimitedBuilder { private String quoteCharacter = ""; - private FieldExtractor fieldExtractor; + private @Nullable FieldExtractor fieldExtractor; - private Class sourceType; + private @Nullable Class sourceType; protected DelimitedBuilder(FlatFileItemWriterBuilder parent) { this.parent = parent; @@ -497,13 +499,12 @@ public FlatFileItemWriterBuilder fieldExtractor(FieldExtractor fieldExtrac } public DelimitedLineAggregator build() { - Assert.isTrue((this.names != null && !this.names.isEmpty()) || this.fieldExtractor != null, + Assert.isTrue(!this.names.isEmpty() || this.fieldExtractor != null, "A list of field names or a field extractor is required"); DelimitedLineAggregator delimitedLineAggregator = new DelimitedLineAggregator<>(); - if (this.delimiter != null) { - delimitedLineAggregator.setDelimiter(this.delimiter); - } + delimitedLineAggregator.setDelimiter(this.delimiter); + if (StringUtils.hasLength(this.quoteCharacter)) { delimitedLineAggregator.setQuoteCharacter(this.quoteCharacter); } @@ -514,7 +515,7 @@ public DelimitedLineAggregator build() { } else { BeanWrapperFieldExtractor beanWrapperFieldExtractor = new BeanWrapperFieldExtractor<>(); - beanWrapperFieldExtractor.setNames(this.names.toArray(new String[this.names.size()])); + beanWrapperFieldExtractor.setNames(this.names.toArray(new String[0])); try { beanWrapperFieldExtractor.afterPropertiesSet(); this.fieldExtractor = beanWrapperFieldExtractor; @@ -551,12 +552,18 @@ public FlatFileItemWriter build() { FlatFileItemWriter writer = new FlatFileItemWriter<>(); - writer.setName(this.name); + if (this.name != null) { + writer.setName(this.name); + } writer.setAppendAllowed(this.append); writer.setEncoding(this.encoding); - writer.setFooterCallback(this.footerCallback); + if (this.footerCallback != null) { + writer.setFooterCallback(this.footerCallback); + } writer.setForceSync(this.forceSync); - writer.setHeaderCallback(this.headerCallback); + if (this.headerCallback != null) { + writer.setHeaderCallback(this.headerCallback); + } if (this.lineAggregator == null) { Assert.state(this.delimitedBuilder == null || this.formattedBuilder == null, "Either a DelimitedLineAggregator or a FormatterLineAggregator should be provided, but not both"); @@ -564,12 +571,15 @@ public FlatFileItemWriter build() { this.lineAggregator = this.delimitedBuilder.build(); } else { + Assert.state(this.formattedBuilder != null, "A FormattedBuilder is required"); this.lineAggregator = this.formattedBuilder.build(); } } writer.setLineAggregator(this.lineAggregator); writer.setLineSeparator(this.lineSeparator); - writer.setResource(this.resource); + if (this.resource != null) { + writer.setResource(this.resource); + } writer.setSaveState(this.saveState); writer.setShouldDeleteIfEmpty(this.shouldDeleteIfEmpty); writer.setShouldDeleteIfExists(this.shouldDeleteIfExists); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/MultiResourceItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/MultiResourceItemReaderBuilder.java index bfb6927518..4ee65dd80c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/MultiResourceItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/MultiResourceItemReaderBuilder.java @@ -18,6 +18,7 @@ import java.util.Comparator; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.MultiResourceItemReader; import org.springframework.batch.item.file.ResourceAwareItemReaderItemStream; import org.springframework.core.io.Resource; @@ -29,22 +30,23 @@ * * @author Glenn Renfro * @author Drummond Dawson + * @author Stefano Cordio * @since 4.0 * @see MultiResourceItemReader */ public class MultiResourceItemReaderBuilder { - private ResourceAwareItemReaderItemStream delegate; + private @Nullable ResourceAwareItemReaderItemStream delegate; - private Resource[] resources; + private Resource @Nullable [] resources; private boolean strict = false; - private Comparator comparator; + private @Nullable Comparator comparator; private boolean saveState = true; - private String name; + private @Nullable String name; /** * Configure if the state of the diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/MultiResourceItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/MultiResourceItemWriterBuilder.java index 101d283a7d..ecae5a112c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/MultiResourceItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/MultiResourceItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.file.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.MultiResourceItemWriter; import org.springframework.batch.item.file.ResourceAwareItemWriterItemStream; import org.springframework.batch.item.file.ResourceSuffixCreator; @@ -32,17 +33,17 @@ */ public class MultiResourceItemWriterBuilder { - private Resource resource; + private @Nullable Resource resource; - private ResourceAwareItemWriterItemStream delegate; + private @Nullable ResourceAwareItemWriterItemStream delegate; private int itemCountLimitPerResource = Integer.MAX_VALUE; - private ResourceSuffixCreator suffixCreator; + private @Nullable ResourceSuffixCreator suffixCreator; private boolean saveState = true; - private String name; + private @Nullable String name; /** * Configure if the state of the @@ -142,7 +143,9 @@ public MultiResourceItemWriter build() { writer.setResourceSuffixCreator(this.suffixCreator); } writer.setSaveState(this.saveState); - writer.setName(this.name); + if (this.name != null) { + writer.setName(this.name); + } return writer; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/package-info.java index 6ceabb3b91..4e4ccc71e1 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/builder/package-info.java @@ -18,8 +18,9 @@ * Builders for file item readers and writers. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.file.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/BeanWrapperFieldSetMapper.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/BeanWrapperFieldSetMapper.java index 81bfa97739..1ab6612cb8 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/BeanWrapperFieldSetMapper.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/BeanWrapperFieldSetMapper.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2023 the original author or authors. + * Copyright 2006-2025 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. @@ -26,6 +26,7 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.transform.FieldSet; import org.springframework.batch.support.DefaultPropertyEditorRegistrar; import org.springframework.beans.BeanWrapperImpl; @@ -88,16 +89,16 @@ * * @author Dave Syer * @author Mahmoud Ben Hassine - * + * @author Stefano Cordio */ public class BeanWrapperFieldSetMapper extends DefaultPropertyEditorRegistrar implements FieldSetMapper, BeanFactoryAware, InitializingBean { - private String name; + private @Nullable String name; - private Class type; + private @Nullable Class type; - private BeanFactory beanFactory; + private @Nullable BeanFactory beanFactory; private final ConcurrentMap> propertiesMatched = new ConcurrentHashMap<>(); @@ -105,7 +106,7 @@ public class BeanWrapperFieldSetMapper extends DefaultPropertyEditorRegistrar private boolean strict = true; - private ConversionService conversionService; + private @Nullable ConversionService conversionService; private boolean isCustomEditorsSet; @@ -152,7 +153,7 @@ public void setTargetType(Class type) { * Check that precisely one of type or prototype bean name is specified. * @throws IllegalStateException if neither is set or both properties are set. * - * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet() + * @see InitializingBean#afterPropertiesSet() */ @Override public void afterPropertiesSet() throws Exception { @@ -169,7 +170,7 @@ public void afterPropertiesSet() throws Exception { * {@link DataBinder} from {@link #createBinder(Object)} has errors after binding). * @throws NotWritablePropertyException if the {@link FieldSet} contains a field that * cannot be mapped to a bean property. - * @see org.springframework.batch.item.file.mapping.FieldSetMapper#mapFieldSet(FieldSet) + * @see FieldSetMapper#mapFieldSet(FieldSet) */ @Override public T mapFieldSet(FieldSet fs) throws BindException { @@ -215,7 +216,7 @@ protected DataBinder createBinder(Object target) { protected void initBinder(DataBinder binder) { } - @SuppressWarnings("unchecked") + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) private T getBean() { if (name != null) { return (T) beanFactory.getBean(name); @@ -275,11 +276,7 @@ private Properties getBeanProperties(Object bean, Properties properties) { return properties; } - private String findPropertyName(Object bean, String key) { - - if (bean == null) { - return null; - } + private @Nullable String findPropertyName(Object bean, String key) { Class cls = bean.getClass(); @@ -333,6 +330,7 @@ private String findPropertyName(Object bean, String key) { return name; } + @SuppressWarnings("DataFlowIssue") private Object getPropertyValue(Object bean, String nestedName) { BeanWrapperImpl wrapper = new BeanWrapperImpl(bean); wrapper.setAutoGrowNestedPaths(true); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/DefaultLineMapper.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/DefaultLineMapper.java index 5392887fa7..c501a609db 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/DefaultLineMapper.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/DefaultLineMapper.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.file.mapping; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.LineMapper; import org.springframework.batch.item.file.transform.FieldSet; import org.springframework.batch.item.file.transform.LineTokenizer; @@ -33,10 +34,11 @@ */ public class DefaultLineMapper implements LineMapper, InitializingBean { - private LineTokenizer tokenizer; + private @Nullable LineTokenizer tokenizer; - private FieldSetMapper fieldSetMapper; + private @Nullable FieldSetMapper fieldSetMapper; + @SuppressWarnings("DataFlowIssue") @Override public T mapLine(String line, int lineNumber) throws Exception { return fieldSetMapper.mapFieldSet(tokenizer.tokenize(line)); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/PatternMatchingCompositeLineMapper.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/PatternMatchingCompositeLineMapper.java index ef91240350..662ba3b6f3 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/PatternMatchingCompositeLineMapper.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/PatternMatchingCompositeLineMapper.java @@ -18,6 +18,7 @@ import java.util.Map; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.LineMapper; import org.springframework.batch.item.file.transform.LineTokenizer; import org.springframework.batch.item.file.transform.PatternMatchingCompositeLineTokenizer; @@ -48,8 +49,9 @@ public class PatternMatchingCompositeLineMapper implements LineMapper, Ini private final PatternMatchingCompositeLineTokenizer tokenizer = new PatternMatchingCompositeLineTokenizer(); - private PatternMatcher> patternMatcher; + private @Nullable PatternMatcher> patternMatcher; + @SuppressWarnings("DataFlowIssue") @Override public T mapLine(String line, int lineNumber) throws Exception { return patternMatcher.match(line).mapFieldSet(this.tokenizer.tokenize(line)); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/RecordFieldSetMapper.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/RecordFieldSetMapper.java index 0eb449dab4..4684763e0f 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/RecordFieldSetMapper.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/RecordFieldSetMapper.java @@ -17,6 +17,7 @@ import java.lang.reflect.Constructor; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.transform.FieldSet; import org.springframework.beans.BeanUtils; import org.springframework.beans.SimpleTypeConverter; @@ -40,9 +41,9 @@ public class RecordFieldSetMapper implements FieldSetMapper { private final Constructor mappedConstructor; - private String[] constructorParameterNames; + private final @Nullable String[] constructorParameterNames; - private Class[] constructorParameterTypes; + private final Class[] constructorParameterTypes; /** * Create a new {@link RecordFieldSetMapper}. @@ -75,14 +76,11 @@ public T mapFieldSet(FieldSet fieldSet) { Assert.isTrue(fieldSet.getFieldCount() == this.constructorParameterNames.length, "Fields count must be equal to record components count"); Assert.isTrue(fieldSet.hasNames(), "Field names must be specified"); - Object[] args = new Object[0]; - if (this.constructorParameterNames != null && this.constructorParameterTypes != null) { - args = new Object[this.constructorParameterNames.length]; - for (int i = 0; i < args.length; i++) { - String name = this.constructorParameterNames[i]; - Class type = this.constructorParameterTypes[i]; - args[i] = this.typeConverter.convertIfNecessary(fieldSet.readRawString(name), type); - } + @Nullable Object[] args = new Object[this.constructorParameterNames.length]; + for (int i = 0; i < args.length; i++) { + String name = this.constructorParameterNames[i]; + Class type = this.constructorParameterTypes[i]; + args[i] = this.typeConverter.convertIfNecessary(fieldSet.readRawString(name), type); } return BeanUtils.instantiateClass(this.mappedConstructor, args); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/package-info.java index 3405d55d18..0fc1065610 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/mapping/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of io file support mapping concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.file.mapping; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/package-info.java index 4365cd486d..ef31af1d82 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of io file concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.file; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/DefaultRecordSeparatorPolicy.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/DefaultRecordSeparatorPolicy.java index e188044f5c..918ad80848 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/DefaultRecordSeparatorPolicy.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/DefaultRecordSeparatorPolicy.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2023 the original author or authors. + * Copyright 2006-2025 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. @@ -16,6 +16,7 @@ package org.springframework.batch.item.file.separator; +import org.jspecify.annotations.Nullable; import org.springframework.util.StringUtils; /** @@ -24,7 +25,7 @@ * * @author Dave Syer * @author Mahmoud Ben Hassine - * + * @author Stefano Cordio */ public class DefaultRecordSeparatorPolicy extends SimpleRecordSeparatorPolicy { @@ -71,7 +72,7 @@ public void setQuoteCharacter(String quoteCharacter) { } /** - * Public setter for the continuation. Defaults to back slash. + * Public setter for the continuation. Defaults to backslash. * @param continuation the continuation to set */ public void setContinuation(String continuation) { @@ -79,22 +80,22 @@ public void setContinuation(String continuation) { } /** - * Return true if the line does not have unterminated quotes (delimited by "), and - * does not end with a continuation marker ('\'). The test for the continuation marker - * ignores whitespace at the end of the line. + * Return true if the line does not have unterminated quotes (delimited by {@code "}), + * and does not end with a continuation marker ({@code \}). The test for the + * continuation marker ignores whitespace at the end of the line. * - * @see org.springframework.batch.item.file.separator.RecordSeparatorPolicy#isEndOfRecord(java.lang.String) + * @see RecordSeparatorPolicy#isEndOfRecord(String) */ @Override - public boolean isEndOfRecord(String line) { + public boolean isEndOfRecord(@Nullable String line) { return !isQuoteUnterminated(line) && !isContinued(line); } /** - * If we are in an unterminated quote, add a line separator. Otherwise remove the + * If we are in an unterminated quote, add a line separator. Otherwise, remove the * continuation marker (plus whitespace at the end) if it is there. * - * @see org.springframework.batch.item.file.separator.SimpleRecordSeparatorPolicy#preProcess(java.lang.String) + * @see SimpleRecordSeparatorPolicy#preProcess(String) */ @Override public String preProcess(String line) { @@ -113,8 +114,8 @@ public String preProcess(String line) { * @param line the line to check * @return true if the quote is unterminated, false otherwise */ - private boolean isQuoteUnterminated(String line) { - return StringUtils.countOccurrencesOf(line, quoteCharacter) % 2 != 0; + private boolean isQuoteUnterminated(@Nullable String line) { + return line != null && StringUtils.countOccurrencesOf(line, quoteCharacter) % 2 != 0; } /** @@ -123,11 +124,8 @@ private boolean isQuoteUnterminated(String line) { * @param line the line to check * @return true if the line ends with the continuation marker, false otherwise */ - private boolean isContinued(String line) { - if (line == null) { - return false; - } - return line.trim().endsWith(continuation); + private boolean isContinued(@Nullable String line) { + return line != null && line.trim().endsWith(continuation); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/JsonRecordSeparatorPolicy.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/JsonRecordSeparatorPolicy.java index 1571685396..ac8f301193 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/JsonRecordSeparatorPolicy.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/JsonRecordSeparatorPolicy.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.file.separator; +import org.jspecify.annotations.Nullable; import org.springframework.util.StringUtils; /** @@ -42,8 +43,8 @@ public class JsonRecordSeparatorPolicy extends SimpleRecordSeparatorPolicy { * @see RecordSeparatorPolicy#isEndOfRecord(String) */ @Override - public boolean isEndOfRecord(String line) { - return StringUtils.countOccurrencesOf(line, "{") == StringUtils.countOccurrencesOf(line, "}") + public boolean isEndOfRecord(@Nullable String line) { + return line != null && StringUtils.countOccurrencesOf(line, "{") == StringUtils.countOccurrencesOf(line, "}") && line.trim().endsWith("}"); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/RecordSeparatorPolicy.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/RecordSeparatorPolicy.java index db1135d2c4..72742d8b07 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/RecordSeparatorPolicy.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/RecordSeparatorPolicy.java @@ -16,6 +16,8 @@ package org.springframework.batch.item.file.separator; +import org.jspecify.annotations.Nullable; + import java.io.BufferedReader; /** @@ -36,14 +38,14 @@ public interface RecordSeparatorPolicy { * @param record a String without a newline character at the end. * @return true if this line is a complete record. */ - boolean isEndOfRecord(String record); + boolean isEndOfRecord(@Nullable String record); /** * Give the policy a chance to post-process a complete record, e.g. remove a suffix. * @param record the complete record. - * @return a modified version of the record if desired. + * @return a modified version of the record if desired, potentially null. */ - String postProcess(String record); + @Nullable String postProcess(String record); /** * Pre-process a record before another line is appended, in the case of a multi-line diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/SimpleRecordSeparatorPolicy.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/SimpleRecordSeparatorPolicy.java index b26e32e559..6affe64a4d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/SimpleRecordSeparatorPolicy.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/SimpleRecordSeparatorPolicy.java @@ -16,6 +16,8 @@ package org.springframework.batch.item.file.separator; +import org.jspecify.annotations.Nullable; + /** * Simplest possible {@link RecordSeparatorPolicy} - treats all lines as record endings. * @@ -30,7 +32,7 @@ public class SimpleRecordSeparatorPolicy implements RecordSeparatorPolicy { * @see org.springframework.batch.item.file.separator.RecordSeparatorPolicy#isEndOfRecord(java.lang.String) */ @Override - public boolean isEndOfRecord(String line) { + public boolean isEndOfRecord(@Nullable String line) { return true; } @@ -39,7 +41,7 @@ public boolean isEndOfRecord(String line) { * @see org.springframework.batch.item.file.separator.RecordSeparatorPolicy#postProcess(java.lang.String) */ @Override - public String postProcess(String record) { + public @Nullable String postProcess(String record) { return record; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/SuffixRecordSeparatorPolicy.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/SuffixRecordSeparatorPolicy.java index d8c1bb227a..e49b332624 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/SuffixRecordSeparatorPolicy.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/SuffixRecordSeparatorPolicy.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2007 the original author or authors. + * Copyright 2006-2025 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. @@ -16,12 +16,14 @@ package org.springframework.batch.item.file.separator; +import org.jspecify.annotations.Nullable; + /** * A {@link RecordSeparatorPolicy} that looks for an exact match for a String at the end * of a line (e.g. a semicolon). * * @author Dave Syer - * + * @author Stefano Cordio */ public class SuffixRecordSeparatorPolicy extends DefaultRecordSeparatorPolicy { @@ -52,14 +54,13 @@ public void setIgnoreWhitespace(boolean ignoreWhitespace) { } /** - * Return true if the line ends with the specified substring. By default whitespace is - * trimmed before the comparison. Also returns true if the line is null, but not if it - * is empty. + * Return true if the line ends with the specified substring. By default, whitespace + * is trimmed before the comparison. * - * @see org.springframework.batch.item.file.separator.RecordSeparatorPolicy#isEndOfRecord(java.lang.String) + * @see RecordSeparatorPolicy#isEndOfRecord(String) */ @Override - public boolean isEndOfRecord(String line) { + public boolean isEndOfRecord(@Nullable String line) { if (line == null) { return true; } @@ -70,10 +71,10 @@ public boolean isEndOfRecord(String line) { /** * Remove the suffix from the end of the record. * - * @see org.springframework.batch.item.file.separator.SimpleRecordSeparatorPolicy#postProcess(java.lang.String) + * @see SimpleRecordSeparatorPolicy#postProcess(String) */ @Override - public String postProcess(String record) { + public @Nullable String postProcess(@Nullable String record) { if (record == null) { return null; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/package-info.java index 87f48e90e3..c37d9f9ef8 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/separator/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of io file support separator concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.file.separator; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/AbstractLineTokenizer.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/AbstractLineTokenizer.java index b4fa1572fe..603e8ff2e9 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/AbstractLineTokenizer.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/AbstractLineTokenizer.java @@ -17,12 +17,12 @@ package org.springframework.batch.item.file.transform; import java.util.ArrayList; -import java.util.Arrays; import java.util.List; -import org.springframework.lang.Nullable; import org.springframework.util.StringUtils; +import org.jspecify.annotations.Nullable; + /** * Abstract class handling common concerns of various {@link LineTokenizer} * implementations such as dealing with names and actual construction of {@link FieldSet} @@ -32,15 +32,16 @@ * @author Lucas Ward * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public abstract class AbstractLineTokenizer implements LineTokenizer { + private static final String EMPTY_TOKEN = ""; + protected String[] names = new String[0]; private boolean strict = true; - private final String emptyToken = ""; - private FieldSetFactory fieldSetFactory = new DefaultFieldSetFactory(); /** @@ -77,21 +78,16 @@ public void setFieldSetFactory(FieldSetFactory fieldSetFactory) { * @param names names of each column */ public void setNames(String... names) { - if (names == null) { - this.names = null; - } - else { - boolean valid = false; - for (String name : names) { - if (StringUtils.hasText(name)) { - valid = true; - break; - } + boolean valid = false; + for (String name : names) { + if (StringUtils.hasText(name)) { + valid = true; + break; } + } - if (valid) { - this.names = Arrays.asList(names).toArray(new String[names.length]); - } + if (valid) { + this.names = names.clone(); } } @@ -100,10 +96,7 @@ public void setNames(String... names) { * @see #setNames(String[]) */ public boolean hasNames() { - if (names != null && names.length > 0) { - return true; - } - return false; + return names.length > 0; } /** @@ -125,7 +118,7 @@ public FieldSet tokenize(@Nullable String line) { adjustTokenCountIfNecessary(tokens); } - String[] values = tokens.toArray(new String[tokens.size()]); + String[] values = tokens.toArray(new String[0]); if (names.length == 0) { return fieldSetFactory.create(values); @@ -156,7 +149,7 @@ private void adjustTokenCountIfNecessary(List tokens) { // add empty tokens until the token list size matches // the expected number of tokens for (int i = 0; i < (nameLength - tokensSize); i++) { - tokens.add(emptyToken); + tokens.add(EMPTY_TOKEN); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/BeanWrapperFieldExtractor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/BeanWrapperFieldExtractor.java index a7986901fa..f7c5142d48 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/BeanWrapperFieldExtractor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/BeanWrapperFieldExtractor.java @@ -19,6 +19,7 @@ import java.util.ArrayList; import java.util.List; +import org.jspecify.annotations.Nullable; import org.springframework.beans.BeanWrapper; import org.springframework.beans.BeanWrapperImpl; import org.springframework.beans.factory.InitializingBean; @@ -33,7 +34,7 @@ */ public class BeanWrapperFieldExtractor implements FieldExtractor, InitializingBean { - private String[] names; + private String @Nullable [] names; /** * @param names field names to be extracted by the {@link #extract(Object)} method. @@ -43,9 +44,10 @@ public void setNames(String[] names) { this.names = names.clone(); } + @SuppressWarnings("DataFlowIssue") @Override public Object[] extract(T item) { - List values = new ArrayList<>(); + List<@Nullable Object> values = new ArrayList<>(); BeanWrapper bw = new BeanWrapperImpl(item); for (String propertyName : this.names) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DefaultFieldSet.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DefaultFieldSet.java index c1c1d1b489..fbc4c0adf7 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DefaultFieldSet.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DefaultFieldSet.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2024 the original author or authors. + * Copyright 2006-2025 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. @@ -26,10 +26,12 @@ import java.util.Date; import java.util.List; import java.util.Locale; +import java.util.Objects; import java.util.Properties; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; + +import org.jspecify.annotations.Nullable; import org.springframework.util.StringUtils; /** @@ -40,6 +42,7 @@ * @author Rob Harrop * @author Dave Syer * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public class DefaultFieldSet implements FieldSet { @@ -49,77 +52,61 @@ public class DefaultFieldSet implements FieldSet { private NumberFormat numberFormat; - private String grouping; + private @Nullable String grouping; - private String decimal; + private @Nullable String decimal; /** * The fields wrapped by this 'FieldSet' instance. */ - private final String[] tokens; - - private List names; - - /** - * The {@link NumberFormat} to use for parsing numbers. If unset the {@link Locale#US} - * will be used ('.' as decimal place). - * @param numberFormat the {@link NumberFormat} to use for number parsing - */ - public final void setNumberFormat(NumberFormat numberFormat) { - this.numberFormat = numberFormat; - if (numberFormat instanceof DecimalFormat decimalFormat) { - grouping = String.valueOf(decimalFormat.getDecimalFormatSymbols().getGroupingSeparator()); - decimal = String.valueOf(decimalFormat.getDecimalFormatSymbols().getDecimalSeparator()); - } - } + private final @Nullable String[] tokens; - private static NumberFormat getDefaultNumberFormat() { - return NumberFormat.getInstance(Locale.US); - } + private @Nullable List names; /** - * The {@link DateFormat} to use for parsing dates. If unset the default pattern is - * ISO standard yyyy-MM-dd. - * @param dateFormat the {@link DateFormat} to use for date parsing + * Create a FieldSet with anonymous tokens. + *

+ * They can only be retrieved by column number. + * @param tokens the token values + * @see FieldSet#readString(int) */ - public void setDateFormat(DateFormat dateFormat) { - this.dateFormat = dateFormat; - } - - private static DateFormat getDefaultDateFormat() { - DateFormat dateFormat = new SimpleDateFormat(DEFAULT_DATE_PATTERN); - dateFormat.setLenient(false); - return dateFormat; + public DefaultFieldSet(@Nullable String @Nullable [] tokens) { + this(tokens, null, null); } /** - * Create a FieldSet with anonymous tokens. They can only be retrieved by column - * number. + * Create a FieldSet with anonymous tokens. + *

+ * They can only be retrieved by column number. * @param tokens the token values * @param dateFormat the {@link DateFormat} to use * @param numberFormat the {@link NumberFormat} to use * @see FieldSet#readString(int) * @since 5.2 */ - public DefaultFieldSet(String[] tokens, @Nullable DateFormat dateFormat, @Nullable NumberFormat numberFormat) { - this.tokens = tokens == null ? null : tokens.clone(); - setDateFormat(dateFormat == null ? getDefaultDateFormat() : dateFormat); - setNumberFormat(numberFormat == null ? getDefaultNumberFormat() : numberFormat); + public DefaultFieldSet(@Nullable String @Nullable [] tokens, @Nullable DateFormat dateFormat, + @Nullable NumberFormat numberFormat) { + this.tokens = tokens != null ? tokens.clone() : new String[0]; + this.dateFormat = dateFormat != null ? dateFormat : getDefaultDateFormat(); + setNumberFormat(numberFormat != null ? numberFormat : getDefaultNumberFormat()); } /** - * Create a FieldSet with anonymous tokens. They can only be retrieved by column - * number. + * Create a FieldSet with named tokens. + *

+ * The token values can then be retrieved either by name or by column number. * @param tokens the token values - * @see FieldSet#readString(int) + * @param names the names of the tokens + * @see FieldSet#readString(String) */ - public DefaultFieldSet(String[] tokens) { - this(tokens, null, null); + public DefaultFieldSet(@Nullable String[] tokens, String[] names) { + this(tokens, names, getDefaultDateFormat(), getDefaultNumberFormat()); } /** - * Create a FieldSet with named tokens. The token values can then be retrieved either - * by name or by column number. + * Create a FieldSet with named tokens. + *

+ * The token values can then be retrieved either by name or by column number. * @param tokens the token values * @param names the names of the tokens * @param dateFormat the {@link DateFormat} to use @@ -127,7 +114,7 @@ public DefaultFieldSet(String[] tokens) { * @see FieldSet#readString(String) * @since 5.2 */ - public DefaultFieldSet(String[] tokens, String[] names, @Nullable DateFormat dateFormat, + public DefaultFieldSet(@Nullable String[] tokens, String[] names, @Nullable DateFormat dateFormat, @Nullable NumberFormat numberFormat) { Assert.notNull(tokens, "Tokens must not be null"); Assert.notNull(names, "Names must not be null"); @@ -137,19 +124,42 @@ public DefaultFieldSet(String[] tokens, String[] names, @Nullable DateFormat dat } this.tokens = tokens.clone(); this.names = Arrays.asList(names); - setDateFormat(dateFormat == null ? getDefaultDateFormat() : dateFormat); - setNumberFormat(numberFormat == null ? getDefaultNumberFormat() : numberFormat); + this.dateFormat = dateFormat != null ? dateFormat : getDefaultDateFormat(); + setNumberFormat(numberFormat != null ? numberFormat : getDefaultNumberFormat()); + } + + private static DateFormat getDefaultDateFormat() { + DateFormat dateFormat = new SimpleDateFormat(DEFAULT_DATE_PATTERN); + dateFormat.setLenient(false); + return dateFormat; + } + + private static NumberFormat getDefaultNumberFormat() { + return NumberFormat.getInstance(Locale.US); } /** - * Create a FieldSet with named tokens. The token values can then be retrieved either - * by name or by column number. - * @param tokens the token values - * @param names the names of the tokens - * @see FieldSet#readString(String) + * The {@link DateFormat} to use for parsing dates. + *

+ * If unset, the default pattern is ISO standard yyyy-MM-dd. + * @param dateFormat the {@link DateFormat} to use for date parsing */ - public DefaultFieldSet(String[] tokens, String[] names) { - this(tokens, names, null, null); + public void setDateFormat(DateFormat dateFormat) { + this.dateFormat = dateFormat; + } + + /** + * The {@link NumberFormat} to use for parsing numbers. + *

+ * If unset, {@link Locale#US} will be used ('.' as decimal place). + * @param numberFormat the {@link NumberFormat} to use for number parsing + */ + public final void setNumberFormat(NumberFormat numberFormat) { + this.numberFormat = numberFormat; + if (numberFormat instanceof DecimalFormat decimalFormat) { + this.grouping = String.valueOf(decimalFormat.getDecimalFormatSymbols().getGroupingSeparator()); + this.decimal = String.valueOf(decimalFormat.getDecimalFormatSymbols().getDecimalSeparator()); + } } @Override @@ -166,27 +176,27 @@ public boolean hasNames() { } @Override - public String[] getValues() { + public @Nullable String[] getValues() { return tokens.clone(); } @Override - public String readString(int index) { + public @Nullable String readString(int index) { return readAndTrim(index); } @Override - public String readString(String name) { + public @Nullable String readString(String name) { return readString(indexOf(name)); } @Override - public String readRawString(int index) { + public @Nullable String readRawString(int index) { return tokens[index]; } @Override - public String readRawString(String name) { + public @Nullable String readRawString(String name) { return readRawString(indexOf(name)); } @@ -203,10 +213,7 @@ public boolean readBoolean(String name) { @Override public boolean readBoolean(int index, String trueValue) { Assert.notNull(trueValue, "'trueValue' cannot be null."); - - String value = readAndTrim(index); - - return trueValue.equals(value); + return trueValue.equals(readAndTrim(index)); } @Override @@ -216,10 +223,8 @@ public boolean readBoolean(String name, String trueValue) { @Override public char readChar(int index) { - String value = readAndTrim(index); - + String value = Objects.requireNonNull(readAndTrim(index)); Assert.isTrue(value.length() == 1, "Cannot convert field value '" + value + "' to char."); - return value.charAt(0); } @@ -230,7 +235,7 @@ public char readChar(String name) { @Override public byte readByte(int index) { - return Byte.parseByte(readAndTrim(index)); + return Byte.parseByte(Objects.requireNonNull(readAndTrim(index))); } @Override @@ -240,7 +245,7 @@ public byte readByte(String name) { @Override public short readShort(int index) { - return Short.parseShort(readAndTrim(index)); + return Short.parseShort(Objects.requireNonNull(readAndTrim(index))); } @Override @@ -250,7 +255,7 @@ public short readShort(String name) { @Override public int readInt(int index) { - return parseNumber(readAndTrim(index)).intValue(); + return parseNumber(Objects.requireNonNull(readAndTrim(index))).intValue(); } @Override @@ -272,7 +277,7 @@ public int readInt(String name, int defaultValue) { @Override public long readLong(int index) { - return parseNumber(readAndTrim(index)).longValue(); + return parseNumber(Objects.requireNonNull(readAndTrim(index))).longValue(); } @Override @@ -283,7 +288,6 @@ public long readLong(String name) { @Override public long readLong(int index, long defaultValue) { String value = readAndTrim(index); - return StringUtils.hasLength(value) ? Long.parseLong(value) : defaultValue; } @@ -294,7 +298,7 @@ public long readLong(String name, long defaultValue) { @Override public float readFloat(int index) { - return parseNumber(readAndTrim(index)).floatValue(); + return parseNumber(Objects.requireNonNull(readAndTrim(index))).floatValue(); } @Override @@ -304,7 +308,7 @@ public float readFloat(String name) { @Override public double readDouble(int index) { - return parseNumber(readAndTrim(index)).doubleValue(); + return parseNumber(Objects.requireNonNull(readAndTrim(index))).doubleValue(); } @Override @@ -313,17 +317,17 @@ public double readDouble(String name) { } @Override - public BigDecimal readBigDecimal(int index) { + public @Nullable BigDecimal readBigDecimal(int index) { return readBigDecimal(index, null); } @Override - public BigDecimal readBigDecimal(String name) { + public @Nullable BigDecimal readBigDecimal(String name) { return readBigDecimal(name, null); } @Override - public BigDecimal readBigDecimal(int index, BigDecimal defaultValue) { + public @Nullable BigDecimal readBigDecimal(int index, @Nullable BigDecimal defaultValue) { String candidate = readAndTrim(index); if (!StringUtils.hasText(candidate)) { @@ -331,8 +335,7 @@ public BigDecimal readBigDecimal(int index, BigDecimal defaultValue) { } try { - String result = removeSeparators(candidate); - return new BigDecimal(result); + return new BigDecimal(removeSeparators(candidate)); } catch (NumberFormatException e) { throw new NumberFormatException("Unparseable number: " + candidate); @@ -344,7 +347,7 @@ private String removeSeparators(String candidate) { } @Override - public BigDecimal readBigDecimal(String name, BigDecimal defaultValue) { + public @Nullable BigDecimal readBigDecimal(String name, @Nullable BigDecimal defaultValue) { try { return readBigDecimal(indexOf(name), defaultValue); } @@ -358,7 +361,7 @@ public BigDecimal readBigDecimal(String name, BigDecimal defaultValue) { @Override public Date readDate(int index) { - return parseDate(readAndTrim(index), dateFormat); + return parseDate(Objects.requireNonNull(readAndTrim(index)), dateFormat); } @Override @@ -391,7 +394,7 @@ public Date readDate(String name, Date defaultValue) { public Date readDate(int index, String pattern) { SimpleDateFormat sdf = new SimpleDateFormat(pattern); sdf.setLenient(false); - return parseDate(readAndTrim(index), sdf); + return parseDate(Objects.requireNonNull(readAndTrim(index)), sdf); } @Override @@ -430,16 +433,9 @@ public int getFieldCount() { * @param index the offset in the token array to obtain the value to be trimmed. * @return null if the field value is null. */ - @Nullable - protected String readAndTrim(int index) { + protected @Nullable String readAndTrim(int index) { String value = tokens[index]; - - if (value != null) { - return value.trim(); - } - else { - return null; - } + return value != null ? value.trim() : null; } /** @@ -466,22 +462,16 @@ public String toString() { return getProperties().toString(); } - return tokens == null ? "" : Arrays.asList(tokens).toString(); + return Arrays.toString(tokens); } /** - * @see java.lang.Object#equals(java.lang.Object) + * @see Object#equals(Object) */ @Override public boolean equals(Object object) { if (object instanceof DefaultFieldSet fs) { - - if (this.tokens == null) { - return fs.tokens == null; - } - else { - return Arrays.equals(this.tokens, fs.tokens); - } + return Arrays.equals(this.tokens, fs.tokens); } return false; @@ -490,7 +480,7 @@ public boolean equals(Object object) { @Override public int hashCode() { // this algorithm was taken from java 1.5 jdk Arrays.hashCode(Object[]) - if (tokens == null) { + if (tokens.length == 0) { return 0; } @@ -518,27 +508,21 @@ public Properties getProperties() { return props; } - private Number parseNumber(String candidate) { + private Number parseNumber(String input) { try { - return numberFormat.parse(candidate); + return numberFormat.parse(input); } catch (ParseException e) { - throw new NumberFormatException("Unparseable number: " + candidate); + throw new NumberFormatException("Unparseable number: " + input); } } - private Date parseDate(String readAndTrim, DateFormat dateFormat) { + private Date parseDate(String input, DateFormat dateFormat) { try { - return dateFormat.parse(readAndTrim); + return dateFormat.parse(input); } catch (ParseException e) { - String pattern; - if (dateFormat instanceof SimpleDateFormat simpleDateFormat) { - pattern = simpleDateFormat.toPattern(); - } - else { - pattern = dateFormat.toString(); - } + String pattern = dateFormat instanceof SimpleDateFormat sdf ? sdf.toPattern() : dateFormat.toString(); throw new IllegalArgumentException(e.getMessage() + ", format: [" + pattern + "]"); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DefaultFieldSetFactory.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DefaultFieldSetFactory.java index fe3dd0989c..d3da651b9f 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DefaultFieldSetFactory.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DefaultFieldSetFactory.java @@ -1,5 +1,5 @@ /* - * Copyright 2009-2024 the original author or authors. + * Copyright 2009-2025 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. @@ -18,7 +18,7 @@ import java.text.DateFormat; import java.text.NumberFormat; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Default implementation of {@link FieldSetFactory} with no special knowledge of the @@ -26,13 +26,13 @@ * * @author Dave Syer * @author Mahmoud Ben Hassine - * + * @author Stefano Cordio */ public class DefaultFieldSetFactory implements FieldSetFactory { - private DateFormat dateFormat; + private @Nullable DateFormat dateFormat; - private NumberFormat numberFormat; + private @Nullable NumberFormat numberFormat; /** * Default constructor. @@ -46,27 +46,29 @@ public DefaultFieldSetFactory() { * @param numberFormat the {@link NumberFormat} to use for parsing numbers * @since 5.2 */ - public DefaultFieldSetFactory(@Nullable DateFormat dateFormat, @Nullable NumberFormat numberFormat) { + public DefaultFieldSetFactory(DateFormat dateFormat, NumberFormat numberFormat) { this.dateFormat = dateFormat; this.numberFormat = numberFormat; } /** - * The {@link NumberFormat} to use for parsing numbers. If unset then - * {@link java.util.Locale#US} will be used. - * @param numberFormat the {@link NumberFormat} to use for number parsing + * The {@link DateFormat} to use for parsing dates. + *

+ * If unset the default pattern is ISO standard yyyy-MM-dd. + * @param dateFormat the {@link DateFormat} to use for date parsing */ - public void setNumberFormat(NumberFormat numberFormat) { - this.numberFormat = numberFormat; + public void setDateFormat(DateFormat dateFormat) { + this.dateFormat = dateFormat; } /** - * The {@link DateFormat} to use for parsing dates. If unset the default pattern is - * ISO standard yyyy-MM-dd. - * @param dateFormat the {@link DateFormat} to use for date parsing + * The {@link NumberFormat} to use for parsing numbers. + *

+ * If unset, {@link java.util.Locale#US} will be used. + * @param numberFormat the {@link NumberFormat} to use for number parsing */ - public void setDateFormat(DateFormat dateFormat) { - this.dateFormat = dateFormat; + public void setNumberFormat(NumberFormat numberFormat) { + this.numberFormat = numberFormat; } /** diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DelimitedLineTokenizer.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DelimitedLineTokenizer.java index bb14e462dd..56259edb43 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DelimitedLineTokenizer.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/DelimitedLineTokenizer.java @@ -17,9 +17,9 @@ package org.springframework.batch.item.file.transform; import java.util.ArrayList; -import java.util.Collection; import java.util.HashSet; import java.util.List; +import java.util.Set; import org.springframework.beans.factory.InitializingBean; import org.springframework.util.Assert; @@ -63,7 +63,7 @@ public class DelimitedLineTokenizer extends AbstractLineTokenizer implements Ini private String escapedQuoteString; - private Collection includedFields = null; + private final Set includedFields = new HashSet<>(); /** * Create a new instance of the {@link DelimitedLineTokenizer} class for the common @@ -80,6 +80,7 @@ public DelimitedLineTokenizer() { * Create a new instance of the {@link DelimitedLineTokenizer} class. * @param delimiter the desired delimiter. This is required */ + @SuppressWarnings("NullAway") public DelimitedLineTokenizer(String delimiter) { Assert.notNull(delimiter, "A delimiter is required"); Assert.state(!delimiter.equals(String.valueOf(DEFAULT_QUOTE_CHARACTER)), @@ -98,14 +99,16 @@ public void setDelimiter(String delimiter) { } /** - * The fields to include in the output by position (starting at 0). By default all + * The fields to include in the output by position (starting at 0). By default, all * fields are included, but this property can be set to pick out only a few fields * from a larger set. Note that if field names are provided, their number must match * the number of included fields. * @param includedFields the included fields to set */ public void setIncludedFields(int... includedFields) { - this.includedFields = new HashSet<>(); + if (!this.includedFields.isEmpty()) { + this.includedFields.clear(); + } for (int i : includedFields) { this.includedFields.add(i); } @@ -161,7 +164,7 @@ else if (!isEnd) { endPosition = (endPosition - delimiter.length()) + 1; } - if (includedFields == null || includedFields.contains(fieldCount)) { + if (includedFields.isEmpty() || includedFields.contains(fieldCount)) { String value = substringWithTrimmedWhitespaceAndQuotesIfQuotesPresent(line, lastCut, endPosition); tokens.add(value); } @@ -169,7 +172,7 @@ else if (!isEnd) { fieldCount++; if (isEnd && isDelimiter) { - if (includedFields == null || includedFields.contains(fieldCount)) { + if (includedFields.isEmpty() || includedFields.contains(fieldCount)) { tokens.add(""); } fieldCount++; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FieldExtractor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FieldExtractor.java index b9c48ce0f8..6886ea49c5 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FieldExtractor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FieldExtractor.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.item.file.transform; +import org.jspecify.annotations.Nullable; + /** * This class will convert an object to an array of its parts. * @@ -28,6 +30,6 @@ public interface FieldExtractor { * @param item the object that contains the information to be extracted. * @return an array containing item's parts */ - Object[] extract(T item); + @Nullable Object[] extract(T item); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FieldSet.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FieldSet.java index 42c9153f52..86b8307a5b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FieldSet.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FieldSet.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.item.file.transform; +import org.jspecify.annotations.Nullable; + import java.math.BigDecimal; import java.sql.ResultSet; import java.util.Date; @@ -47,7 +49,7 @@ public interface FieldSet { /** * @return fields wrapped by this 'FieldSet' instance as String values. */ - String[] getValues(); + @Nullable String[] getValues(); /** * Read the {@link String} value at index 'index'. @@ -55,14 +57,14 @@ public interface FieldSet { * @return {@link String} containing the value at the index. * @throws IndexOutOfBoundsException if the {@code index} is out of bounds. */ - String readString(int index); + @Nullable String readString(int index); /** * Read the {@link String} value from column with given 'name'. * @param name the field {@code name}. * @return {@link String} containing the value from the specified {@code name}. */ - String readString(String name); + @Nullable String readString(String name); /** * Read the {@link String} value at index 'index' including trailing @@ -71,7 +73,7 @@ public interface FieldSet { * @return {@link String} containing the value from the specified {@code index}. * @throws IndexOutOfBoundsException if the {@code index} is out of bounds. */ - String readRawString(int index); + @Nullable String readRawString(int index); /** * Read the {@link String} value from column with given 'name' including @@ -79,7 +81,7 @@ public interface FieldSet { * @param name the field {@code name}. * @return {@link String} containing the value from the specified {@code name}. */ - String readRawString(String name); + @Nullable String readRawString(String name); /** * Read the 'boolean' value at index 'index'. @@ -105,7 +107,7 @@ public interface FieldSet { * case-sensitive. * @return boolean containing the value from the specified {@code index}. * @throws IndexOutOfBoundsException if the index is out of bounds, or if the supplied - * trueValue is null. + * {@code trueValue} is {@code null}. */ boolean readBoolean(int index, String trueValue); @@ -116,7 +118,7 @@ public interface FieldSet { * case-sensitive. * @return boolean containing the value from the specified {@code name}. * @throws IllegalArgumentException if a column with given {@code name} is not - * defined, or if the supplied trueValue is null. + * defined, or if the supplied {@code trueValue} is {@code null}. */ boolean readBoolean(String name, String trueValue); @@ -285,7 +287,7 @@ public interface FieldSet { * @return {@link BigDecimal} containing the value from the specified index. * @throws IndexOutOfBoundsException if the index is out of bounds. */ - BigDecimal readBigDecimal(int index); + @Nullable BigDecimal readBigDecimal(int index); /** * Read the {@link java.math.BigDecimal} value from column with given @@ -295,7 +297,7 @@ public interface FieldSet { * @throws IllegalArgumentException if a column with given {@code name} is not * defined. */ - BigDecimal readBigDecimal(String name); + @Nullable BigDecimal readBigDecimal(String name); /** * Read the {@link BigDecimal} value at index 'index', returning the @@ -306,7 +308,7 @@ public interface FieldSet { * @return {@link BigDecimal} containing the value from the specified index. * @throws IndexOutOfBoundsException if the index is out of bounds. */ - BigDecimal readBigDecimal(int index, BigDecimal defaultValue); + @Nullable BigDecimal readBigDecimal(int index, BigDecimal defaultValue); /** * Read the {@link BigDecimal} value from column with given 'name, @@ -318,7 +320,7 @@ public interface FieldSet { * @throws IllegalArgumentException if a column with given {@code name} is not * defined. */ - BigDecimal readBigDecimal(String name, BigDecimal defaultValue); + @Nullable BigDecimal readBigDecimal(String name, BigDecimal defaultValue); /** * Read the java.util.Date value in default format at designated column @@ -425,7 +427,7 @@ public interface FieldSet { * Construct name-value pairs from the field names and string values. Null values are * omitted. * @return some properties representing the field set. - * @throws IllegalStateException if the field name meta data is not available. + * @throws IllegalStateException if the field name metadata is not available. */ Properties getProperties(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FixedLengthTokenizer.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FixedLengthTokenizer.java index 8d27812a72..a35cc69520 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FixedLengthTokenizer.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FixedLengthTokenizer.java @@ -16,6 +16,9 @@ package org.springframework.batch.item.file.transform; +import org.jspecify.annotations.Nullable; +import org.springframework.util.Assert; + import java.util.ArrayList; import java.util.Arrays; import java.util.List; @@ -30,10 +33,11 @@ * @author Lucas Ward * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public class FixedLengthTokenizer extends AbstractLineTokenizer { - private Range[] ranges; + private Range @Nullable [] ranges; private int maxRange = 0; @@ -50,7 +54,7 @@ public class FixedLengthTokenizer extends AbstractLineTokenizer { * @param ranges the column ranges expected in the input */ public void setColumns(Range... ranges) { - this.ranges = Arrays.asList(ranges).toArray(new Range[ranges.length]); + this.ranges = ranges.clone(); calculateMaxRange(ranges); } @@ -60,7 +64,7 @@ public void setColumns(Range... ranges) { * always a min and max, such as: "1,4-20, 22" */ private void calculateMaxRange(Range[] ranges) { - if (ranges == null || ranges.length == 0) { + if (ranges.length == 0) { maxRange = 0; return; } @@ -95,6 +99,7 @@ private void calculateMaxRange(Range[] ranges) { */ @Override protected List doTokenize(String line) { + Assert.state(ranges != null, "ranges must not be null"); List tokens = new ArrayList<>(ranges.length); int lineLength; String token; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FlatFileFormatException.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FlatFileFormatException.java index 6a3b0a48ba..4cf48cb8ff 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FlatFileFormatException.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FlatFileFormatException.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.item.file.transform; +import org.jspecify.annotations.Nullable; + /** * Exception indicating that some type of error has occurred while attempting to parse a * line of input into tokens. @@ -26,7 +28,7 @@ */ public class FlatFileFormatException extends RuntimeException { - private String input; + private @Nullable String input; /** * Create a new {@link FlatFileFormatException} based on a message. @@ -61,7 +63,7 @@ public FlatFileFormatException(String message, Throwable cause) { * Retrieve the input that caused this exception. * @return String containing the input. */ - public String getInput() { + public @Nullable String getInput() { return input; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FormatterLineAggregator.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FormatterLineAggregator.java index aa37bcfda2..94b77df311 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FormatterLineAggregator.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/FormatterLineAggregator.java @@ -19,6 +19,7 @@ import java.util.Formatter; import java.util.Locale; +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** @@ -27,10 +28,11 @@ * * @see Formatter * @author Dave Syer + * @author Stefano Cordio */ public class FormatterLineAggregator extends ExtractorLineAggregator { - private String format; + private @Nullable String format; private Locale locale = Locale.getDefault(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/IncorrectTokenCountException.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/IncorrectTokenCountException.java index 3879948148..6a9db0cb14 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/IncorrectTokenCountException.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/IncorrectTokenCountException.java @@ -22,6 +22,7 @@ * @author Lucas Ward * @author "Michael Minella" * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 1.1 */ public class IncorrectTokenCountException extends FlatFileFormatException { @@ -30,13 +31,10 @@ public class IncorrectTokenCountException extends FlatFileFormatException { private final int expectedCount; - private String input; - public IncorrectTokenCountException(String message, int expectedCount, int actualCount, String input) { - super(message); + super(message, input); this.expectedCount = expectedCount; this.actualCount = actualCount; - this.input = input; } public IncorrectTokenCountException(String message, int expectedCount, int actualCount) { @@ -46,10 +44,10 @@ public IncorrectTokenCountException(String message, int expectedCount, int actua } public IncorrectTokenCountException(int expectedCount, int actualCount, String input) { - super("Incorrect number of tokens found in record: expected " + expectedCount + " actual " + actualCount); + super("Incorrect number of tokens found in record: expected " + expectedCount + " actual " + actualCount, + input); this.expectedCount = expectedCount; this.actualCount = actualCount; - this.input = input; } public IncorrectTokenCountException(int expectedCount, int actualCount) { @@ -66,13 +64,4 @@ public int getExpectedCount() { return expectedCount; } - /** - * @return the line that caused the exception - * @since 2.2.6 - */ - @Override - public String getInput() { - return input; - } - } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/LineTokenizer.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/LineTokenizer.java index 7157876c30..b92660b3fd 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/LineTokenizer.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/LineTokenizer.java @@ -16,7 +16,7 @@ package org.springframework.batch.item.file.transform; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Interface that is used by framework to split string obtained typically from a file into diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/PatternMatchingCompositeLineTokenizer.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/PatternMatchingCompositeLineTokenizer.java index eff7d28f64..75a570acbf 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/PatternMatchingCompositeLineTokenizer.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/PatternMatchingCompositeLineTokenizer.java @@ -19,8 +19,9 @@ import java.util.Map; import org.springframework.batch.support.PatternMatcher; + +import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -36,8 +37,9 @@ */ public class PatternMatchingCompositeLineTokenizer implements LineTokenizer, InitializingBean { - private PatternMatcher tokenizers = null; + private @Nullable PatternMatcher tokenizers; + @SuppressWarnings("DataFlowIssue") @Override public FieldSet tokenize(@Nullable String line) { return tokenizers.match(line).tokenize(line); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RangeArrayPropertyEditor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RangeArrayPropertyEditor.java index e382bfca8c..6e7f16e92c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RangeArrayPropertyEditor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RangeArrayPropertyEditor.java @@ -111,7 +111,7 @@ public String getAsText() { return sb.toString(); } - private void setMaxValues(final Range[] ranges) { + private void setMaxValues(Range[] ranges) { // Array of integers to track range values by index Integer[] c = new Integer[ranges.length]; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RecordFieldExtractor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RecordFieldExtractor.java index b9de4da2d0..a0b609b5e6 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RecordFieldExtractor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RecordFieldExtractor.java @@ -21,10 +21,12 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import java.util.Optional; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; +import org.jspecify.annotations.Nullable; + /** * This is a field extractor for a Java record. By default, it will extract all record * components, unless a subset is selected using {@link #setNames(String...)}. @@ -66,7 +68,7 @@ public void setNames(String... names) { public Object[] extract(T item) { List values = new ArrayList<>(); for (String componentName : this.names) { - RecordComponent recordComponent = getRecordComponentByName(componentName); + RecordComponent recordComponent = getRecordComponentByName(componentName).orElseThrow(); Object value; try { value = recordComponent.getAccessor().invoke(item); @@ -85,19 +87,17 @@ private List getRecordComponentNames() { private void validate(String[] names) { for (String name : names) { - if (getRecordComponentByName(name) == null) { + if (getRecordComponentByName(name).isEmpty()) { throw new IllegalArgumentException( "Component '" + name + "' is not defined in record " + targetType.getName()); } } } - @Nullable - private RecordComponent getRecordComponentByName(String name) { + private Optional getRecordComponentByName(String name) { return Arrays.stream(this.recordComponents) .filter(recordComponent -> recordComponent.getName().equals(name)) - .findFirst() - .orElse(null); + .findFirst(); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RegexLineTokenizer.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RegexLineTokenizer.java index 6128c84dec..23c347edec 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RegexLineTokenizer.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/RegexLineTokenizer.java @@ -21,6 +21,7 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** @@ -46,13 +47,15 @@ * * @see Matcher#group(int) * @author Costin Leau + * @author Stefano Cordio */ public class RegexLineTokenizer extends AbstractLineTokenizer { - private Pattern pattern; + private @Nullable Pattern pattern; @Override protected List doTokenize(String line) { + Assert.state(pattern != null, "pattern must be initialized"); Matcher matcher = pattern.matcher(line); boolean matchFound = matcher.find(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/package-info.java index 4c5085445f..cf1e0786d4 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/file/transform/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of io file support transform concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.file.transform; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/FunctionItemProcessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/FunctionItemProcessor.java index 07b5c1f5ee..63a6061c86 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/FunctionItemProcessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/FunctionItemProcessor.java @@ -18,7 +18,8 @@ import java.util.function.Function; import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** @@ -39,9 +40,8 @@ public FunctionItemProcessor(Function function) { this.function = function; } - @Nullable @Override - public O process(I item) throws Exception { + public @Nullable O process(I item) throws Exception { return this.function.apply(item); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/PredicateFilteringItemProcessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/PredicateFilteringItemProcessor.java index 553c85a797..b1d4a57196 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/PredicateFilteringItemProcessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/PredicateFilteringItemProcessor.java @@ -18,6 +18,8 @@ import java.util.function.Predicate; import org.springframework.batch.item.ItemProcessor; + +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** @@ -42,7 +44,7 @@ public PredicateFilteringItemProcessor(Predicate predicate) { } @Override - public T process(T item) throws Exception { + public @Nullable T process(T item) throws Exception { return this.predicate.test(item) ? null : item; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/package-info.java index f71c35ba6b..96c106a7a7 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/function/package-info.java @@ -19,7 +19,7 @@ * * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.item.function; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsItemReader.java index 60d5083b37..98fc02a1d6 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsItemReader.java @@ -18,11 +18,12 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemReader; import org.springframework.beans.factory.InitializingBean; import org.springframework.jms.core.JmsOperations; import org.springframework.jms.core.JmsTemplate; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import jakarta.jms.Message; @@ -43,9 +44,9 @@ public class JmsItemReader implements ItemReader, InitializingBean { protected Log logger = LogFactory.getLog(getClass()); - protected Class itemType; + protected @Nullable Class itemType; - protected JmsOperations jmsTemplate; + protected @Nullable JmsOperations jmsTemplate; /** * Setter for JMS template. @@ -72,10 +73,9 @@ public void setItemType(Class itemType) { this.itemType = itemType; } - @Nullable @Override - @SuppressWarnings("unchecked") - public T read() { + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) + public @Nullable T read() { if (itemType != null && itemType.isAssignableFrom(Message.class)) { return (T) jmsTemplate.receive(); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsItemWriter.java index f5576ae23a..91c9c1ead3 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsItemWriter.java @@ -19,6 +19,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemWriter; import org.springframework.jms.core.JmsOperations; @@ -41,7 +42,7 @@ public class JmsItemWriter implements ItemWriter { protected Log logger = LogFactory.getLog(getClass()); - private JmsOperations jmsTemplate; + private @Nullable JmsOperations jmsTemplate; /** * Setter for JMS template. @@ -60,6 +61,7 @@ public void setJmsTemplate(JmsOperations jmsTemplate) { * * @see org.springframework.batch.item.ItemWriter#write(Chunk) */ + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk items) throws Exception { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsMethodInvocationRecoverer.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsMethodInvocationRecoverer.java index dd9dcd6b3e..5c54602b44 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsMethodInvocationRecoverer.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/JmsMethodInvocationRecoverer.java @@ -17,8 +17,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; -import org.springframework.lang.Nullable; import org.springframework.retry.interceptor.MethodInvocationRecoverer; import org.springframework.jms.JmsException; import org.springframework.jms.core.JmsOperations; @@ -32,7 +32,7 @@ public class JmsMethodInvocationRecoverer implements MethodInvocationRecovere protected Log logger = LogFactory.getLog(getClass()); - private JmsOperations jmsTemplate; + private @Nullable JmsOperations jmsTemplate; /** * Setter for jms template. @@ -48,9 +48,9 @@ public void setJmsTemplate(JmsOperations jmsTemplate) { * * @see MethodInvocationRecoverer#recover(Object[], Throwable) */ + @SuppressWarnings("DataFlowIssue") @Override - @Nullable - public T recover(Object[] items, Throwable cause) { + public @Nullable T recover(Object[] items, Throwable cause) { try { for (Object item : items) { jmsTemplate.convertAndSend(item); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/JmsItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/JmsItemReaderBuilder.java index bec28d06c6..69cb4f9423 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/JmsItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/JmsItemReaderBuilder.java @@ -18,6 +18,7 @@ import jakarta.jms.Message; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.jms.JmsItemReader; import org.springframework.jms.core.JmsOperations; import org.springframework.util.Assert; @@ -27,13 +28,14 @@ * * @author Glenn Renfro * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 4.0 */ public class JmsItemReaderBuilder { - protected Class itemType; + protected @Nullable Class itemType; - protected JmsOperations jmsTemplate; + protected @Nullable JmsOperations jmsTemplate; /** * Establish the JMS template that will be used by the JmsItemReader. @@ -70,7 +72,9 @@ public JmsItemReader build() { Assert.notNull(this.jmsTemplate, "jmsTemplate is required."); JmsItemReader jmsItemReader = new JmsItemReader<>(); - jmsItemReader.setItemType(this.itemType); + if (this.itemType != null) { + jmsItemReader.setItemType(this.itemType); + } jmsItemReader.setJmsTemplate(this.jmsTemplate); return jmsItemReader; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/JmsItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/JmsItemWriterBuilder.java index de6ca57394..fa71e8b934 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/JmsItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/JmsItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.jms.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.jms.JmsItemWriter; import org.springframework.jms.core.JmsOperations; import org.springframework.util.Assert; @@ -28,7 +29,7 @@ */ public class JmsItemWriterBuilder { - private JmsOperations jmsTemplate; + private @Nullable JmsOperations jmsTemplate; /** * Establish the JMS template that will be used by the {@link JmsItemWriter}. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/package-info.java index ba5a0aa85a..b7df19842c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/builder/package-info.java @@ -18,8 +18,9 @@ * Builders for JMS item reader and writer. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.jms.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/package-info.java index 2e0e156aa6..e16f615749 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/jms/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.jms; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/GsonJsonObjectReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/GsonJsonObjectReader.java index c1b49fb4bd..5a2835da29 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/GsonJsonObjectReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/GsonJsonObjectReader.java @@ -25,10 +25,10 @@ import com.google.gson.JsonSyntaxException; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonToken; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ParseException; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -44,11 +44,11 @@ public class GsonJsonObjectReader implements JsonObjectReader { private final Class itemType; - private JsonReader jsonReader; - private Gson mapper; - private InputStream inputStream; + private @Nullable JsonReader jsonReader; + + private @Nullable InputStream inputStream; /** * Create a new {@link GsonJsonObjectReader} instance. @@ -83,9 +83,9 @@ public void open(Resource resource) throws Exception { this.jsonReader.beginArray(); } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - public T read() throws Exception { + public @Nullable T read() throws Exception { try { if (this.jsonReader.hasNext()) { return this.mapper.fromJson(this.jsonReader, this.itemType); @@ -97,12 +97,14 @@ public T read() throws Exception { return null; } + @SuppressWarnings("DataFlowIssue") @Override public void close() throws Exception { this.inputStream.close(); this.jsonReader.close(); } + @SuppressWarnings("DataFlowIssue") @Override public void jumpToItem(int itemIndex) throws Exception { for (int i = 0; i < itemIndex; i++) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JacksonJsonObjectReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JacksonJsonObjectReader.java index df1879240c..12b7369409 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JacksonJsonObjectReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JacksonJsonObjectReader.java @@ -22,10 +22,10 @@ import com.fasterxml.jackson.core.JsonParser; import com.fasterxml.jackson.core.JsonToken; import com.fasterxml.jackson.databind.ObjectMapper; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ParseException; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -41,11 +41,11 @@ public class JacksonJsonObjectReader implements JsonObjectReader { private final Class itemType; - private JsonParser jsonParser; - private ObjectMapper mapper; - private InputStream inputStream; + private @Nullable JsonParser jsonParser; + + private @Nullable InputStream inputStream; /** * Create a new {@link JacksonJsonObjectReader} instance. @@ -79,9 +79,9 @@ public void open(Resource resource) throws Exception { "The Json input stream must start with an array of Json objects"); } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - public T read() throws Exception { + public @Nullable T read() throws Exception { try { if (this.jsonParser.nextToken() == JsonToken.START_OBJECT) { return this.mapper.readValue(this.jsonParser, this.itemType); @@ -93,12 +93,14 @@ public T read() throws Exception { return null; } + @SuppressWarnings("DataFlowIssue") @Override public void close() throws Exception { this.inputStream.close(); this.jsonParser.close(); } + @SuppressWarnings("DataFlowIssue") @Override public void jumpToItem(int itemIndex) throws Exception { for (int i = 0; i < itemIndex; i++) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonFileItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonFileItemWriter.java index 9e849ca14c..7f23e166ee 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonFileItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonFileItemWriter.java @@ -18,6 +18,7 @@ import java.util.Iterator; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.support.AbstractFileItemWriter; import org.springframework.core.io.WritableResource; @@ -56,7 +57,7 @@ public class JsonFileItemWriter extends AbstractFileItemWriter { private static final char JSON_ARRAY_STOP = ']'; - private JsonObjectMarshaller jsonObjectMarshaller; + private @Nullable JsonObjectMarshaller jsonObjectMarshaller; /** * Create a new {@link JsonFileItemWriter} instance. @@ -93,6 +94,7 @@ public void setJsonObjectMarshaller(JsonObjectMarshaller jsonObjectMarshaller this.jsonObjectMarshaller = jsonObjectMarshaller; } + @SuppressWarnings("DataFlowIssue") @Override public String doWrite(Chunk items) { StringBuilder lines = new StringBuilder(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonItemReader.java index a7fdc830f1..0b3d8fec10 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonItemReader.java @@ -18,12 +18,12 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemStreamReader; import org.springframework.batch.item.file.ResourceAwareItemReaderItemStream; import org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -55,9 +55,9 @@ public class JsonItemReader extends AbstractItemCountingItemStreamItemReader< private static final Log LOGGER = LogFactory.getLog(JsonItemReader.class); - private Resource resource; + private @Nullable Resource resource; - private JsonObjectReader jsonObjectReader; + private @Nullable JsonObjectReader jsonObjectReader; private boolean strict = true; @@ -105,9 +105,9 @@ public void setResource(Resource resource) { this.resource = resource; } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { return jsonObjectReader.read(); } @@ -132,11 +132,13 @@ protected void doOpen() throws Exception { this.jsonObjectReader.open(this.resource); } + @SuppressWarnings("DataFlowIssue") @Override protected void doClose() throws Exception { this.jsonObjectReader.close(); } + @SuppressWarnings("DataFlowIssue") @Override protected void jumpToItem(int itemIndex) throws Exception { this.jsonObjectReader.jumpToItem(itemIndex); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonObjectReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonObjectReader.java index d143b71c8d..75a3685502 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonObjectReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/JsonObjectReader.java @@ -16,8 +16,9 @@ package org.springframework.batch.item.json; +import org.jspecify.annotations.Nullable; + import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; /** * Strategy interface for Json readers. Implementations are expected to use a streaming @@ -44,8 +45,7 @@ default void open(Resource resource) throws Exception { * @return the next object or {@code null} if the resource is exhausted * @throws Exception if unable to read the next object */ - @Nullable - T read() throws Exception; + @Nullable T read() throws Exception; /** * Close the input resource. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/JsonFileItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/JsonFileItemWriterBuilder.java index e92dec952c..2b456673f6 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/JsonFileItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/JsonFileItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.json.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.FlatFileFooterCallback; import org.springframework.batch.item.file.FlatFileHeaderCallback; import org.springframework.batch.item.json.JsonFileItemWriter; @@ -32,15 +33,15 @@ */ public class JsonFileItemWriterBuilder { - private WritableResource resource; + private @Nullable WritableResource resource; - private JsonObjectMarshaller jsonObjectMarshaller; + private @Nullable JsonObjectMarshaller jsonObjectMarshaller; - private FlatFileHeaderCallback headerCallback; + private @Nullable FlatFileHeaderCallback headerCallback; - private FlatFileFooterCallback footerCallback; + private @Nullable FlatFileFooterCallback footerCallback; - private String name; + private @Nullable String name; private String encoding = JsonFileItemWriter.DEFAULT_CHARSET; @@ -237,7 +238,9 @@ public JsonFileItemWriter build() { JsonFileItemWriter jsonFileItemWriter = new JsonFileItemWriter<>(this.resource, this.jsonObjectMarshaller); - jsonFileItemWriter.setName(this.name); + if (this.name != null) { + jsonFileItemWriter.setName(this.name); + } jsonFileItemWriter.setAppendAllowed(this.append); jsonFileItemWriter.setEncoding(this.encoding); if (this.headerCallback != null) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/JsonItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/JsonItemReaderBuilder.java index 9c1e7c6bcb..77b0d134e8 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/JsonItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/JsonItemReaderBuilder.java @@ -19,6 +19,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.json.JsonItemReader; import org.springframework.batch.item.json.JsonObjectReader; import org.springframework.core.io.Resource; @@ -36,11 +37,11 @@ public class JsonItemReaderBuilder { protected Log logger = LogFactory.getLog(getClass()); - private JsonObjectReader jsonObjectReader; + private @Nullable JsonObjectReader jsonObjectReader; - private Resource resource; + private @Nullable Resource resource; - private String name; + private @Nullable String name; private boolean strict = true; @@ -149,15 +150,18 @@ public JsonItemReader build() { Assert.state(StringUtils.hasText(this.name), "A name is required when saveState is set to true."); } - if (this.resource == null) { + JsonItemReader reader = new JsonItemReader<>(); + if (this.resource != null) { + reader.setResource(this.resource); + } + else { logger.debug("The resource is null. This is only a valid scenario when " + "injecting it later as in when using the MultiResourceItemReader"); } - - JsonItemReader reader = new JsonItemReader<>(); - reader.setResource(this.resource); reader.setJsonObjectReader(this.jsonObjectReader); - reader.setName(this.name); + if (this.name != null) { + reader.setName(this.name); + } reader.setStrict(this.strict); reader.setSaveState(this.saveState); reader.setMaxItemCount(this.maxItemCount); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/package-info.java index 0b03185ebc..6d533e4b2c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/builder/package-info.java @@ -18,8 +18,9 @@ * Builders for JSON item reader and writer. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.json.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/package-info.java index 667ea71817..413dbbd8dc 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/json/package-info.java @@ -4,8 +4,9 @@ *

* * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.json; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/KafkaItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/KafkaItemReader.java index bde6dc4513..d3d8c255a6 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/KafkaItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/KafkaItemReader.java @@ -29,10 +29,10 @@ import org.apache.kafka.clients.consumer.ConsumerRecord; import org.apache.kafka.clients.consumer.KafkaConsumer; import org.apache.kafka.common.TopicPartition; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.support.AbstractItemStreamItemReader; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -58,13 +58,13 @@ public class KafkaItemReader extends AbstractItemStreamItemReader { private final List topicPartitions; - private Map partitionOffsets; + private @Nullable Map partitionOffsets; - private KafkaConsumer kafkaConsumer; + private @Nullable KafkaConsumer kafkaConsumer; private final Properties consumerProperties; - private Iterator> consumerRecords; + private @Nullable Iterator> consumerRecords; private Duration pollTimeout = Duration.ofSeconds(DEFAULT_POLL_TIMEOUT); @@ -163,7 +163,7 @@ public void setPartitionOffsets(Map partitionOffsets) { this.partitionOffsets = partitionOffsets; } - @SuppressWarnings("unchecked") + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) @Override public void open(ExecutionContext executionContext) { this.kafkaConsumer = new KafkaConsumer<>(this.consumerProperties); @@ -184,9 +184,9 @@ public void open(ExecutionContext executionContext) { this.partitionOffsets.forEach(this.kafkaConsumer::seek); } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - public V read() { + public @Nullable V read() { if (this.consumerRecords == null || !this.consumerRecords.hasNext()) { this.consumerRecords = this.kafkaConsumer.poll(this.pollTimeout).iterator(); } @@ -200,6 +200,7 @@ public V read() { } } + @SuppressWarnings("DataFlowIssue") @Override public void update(ExecutionContext executionContext) { if (this.saveState) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/KafkaItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/KafkaItemWriter.java index a542bd87c2..ad9218ce90 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/KafkaItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/KafkaItemWriter.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.kafka; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemWriter; import org.springframework.batch.item.KeyValueItemWriter; import org.springframework.kafka.core.KafkaTemplate; @@ -39,19 +40,21 @@ * * @author Mathieu Ouellet * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 4.2 * */ public class KafkaItemWriter extends KeyValueItemWriter { - protected KafkaTemplate kafkaTemplate; + protected @Nullable KafkaTemplate kafkaTemplate; protected final List>> completableFutures = new ArrayList<>(); private long timeout = -1; + @SuppressWarnings("DataFlowIssue") @Override - protected void writeKeyValue(K key, T value) { + protected void writeKeyValue(@Nullable K key, T value) { if (this.delete) { this.completableFutures.add(this.kafkaTemplate.sendDefault(key, null)); } @@ -60,6 +63,7 @@ protected void writeKeyValue(K key, T value) { } } + @SuppressWarnings("DataFlowIssue") @Override protected void flush() throws Exception { this.kafkaTemplate.flush(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/KafkaItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/KafkaItemReaderBuilder.java index ae8c7fb354..df50ba93e1 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/KafkaItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/KafkaItemReaderBuilder.java @@ -26,6 +26,7 @@ import org.apache.kafka.clients.consumer.ConsumerConfig; import org.apache.kafka.common.TopicPartition; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.kafka.KafkaItemReader; import org.springframework.util.Assert; @@ -39,19 +40,19 @@ */ public class KafkaItemReaderBuilder { - private Properties consumerProperties; + private @Nullable Properties consumerProperties; - private String topic; + private @Nullable String topic; private List partitions = new ArrayList<>(); - private Map partitionOffsets; + private @Nullable Map partitionOffsets; private Duration pollTimeout = Duration.ofSeconds(30L); private boolean saveState = true; - private String name; + private @Nullable String name; /** * Configure if the state of the @@ -174,8 +175,12 @@ public KafkaItemReader build() { KafkaItemReader reader = new KafkaItemReader<>(this.consumerProperties, this.topic, this.partitions); reader.setPollTimeout(this.pollTimeout); reader.setSaveState(this.saveState); - reader.setName(this.name); - reader.setPartitionOffsets(this.partitionOffsets); + if (this.name != null) { + reader.setName(this.name); + } + if (this.partitionOffsets != null) { + reader.setPartitionOffsets(this.partitionOffsets); + } return reader; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/KafkaItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/KafkaItemWriterBuilder.java index adc6dc37b6..9db4cd324a 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/KafkaItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/KafkaItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.kafka.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.kafka.KafkaItemWriter; import org.springframework.core.convert.converter.Converter; import org.springframework.kafka.core.KafkaTemplate; @@ -30,9 +31,9 @@ */ public class KafkaItemWriterBuilder { - private KafkaTemplate kafkaTemplate; + private @Nullable KafkaTemplate kafkaTemplate; - private Converter itemKeyMapper; + private @Nullable Converter itemKeyMapper; private boolean delete; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/package-info.java index 45fb008395..7657b3593e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/builder/package-info.java @@ -19,7 +19,7 @@ * * @author Mathieu Ouellet */ -@NonNullApi +@NullMarked package org.springframework.batch.item.kafka.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/package-info.java index c0e084822b..439ed117a0 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/kafka/package-info.java @@ -19,7 +19,7 @@ * * @author Mathieu Ouellet */ -@NonNullApi +@NullMarked package org.springframework.batch.item.kafka; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/LdifReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/LdifReader.java index e619376332..49bb5e8e03 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/LdifReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/LdifReader.java @@ -16,13 +16,13 @@ package org.springframework.batch.item.ldif; +import org.jspecify.annotations.Nullable; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.batch.item.file.ResourceAwareItemReaderItemStream; import org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader; import org.springframework.beans.factory.InitializingBean; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.ldap.core.LdapAttributes; import org.springframework.ldap.ldif.parser.LdifParser; import org.springframework.util.Assert; @@ -68,9 +68,9 @@ public class LdifReader extends AbstractItemCountingItemStreamItemReader extends AbstractItemCountingItemStreamItemRead private static final Log LOG = LogFactory.getLog(MappingLdifReader.class); - private Resource resource; + private @Nullable Resource resource; - private LdifParser ldifParser; + private @Nullable LdifParser ldifParser; private int recordCount = 0; @@ -69,9 +69,9 @@ public class MappingLdifReader extends AbstractItemCountingItemStreamItemRead private boolean strict = true; - private RecordCallbackHandler skippedRecordsCallback; + private @Nullable RecordCallbackHandler skippedRecordsCallback; - private RecordMapper recordMapper; + private @Nullable RecordMapper recordMapper; public MappingLdifReader() { setName(ClassUtils.getShortName(MappingLdifReader.class)); @@ -123,6 +123,7 @@ protected void doClose() throws Exception { this.recordCount = 0; } + @SuppressWarnings("DataFlowIssue") @Override protected void doOpen() throws Exception { if (resource == null) @@ -148,9 +149,9 @@ protected void doOpen() throws Exception { } } - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { LdapAttributes attributes = null; try { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/RecordMapper.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/RecordMapper.java index 3d824e1c99..1c7ebde486 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/RecordMapper.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/RecordMapper.java @@ -15,7 +15,8 @@ */ package org.springframework.batch.item.ldif; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; + import org.springframework.ldap.core.LdapAttributes; /** @@ -34,7 +35,6 @@ public interface RecordMapper { * @param attributes attributes * @return object of type T or {@code null} if unable to map the record to an object. */ - @Nullable - T mapRecord(LdapAttributes attributes); + @Nullable T mapRecord(LdapAttributes attributes); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/LdifReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/LdifReaderBuilder.java index 5bda30d642..2f1ce5fe4b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/LdifReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/LdifReaderBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.ldif.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ldif.LdifReader; import org.springframework.batch.item.ldif.RecordCallbackHandler; import org.springframework.core.io.Resource; @@ -29,17 +30,17 @@ */ public class LdifReaderBuilder { - private Resource resource; + private @Nullable Resource resource; private int recordsToSkip = 0; private boolean strict = true; - private RecordCallbackHandler skippedRecordsCallback; + private @Nullable RecordCallbackHandler skippedRecordsCallback; private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; @@ -163,7 +164,9 @@ public LdifReader build() { reader.setResource(this.resource); reader.setRecordsToSkip(this.recordsToSkip); reader.setSaveState(this.saveState); - reader.setName(this.name); + if (this.name != null) { + reader.setName(this.name); + } reader.setCurrentItemCount(this.currentItemCount); reader.setMaxItemCount(this.maxItemCount); if (this.skippedRecordsCallback != null) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/MappingLdifReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/MappingLdifReaderBuilder.java index e56a723a75..46ac8c7e7d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/MappingLdifReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/MappingLdifReaderBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.ldif.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ldif.MappingLdifReader; import org.springframework.batch.item.ldif.RecordCallbackHandler; import org.springframework.batch.item.ldif.RecordMapper; @@ -30,19 +31,19 @@ */ public class MappingLdifReaderBuilder { - private Resource resource; + private @Nullable Resource resource; private int recordsToSkip = 0; private boolean strict = true; - private RecordCallbackHandler skippedRecordsCallback; + private @Nullable RecordCallbackHandler skippedRecordsCallback; - private RecordMapper recordMapper; + private @Nullable RecordMapper recordMapper; private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; @@ -181,7 +182,9 @@ public MappingLdifReader build() { reader.setCurrentItemCount(this.currentItemCount); reader.setMaxItemCount(this.maxItemCount); reader.setRecordMapper(this.recordMapper); - reader.setName(this.name); + if (this.name != null) { + reader.setName(this.name); + } if (this.skippedRecordsCallback != null) { reader.setSkippedRecordsCallback(this.skippedRecordsCallback); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/package-info.java index 2bcd72c032..90ea20093d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/builder/package-info.java @@ -18,8 +18,9 @@ * Builders for LDIF related components. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.ldif.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/package-info.java index f50cc0e797..9fcfa0e641 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ldif/package-info.java @@ -5,8 +5,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.ldif; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/SimpleMailMessageItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/SimpleMailMessageItemWriter.java index 65cf843acb..7e839453fb 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/SimpleMailMessageItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/SimpleMailMessageItemWriter.java @@ -18,6 +18,7 @@ import java.util.Map; import java.util.Map.Entry; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemWriter; import org.springframework.beans.factory.InitializingBean; @@ -56,7 +57,7 @@ */ public class SimpleMailMessageItemWriter implements ItemWriter, InitializingBean { - private MailSender mailSender; + private @Nullable MailSender mailSender; private MailErrorHandler mailErrorHandler = new DefaultMailErrorHandler(); @@ -91,6 +92,7 @@ public void afterPropertiesSet() throws IllegalStateException { * @param chunk the chunk of items to send * @see ItemWriter#write(Chunk) */ + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk chunk) throws MailException { try { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/builder/SimpleMailMessageItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/builder/SimpleMailMessageItemWriterBuilder.java index 247f0d1c3a..cb56c9ccb6 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/builder/SimpleMailMessageItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/builder/SimpleMailMessageItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.mail.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.mail.DefaultMailErrorHandler; import org.springframework.batch.item.mail.MailErrorHandler; @@ -30,10 +31,9 @@ * @author Mahmoud Ben Hassine * @since 4.0 */ - public class SimpleMailMessageItemWriterBuilder { - private MailSender mailSender; + private @Nullable MailSender mailSender; private MailErrorHandler mailErrorHandler = new DefaultMailErrorHandler(); @@ -69,9 +69,7 @@ public SimpleMailMessageItemWriter build() { SimpleMailMessageItemWriter writer = new SimpleMailMessageItemWriter(); writer.setMailSender(this.mailSender); - if (mailErrorHandler != null) { - writer.setMailErrorHandler(this.mailErrorHandler); - } + writer.setMailErrorHandler(this.mailErrorHandler); return writer; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/builder/package-info.java index 42a7de1483..542dda3fd4 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/builder/package-info.java @@ -18,8 +18,9 @@ * Builders for JavaMail related components. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.mail.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/javamail/MimeMessageItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/javamail/MimeMessageItemWriter.java index a900e7d276..c1a0262af3 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/javamail/MimeMessageItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/javamail/MimeMessageItemWriter.java @@ -20,6 +20,7 @@ import jakarta.mail.internet.MimeMessage; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemWriter; import org.springframework.batch.item.mail.DefaultMailErrorHandler; @@ -60,7 +61,7 @@ */ public class MimeMessageItemWriter implements ItemWriter { - private JavaMailSender mailSender; + private @Nullable JavaMailSender mailSender; private MailErrorHandler mailErrorHandler = new DefaultMailErrorHandler(); @@ -94,6 +95,7 @@ public void afterPropertiesSet() throws IllegalStateException { * @param chunk the chunk of items to send * @see ItemWriter#write(Chunk) */ + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk chunk) throws MailException { try { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/javamail/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/javamail/package-info.java index c1811df0f2..3ba7f21e39 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/javamail/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/javamail/package-info.java @@ -18,8 +18,9 @@ * JavaMail related components. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.mail.javamail; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/package-info.java index 413f4b3833..ee3457634c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/mail/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.mail; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/package-info.java index ae555480b6..b0992cd366 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/package-info.java @@ -3,7 +3,7 @@ * Infrastructure interfaces and primary dependencies for item concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/queue/BlockingQueueItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/queue/BlockingQueueItemReader.java index e5e411045b..ceb9e5d6cc 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/queue/BlockingQueueItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/queue/BlockingQueueItemReader.java @@ -22,7 +22,7 @@ /** * This is an {@link ItemReader} that reads items from a {@link BlockingQueue}. It stops - * reading (ie returns {@code null}) if no items are available in the queue after a + * reading (i.e., returns {@code null}) if no items are available in the queue after a * configurable timeout. * * @param type of items to read. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/RedisItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/RedisItemReader.java index f5142fa39a..dd6074a5e5 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/RedisItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/RedisItemReader.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.item.redis; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamException; import org.springframework.batch.item.ItemStreamReader; @@ -43,7 +45,7 @@ public class RedisItemReader implements ItemStreamReader { private final ScanOptions scanOptions; - private Cursor cursor; + private @Nullable Cursor cursor; public RedisItemReader(RedisTemplate redisTemplate, ScanOptions scanOptions) { Assert.notNull(redisTemplate, "redisTemplate must not be null"); @@ -57,8 +59,9 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { this.cursor = this.redisTemplate.scan(this.scanOptions); } + @SuppressWarnings("DataFlowIssue") @Override - public V read() throws Exception { + public @Nullable V read() throws Exception { if (this.cursor.hasNext()) { K nextKey = this.cursor.next(); return this.redisTemplate.opsForValue().get(nextKey); @@ -68,6 +71,7 @@ public V read() throws Exception { } } + @SuppressWarnings("DataFlowIssue") @Override public void close() throws ItemStreamException { this.cursor.close(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/RedisItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/RedisItemWriter.java index c9b0ae3ee3..306c8d3a34 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/RedisItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/RedisItemWriter.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.redis; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemWriter; import org.springframework.batch.item.KeyValueItemWriter; import org.springframework.data.redis.core.RedisTemplate; @@ -28,12 +29,14 @@ * * @author Santiago Molano * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 5.1 */ public class RedisItemWriter extends KeyValueItemWriter { - private RedisTemplate redisTemplate; + private @Nullable RedisTemplate redisTemplate; + @SuppressWarnings("DataFlowIssue") @Override protected void writeKeyValue(K key, T value) { if (this.delete) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/package-info.java new file mode 100644 index 0000000000..7eb3c84f7e --- /dev/null +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/redis/package-info.java @@ -0,0 +1,25 @@ +/* + * Copyright 2019 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. + */ + +/** + * Redis related readers and writers + * + * @author Stefano Cordio + */ +@NullMarked +package org.springframework.batch.item.redis; + +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractFileItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractFileItemWriter.java index a726680f99..c15a9e9f30 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractFileItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractFileItemWriter.java @@ -30,6 +30,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStream; @@ -72,7 +73,7 @@ public abstract class AbstractFileItemWriter extends AbstractItemStreamItemWr protected static final Log logger = LogFactory.getLog(AbstractFileItemWriter.class); - public static final String DEFAULT_LINE_SEPARATOR = System.getProperty("line.separator"); + public static final String DEFAULT_LINE_SEPARATOR = System.lineSeparator(); public static final String DEFAULT_CHARSET = StandardCharsets.UTF_8.name(); @@ -80,9 +81,9 @@ public abstract class AbstractFileItemWriter extends AbstractItemStreamItemWr private static final String RESTART_DATA_NAME = "current.count"; - private WritableResource resource; + private @Nullable WritableResource resource; - protected OutputState state = null; + protected @Nullable OutputState state; private boolean saveState = true; @@ -94,9 +95,9 @@ public abstract class AbstractFileItemWriter extends AbstractItemStreamItemWr private String encoding = DEFAULT_CHARSET; - private FlatFileHeaderCallback headerCallback; + private @Nullable FlatFileHeaderCallback headerCallback; - private FlatFileFooterCallback footerCallback; + private @Nullable FlatFileFooterCallback footerCallback; protected String lineSeparator = DEFAULT_LINE_SEPARATOR; @@ -253,6 +254,7 @@ public void write(Chunk items) throws Exception { /** * @see ItemStream#close() */ + @SuppressWarnings("DataFlowIssue") @Override public void close() { super.close(); @@ -298,6 +300,7 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { } } + @SuppressWarnings("DataFlowIssue") private void doOpen(ExecutionContext executionContext) throws ItemStreamException { OutputState outputState = getOutputState(); if (executionContext.containsKey(getExecutionContextKey(RESTART_DATA_NAME))) { @@ -348,6 +351,7 @@ public void update(ExecutionContext executionContext) { } // Returns object representing state. + @SuppressWarnings("DataFlowIssue") protected OutputState getOutputState() { if (state == null) { File file; @@ -372,12 +376,12 @@ protected OutputState getOutputState() { */ protected class OutputState { - private FileOutputStream os; + private @Nullable FileOutputStream os; // The bufferedWriter over the file channel that is actually written - Writer outputBufferedWriter; + @Nullable Writer outputBufferedWriter; - FileChannel fileChannel; + @Nullable FileChannel fileChannel; // this represents the charset encoding (if any is needed) for the // output file @@ -403,6 +407,7 @@ protected class OutputState { * @return the byte offset position of the cursor in the output file * @throws IOException If unable to get the offset position */ + @SuppressWarnings("DataFlowIssue") public long position() throws IOException { if (fileChannel == null) { return 0; @@ -511,6 +516,7 @@ private void closeStream() { * @param line String to be written to the file * @throws IOException If unable to write the String to the file */ + @SuppressWarnings("DataFlowIssue") public void write(String line) throws IOException { if (!initialized) { initializeBufferedWriter(); @@ -524,6 +530,7 @@ public void write(String line) throws IOException { * Truncate the output at the last known good point. * @throws IOException if unable to work with file */ + @SuppressWarnings("DataFlowIssue") public void truncate() throws IOException { fileChannel.truncate(lastMarkedByteOffsetPosition); fileChannel.position(lastMarkedByteOffsetPosition); @@ -534,6 +541,7 @@ public void truncate() throws IOException { * information. * @throws IOException if unable to initialize buffer */ + @SuppressWarnings("DataFlowIssue") private void initializeBufferedWriter() throws IOException { File file = resource.getFile(); @@ -608,6 +616,7 @@ public void flush() throws IOException { * beginning. * @throws IOException if there is an IO problem */ + @SuppressWarnings("DataFlowIssue") private void checkFileSize() throws IOException { long size; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.java index d289404c47..35d7a7790c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.java @@ -16,11 +16,12 @@ package org.springframework.batch.item.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemCountAware; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ItemStreamException; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -52,8 +53,7 @@ public abstract class AbstractItemCountingItemStreamItemReader extends Abstra * @throws Exception Allows subclasses to throw checked exceptions for interpretation * by the framework */ - @Nullable - protected abstract T doRead() throws Exception; + protected abstract @Nullable T doRead() throws Exception; /** * Open resources necessary to start reading input. @@ -83,9 +83,8 @@ protected void jumpToItem(int itemIndex) throws Exception { } } - @Nullable @Override - public T read() throws Exception { + public @Nullable T read() throws Exception { if (currentItemCount >= maxItemCount) { return null; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ClassifierCompositeItemProcessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ClassifierCompositeItemProcessor.java index da0d1d4736..221c3e87c7 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ClassifierCompositeItemProcessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ClassifierCompositeItemProcessor.java @@ -16,10 +16,11 @@ package org.springframework.batch.item.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; import org.springframework.classify.Classifier; import org.springframework.classify.ClassifierSupport; -import org.springframework.lang.Nullable; /** * Calls one of a collection of ItemProcessors, based on a router pattern implemented @@ -47,9 +48,8 @@ public void setClassifier(Classifier> c * Delegates to injected {@link ItemProcessor} instances according to the * classification by the {@link Classifier}. */ - @Nullable @Override - public O process(I item) throws Exception { + public @Nullable O process(I item) throws Exception { return processItem(classifier.classify(item), item); } @@ -60,7 +60,7 @@ public O process(I item) throws Exception { * extends O> is not applicable for the arguments (I) */ @SuppressWarnings("unchecked") - private O processItem(ItemProcessor processor, I input) throws Exception { + private @Nullable O processItem(ItemProcessor processor, I input) throws Exception { return processor.process((T) input); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemProcessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemProcessor.java index 767d7703dc..5cb6202a9d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemProcessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemProcessor.java @@ -18,12 +18,13 @@ import org.springframework.batch.item.ItemProcessor; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import java.util.Arrays; import java.util.List; +import org.jspecify.annotations.Nullable; + /** * Composite {@link ItemProcessor} that passes the item through a sequence of injected * ItemTransformers (return value of previous transformation is the entry @@ -37,7 +38,7 @@ */ public class CompositeItemProcessor implements ItemProcessor, InitializingBean { - private List> delegates; + private @Nullable List> delegates; /** * Default constructor @@ -64,10 +65,9 @@ public CompositeItemProcessor(List> delegates) { setDelegates(delegates); } - @Nullable @Override - @SuppressWarnings("unchecked") - public O process(I item) throws Exception { + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) + public @Nullable O process(I item) throws Exception { Object result = item; for (ItemProcessor delegate : delegates) { @@ -87,7 +87,7 @@ public O process(I item) throws Exception { * not applicable for the arguments (Object) */ @SuppressWarnings("unchecked") - private Object processItem(ItemProcessor processor, Object input) throws Exception { + private @Nullable Object processItem(ItemProcessor processor, Object input) throws Exception { return processor.process((T) input); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemReader.java index 73a92aa57a..78f66ba3da 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemReader.java @@ -20,6 +20,8 @@ import java.util.List; import org.springframework.batch.item.ExecutionContext; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemStreamException; import org.springframework.batch.item.ItemStreamReader; @@ -38,7 +40,7 @@ public class CompositeItemReader implements ItemStreamReader { private final Iterator> delegatesIterator; - private ItemStreamReader currentDelegate; + private @Nullable ItemStreamReader currentDelegate; /** * Create a new {@link CompositeItemReader}. @@ -60,7 +62,7 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { } @Override - public T read() throws Exception { + public @Nullable T read() throws Exception { if (this.currentDelegate == null) { return null; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemWriter.java index 74b5c64878..242a4905a1 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/CompositeItemWriter.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.support; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStream; @@ -42,7 +43,7 @@ */ public class CompositeItemWriter implements ItemStreamWriter, InitializingBean { - private List> delegates; + private @Nullable List> delegates; private boolean ignoreItemStream = false; @@ -82,6 +83,7 @@ public void setIgnoreItemStream(boolean ignoreItemStream) { this.ignoreItemStream = ignoreItemStream; } + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk chunk) throws Exception { for (ItemWriter writer : delegates) { @@ -111,6 +113,7 @@ public void setDelegates(List> delegates) { * exceptions thrown by delegates are added as suppressed exceptions into this one, in * the same order as delegates were registered. */ + @SuppressWarnings("DataFlowIssue") @Override public void close() throws ItemStreamException { List exceptions = new ArrayList<>(); @@ -134,6 +137,7 @@ public void close() throws ItemStreamException { } } + @SuppressWarnings("DataFlowIssue") @Override public void open(ExecutionContext executionContext) throws ItemStreamException { for (ItemWriter writer : delegates) { @@ -143,6 +147,7 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { } } + @SuppressWarnings("DataFlowIssue") @Override public void update(ExecutionContext executionContext) throws ItemStreamException { for (ItemWriter writer : delegates) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/IteratorItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/IteratorItemReader.java index 95cb7d3fe3..6cf8b77100 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/IteratorItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/IteratorItemReader.java @@ -19,7 +19,8 @@ import java.util.Iterator; import org.springframework.batch.item.ItemReader; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** @@ -62,9 +63,8 @@ public IteratorItemReader(Iterator iterator) { * Implementation of {@link ItemReader#read()} that just iterates over the iterator * provided. */ - @Nullable @Override - public T read() { + public @Nullable T read() { if (iterator.hasNext()) return iterator.next(); else diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ListItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ListItemReader.java index 23a18da31e..38c927062b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ListItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ListItemReader.java @@ -20,8 +20,9 @@ import java.util.List; import org.springframework.aop.support.AopUtils; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemReader; -import org.springframework.lang.Nullable; /** * An {@link ItemReader} that pulls data from a list. Useful for testing. @@ -50,9 +51,8 @@ public ListItemReader(List list) { } } - @Nullable @Override - public T read() { + public @Nullable T read() { if (!list.isEmpty()) { return list.remove(0); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/PassThroughItemProcessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/PassThroughItemProcessor.java index 6387ea5d2a..2219108215 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/PassThroughItemProcessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/PassThroughItemProcessor.java @@ -16,8 +16,9 @@ package org.springframework.batch.item.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; /** * Simple {@link ItemProcessor} that does nothing - simply passes its argument through to @@ -34,9 +35,8 @@ public class PassThroughItemProcessor implements ItemProcessor { * @return the item * @see ItemProcessor#process(Object) */ - @Nullable @Override - public T process(T item) throws Exception { + public @Nullable T process(T item) throws Exception { return item; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ScriptItemProcessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ScriptItemProcessor.java index 8b86d78f13..603687b70b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ScriptItemProcessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/ScriptItemProcessor.java @@ -15,7 +15,6 @@ */ package org.springframework.batch.item.support; -import org.springframework.lang.Nullable; import org.springframework.scripting.support.StaticScriptSource; import org.springframework.util.StringUtils; import org.springframework.batch.item.ItemProcessor; @@ -30,17 +29,16 @@ import java.util.HashMap; import java.util.Map; +import org.jspecify.annotations.Nullable; + /** *

- * {@link org.springframework.batch.item.ItemProcessor} implementation that passes the - * current item to process to the provided script. Exposes the current item for processing - * via the - * {@link org.springframework.batch.item.support.ScriptItemProcessor#ITEM_BINDING_VARIABLE_NAME} - * key name ("item"). A custom key name can be set by invoking: - * {@link org.springframework.batch.item.support.ScriptItemProcessor#setItemBindingVariableName} - * with the desired key name. The thread safety of this - * {@link org.springframework.batch.item.ItemProcessor} depends on the implementation of - * the {@link org.springframework.scripting.ScriptEvaluator} used. + * {@link ItemProcessor} implementation that passes the current item to process to the + * provided script. Exposes the current item for processing via the + * {@link ScriptItemProcessor#ITEM_BINDING_VARIABLE_NAME} key name ("item"). A custom key + * name can be set by invoking: {@link ScriptItemProcessor#setItemBindingVariableName} + * with the desired key name. The thread safety of this {@link ItemProcessor} depends on + * the implementation of the {@link org.springframework.scripting.ScriptEvaluator} used. *

* * @author Chris Schaefer @@ -50,20 +48,19 @@ public class ScriptItemProcessor implements ItemProcessor, Initializ public static final String ITEM_BINDING_VARIABLE_NAME = "item"; - private String language; + private @Nullable String language; - private ScriptSource script; + private @Nullable ScriptSource script; - private ScriptSource scriptSource; + private @Nullable ScriptSource scriptSource; - private ScriptEvaluator scriptEvaluator; + private @Nullable ScriptEvaluator scriptEvaluator; private String itemBindingVariableName = ITEM_BINDING_VARIABLE_NAME; - @Nullable @Override - @SuppressWarnings("unchecked") - public O process(I item) throws Exception { + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) + public @Nullable O process(I item) throws Exception { Map arguments = new HashMap<>(); arguments.put(itemBindingVariableName, item); @@ -103,8 +100,7 @@ public void setScriptSource(String scriptSource, String language) { *

* Provides the ability to change the key name that scripts use to obtain the current * item to process if the variable represented by: - * {@link org.springframework.batch.item.support.ScriptItemProcessor#ITEM_BINDING_VARIABLE_NAME} - * is not suitable ("item"). + * {@link ScriptItemProcessor#ITEM_BINDING_VARIABLE_NAME} is not suitable ("item"). *

* @param itemBindingVariableName the desired binding variable name */ diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SingleItemPeekableItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SingleItemPeekableItemReader.java index e1d25c8f0b..bf9f189f16 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SingleItemPeekableItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SingleItemPeekableItemReader.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2024 the original author or authors. + * Copyright 2006-2025 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. @@ -18,12 +18,13 @@ import java.util.Map.Entry; import org.springframework.batch.item.ExecutionContext; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ItemStream; import org.springframework.batch.item.ItemStreamException; import org.springframework.batch.item.ItemStreamReader; import org.springframework.batch.item.PeekableItemReader; -import org.springframework.lang.Nullable; /** *

@@ -40,13 +41,12 @@ * * @author Dave Syer * @author Mahmoud Ben Hassine - * */ public class SingleItemPeekableItemReader implements ItemStreamReader, PeekableItemReader { - private ItemReader delegate; + private @Nullable ItemReader delegate; - private T next; + private @Nullable T next; private ExecutionContext executionContext = new ExecutionContext(); @@ -64,9 +64,9 @@ public void setDelegate(ItemReader delegate) { * * @see ItemReader#read() */ - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - public T read() throws Exception { + public @Nullable T read() throws Exception { if (next != null) { T item = next; next = null; @@ -82,9 +82,9 @@ public T read() throws Exception { * * @see PeekableItemReader#peek() */ - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - public T peek() throws Exception { + public @Nullable T peek() throws Exception { if (next == null) { updateDelegate(executionContext); next = delegate.read(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemReader.java index 69655a50e2..7e534d43ad 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemReader.java @@ -19,7 +19,8 @@ import java.util.concurrent.locks.ReentrantLock; import org.springframework.batch.item.ItemReader; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** @@ -47,8 +48,7 @@ public SynchronizedItemReader(ItemReader delegate) { * synchronized with a lock. */ @Override - @Nullable - public T read() throws Exception { + public @Nullable T read() throws Exception { this.lock.lock(); try { return this.delegate.read(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemStreamReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemStreamReader.java index a2909b9228..7c08699313 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemStreamReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemStreamReader.java @@ -19,9 +19,10 @@ import java.util.concurrent.locks.ReentrantLock; import org.springframework.batch.item.ExecutionContext; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemStreamReader; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -29,7 +30,7 @@ * This is a simple ItemStreamReader decorator with a synchronized ItemReader.read() * method - which makes a non-thread-safe ItemReader thread-safe. *

- * However, if reprocessing an item is problematic then using this will make a job not + * However, if reprocessing an item is problematic, then using this will make a job not * restartable. *

* Here is the motivation behind this class: https://stackoverflow.com/a/20002493/2910265 @@ -41,7 +42,7 @@ */ public class SynchronizedItemStreamReader implements ItemStreamReader, InitializingBean { - private ItemStreamReader delegate; + private @Nullable ItemStreamReader delegate; private final Lock lock = new ReentrantLock(); @@ -52,9 +53,9 @@ public void setDelegate(ItemStreamReader delegate) { /** * This delegates to the read method of the delegate */ + @SuppressWarnings("DataFlowIssue") @Override - @Nullable - public T read() throws Exception { + public @Nullable T read() throws Exception { this.lock.lock(); try { return this.delegate.read(); @@ -64,16 +65,19 @@ public T read() throws Exception { } } + @SuppressWarnings("DataFlowIssue") @Override public void close() { this.delegate.close(); } + @SuppressWarnings("DataFlowIssue") @Override public void open(ExecutionContext executionContext) { this.delegate.open(executionContext); } + @SuppressWarnings("DataFlowIssue") @Override public void update(ExecutionContext executionContext) { this.delegate.update(executionContext); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemStreamWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemStreamWriter.java index ad69b89a5f..aef5a67a63 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemStreamWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/SynchronizedItemStreamWriter.java @@ -18,6 +18,7 @@ import java.util.concurrent.locks.Lock; import java.util.concurrent.locks.ReentrantLock; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamException; @@ -48,7 +49,7 @@ */ public class SynchronizedItemStreamWriter implements ItemStreamWriter, InitializingBean { - private ItemStreamWriter delegate; + private @Nullable ItemStreamWriter delegate; private final Lock lock = new ReentrantLock(); @@ -63,6 +64,7 @@ public void setDelegate(ItemStreamWriter delegate) { /** * This method delegates to the {@code write} method of the {@code delegate}. */ + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk items) throws Exception { this.lock.lock(); @@ -74,16 +76,19 @@ public void write(Chunk items) throws Exception { } } + @SuppressWarnings("DataFlowIssue") @Override public void open(ExecutionContext executionContext) throws ItemStreamException { this.delegate.open(executionContext); } + @SuppressWarnings("DataFlowIssue") @Override public void update(ExecutionContext executionContext) throws ItemStreamException { this.delegate.update(executionContext); } + @SuppressWarnings("DataFlowIssue") @Override public void close() throws ItemStreamException { this.delegate.close(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ClassifierCompositeItemProcessorBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ClassifierCompositeItemProcessorBuilder.java index fd5e47f8e8..fa463d1d71 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ClassifierCompositeItemProcessorBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ClassifierCompositeItemProcessorBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.support.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemProcessor; import org.springframework.batch.item.support.ClassifierCompositeItemProcessor; import org.springframework.classify.Classifier; @@ -29,7 +30,7 @@ */ public class ClassifierCompositeItemProcessorBuilder { - private Classifier> classifier; + private @Nullable Classifier> classifier; /** * Establishes the classifier that will determine which {@link ItemProcessor} to use. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ClassifierCompositeItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ClassifierCompositeItemWriterBuilder.java index dd0bccdaf0..d891161315 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ClassifierCompositeItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ClassifierCompositeItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.support.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemWriter; import org.springframework.batch.item.support.ClassifierCompositeItemWriter; import org.springframework.classify.Classifier; @@ -30,7 +31,7 @@ */ public class ClassifierCompositeItemWriterBuilder { - private Classifier> classifier; + private @Nullable Classifier> classifier; /** * Establish the classifier to be used for the selection of which {@link ItemWriter} diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/CompositeItemProcessorBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/CompositeItemProcessorBuilder.java index c4d6291e4a..d3f713c7e9 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/CompositeItemProcessorBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/CompositeItemProcessorBuilder.java @@ -19,6 +19,7 @@ import java.util.Arrays; import java.util.List; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemProcessor; import org.springframework.batch.item.support.CompositeItemProcessor; import org.springframework.util.Assert; @@ -32,7 +33,7 @@ */ public class CompositeItemProcessorBuilder { - private List> delegates; + private @Nullable List> delegates; /** * Establishes the {@link ItemProcessor} delegates that will work on the item to be diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/CompositeItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/CompositeItemWriterBuilder.java index adc067de12..e7c70df1ec 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/CompositeItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/CompositeItemWriterBuilder.java @@ -19,6 +19,7 @@ import java.util.Arrays; import java.util.List; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemWriter; import org.springframework.batch.item.support.CompositeItemWriter; import org.springframework.util.Assert; @@ -33,7 +34,7 @@ */ public class CompositeItemWriterBuilder { - private List> delegates; + private @Nullable List> delegates; private boolean ignoreItemStream = false; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ScriptItemProcessorBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ScriptItemProcessorBuilder.java index 7a79f5e808..c9eeaca03b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ScriptItemProcessorBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/ScriptItemProcessorBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.support.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.support.ScriptItemProcessor; import org.springframework.core.io.Resource; import org.springframework.util.Assert; @@ -29,13 +30,13 @@ */ public class ScriptItemProcessorBuilder { - private String language; + private @Nullable String language; - private Resource scriptResource; + private @Nullable Resource scriptResource; - private String scriptSource; + private @Nullable String scriptSource; - private String itemBindingVariableName; + private @Nullable String itemBindingVariableName; /** * Sets the {@link org.springframework.core.io.Resource} location of the script to @@ -114,6 +115,7 @@ public ScriptItemProcessor build() { } if (this.scriptSource != null) { + Assert.hasText(language, "Language must contain the script language"); processor.setScriptSource(this.scriptSource, this.language); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SingleItemPeekableItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SingleItemPeekableItemReaderBuilder.java index 2b9b5fc94b..dd4218f2ea 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SingleItemPeekableItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SingleItemPeekableItemReaderBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.support.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.support.SingleItemPeekableItemReader; import org.springframework.util.Assert; @@ -28,7 +29,7 @@ */ public class SingleItemPeekableItemReaderBuilder { - private ItemReader delegate; + private @Nullable ItemReader delegate; /** * The item reader to use as a delegate. Items are read from the delegate and passed diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemReaderBuilder.java index 1be46ec3cb..c3b01eeb7b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemReaderBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.support.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.support.SynchronizedItemReader; import org.springframework.util.Assert; @@ -28,7 +29,7 @@ */ public class SynchronizedItemReaderBuilder { - private ItemReader delegate; + private @Nullable ItemReader delegate; /** * The item reader to use as a delegate. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemStreamReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemStreamReaderBuilder.java index df15272ade..204f0d2108 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemStreamReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemStreamReaderBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.support.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemStreamReader; import org.springframework.batch.item.support.SynchronizedItemStreamReader; import org.springframework.util.Assert; @@ -28,7 +29,7 @@ */ public class SynchronizedItemStreamReaderBuilder { - private ItemStreamReader delegate; + private @Nullable ItemStreamReader delegate; /** * The item stream reader to use as a delegate. Items are read from the delegate and diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemStreamWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemStreamWriterBuilder.java index 18b89c5c8e..e0cbc04411 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemStreamWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemStreamWriterBuilder.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.item.support.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemStreamWriter; import org.springframework.batch.item.support.SynchronizedItemStreamWriter; import org.springframework.util.Assert; @@ -27,7 +28,7 @@ */ public class SynchronizedItemStreamWriterBuilder { - private ItemStreamWriter delegate; + private @Nullable ItemStreamWriter delegate; /** * Set the delegate {@link ItemStreamWriter}. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemWriterBuilder.java index d4b7da1fa1..f7ef30ebb7 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/SynchronizedItemWriterBuilder.java @@ -16,6 +16,7 @@ package org.springframework.batch.item.support.builder; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemWriter; import org.springframework.batch.item.support.SynchronizedItemWriter; import org.springframework.util.Assert; @@ -28,7 +29,7 @@ */ public class SynchronizedItemWriterBuilder { - private ItemWriter delegate; + private @Nullable ItemWriter delegate; /** * The item writer to use as a delegate. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/package-info.java index 672042949c..36c9e31800 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/builder/package-info.java @@ -19,7 +19,7 @@ * * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.item.support.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/package-info.java index 3b67e5685a..2eb4f52709 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/package-info.java @@ -3,7 +3,7 @@ * Internal support package *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/ExecutionContextUserSupport.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/ExecutionContextUserSupport.java index 661ab42b88..f26c0331dd 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/ExecutionContextUserSupport.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/ExecutionContextUserSupport.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.item.util; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.util.Assert; @@ -24,10 +25,11 @@ * * @author Robert Kasanicky * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ public class ExecutionContextUserSupport { - private String name; + private @Nullable String name; public ExecutionContextUserSupport() { super(); @@ -41,7 +43,7 @@ public ExecutionContextUserSupport(String name) { /** * @return name used to uniquely identify this instance's entries in shared context. */ - public String getName() { + public @Nullable String getName() { return this.name; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/package-info.java index 2e35f78b8e..635928175f 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/package-info.java @@ -18,8 +18,9 @@ * Infrastructure utility classes. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.util; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/SpringValidator.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/SpringValidator.java index 4db6e7bb7e..49a1e603e9 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/SpringValidator.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/SpringValidator.java @@ -18,6 +18,7 @@ import java.util.Collection; +import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.InitializingBean; import org.springframework.util.Assert; import org.springframework.validation.BeanPropertyBindingResult; @@ -33,11 +34,12 @@ */ public class SpringValidator implements Validator, InitializingBean { - private org.springframework.validation.Validator validator; + private org.springframework.validation.@Nullable Validator validator; /** * @see Validator#validate(Object) */ + @SuppressWarnings("DataFlowIssue") @Override public void validate(T item) throws ValidationException { @@ -74,8 +76,7 @@ private String errorsToString(Errors errors) { */ private void appendCollection(Collection collection, StringBuilder builder) { for (Object value : collection) { - builder.append("\n"); - builder.append(value.toString()); + builder.append("\n").append(value); } } @@ -86,7 +87,6 @@ public void setValidator(org.springframework.validation.Validator validator) { @Override public void afterPropertiesSet() throws Exception { Assert.state(validator != null, "validator must be set"); - } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/ValidatingItemProcessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/ValidatingItemProcessor.java index 4b1e2aeef2..c001a97bba 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/ValidatingItemProcessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/ValidatingItemProcessor.java @@ -15,9 +15,10 @@ */ package org.springframework.batch.item.validator; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -31,7 +32,7 @@ */ public class ValidatingItemProcessor implements ItemProcessor, InitializingBean { - private Validator validator; + private @Nullable Validator validator; private boolean filter = false; @@ -72,9 +73,9 @@ public void setFilter(boolean filter) { * @return the input item * @throws ValidationException if validation fails */ - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - public T process(T item) throws ValidationException { + public @Nullable T process(T item) throws ValidationException { try { validator.validate(item); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/package-info.java index c56d78dab1..d29c02a68b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of item validator concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.validator; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemReader.java index c225178dc6..bb9130db0e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemReader.java @@ -33,6 +33,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.NonTransientResourceException; import org.springframework.batch.item.file.ResourceAwareItemReaderItemStream; @@ -41,7 +42,6 @@ import org.springframework.batch.item.xml.stax.FragmentEventReader; import org.springframework.beans.factory.InitializingBean; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.oxm.Unmarshaller; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -68,17 +68,17 @@ public class StaxEventItemReader extends AbstractItemCountingItemStreamItemRe public static final String DEFAULT_ENCODING = StandardCharsets.UTF_8.name(); - private FragmentEventReader fragmentReader; + private @Nullable FragmentEventReader fragmentReader; - private XMLEventReader eventReader; + private @Nullable XMLEventReader eventReader; - private Unmarshaller unmarshaller; + private @Nullable Unmarshaller unmarshaller; - private Resource resource; + private @Nullable Resource resource; - private InputStream inputStream; + private @Nullable InputStream inputStream; - private List fragmentRootElementNames; + private final List fragmentRootElementNames = new ArrayList<>(); private boolean noInput; @@ -86,7 +86,7 @@ public class StaxEventItemReader extends AbstractItemCountingItemStreamItemRe private XMLInputFactory xmlInputFactory = StaxUtils.createDefensiveInputFactory(); - private String encoding = DEFAULT_ENCODING; + private @Nullable String encoding = DEFAULT_ENCODING; public StaxEventItemReader() { setName(ClassUtils.getShortName(StaxEventItemReader.class)); @@ -125,7 +125,9 @@ public void setFragmentRootElementName(String fragmentRootElementName) { * @param fragmentRootElementNames the names of the fragment's root element */ public void setFragmentRootElementNames(String[] fragmentRootElementNames) { - this.fragmentRootElementNames = new ArrayList<>(); + if (!this.fragmentRootElementNames.isEmpty()) { + this.fragmentRootElementNames.clear(); + } for (String fragmentRootElementName : fragmentRootElementNames) { this.fragmentRootElementNames.add(parseFragmentRootElementName(fragmentRootElementName)); } @@ -153,7 +155,7 @@ public void setEncoding(@Nullable String encoding) { * Ensure that all required dependencies for the ItemReader to run are provided after * all properties have been set. * - * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet() + * @see InitializingBean#afterPropertiesSet() * @throws IllegalArgumentException if the Resource, FragmentDeserializer or * FragmentRootElementName is null, or if the root element is empty. * @throws IllegalStateException if the Resource does not exist. @@ -251,9 +253,9 @@ protected void doOpen() throws Exception { /** * Move to next fragment and map it to item. */ - @Nullable + @SuppressWarnings("DataFlowIssue") @Override - protected T doRead() throws IOException, XMLStreamException { + protected @Nullable T doRead() throws IOException, XMLStreamException { if (noInput) { return null; @@ -321,6 +323,7 @@ protected void jumpToItem(int itemIndex) throws Exception { */ private QName readToStartFragment() throws XMLStreamException { while (true) { + @SuppressWarnings("DataFlowIssue") XMLEvent nextEvent = eventReader.nextEvent(); if (nextEvent.isStartElement() && isFragmentRootElementName(((StartElement) nextEvent).getName())) { return ((StartElement) nextEvent).getName(); @@ -336,6 +339,7 @@ private QName readToStartFragment() throws XMLStreamException { */ private void readToEndFragment(QName fragmentRootElementName) throws XMLStreamException { while (true) { + @SuppressWarnings("DataFlowIssue") XMLEvent nextEvent = eventReader.nextEvent(); if (nextEvent.isEndElement() && fragmentRootElementName.equals(((EndElement) nextEvent).getName())) { return; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemWriter.java index 5422c96c9d..e6ae883925 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemWriter.java @@ -26,6 +26,7 @@ import java.nio.channels.FileChannel; import java.nio.file.Files; import java.util.Collections; +import java.util.HashMap; import java.util.List; import java.util.Map; import javax.xml.namespace.QName; @@ -39,6 +40,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamException; @@ -90,7 +92,7 @@ public class StaxEventItemWriter extends AbstractItemStreamItemWriter public static final String DEFAULT_XML_VERSION = "1.0"; // default standalone document declaration, value not set - public static final Boolean DEFAULT_STANDALONE_DOCUMENT = null; + public static final @Nullable Boolean DEFAULT_STANDALONE_DOCUMENT = null; // default root tag name public static final String DEFAULT_ROOT_TAG_NAME = "root"; @@ -105,10 +107,10 @@ public class StaxEventItemWriter extends AbstractItemStreamItemWriter private static final String WRITE_STATISTICS_NAME = "record.count"; // file system resource - private WritableResource resource; + private @Nullable WritableResource resource; // xml marshaller - private Marshaller marshaller; + private @Nullable Marshaller marshaller; // encoding to be used while reading from the resource private String encoding = DEFAULT_ENCODING; @@ -117,7 +119,7 @@ public class StaxEventItemWriter extends AbstractItemStreamItemWriter private String version = DEFAULT_XML_VERSION; // standalone header attribute - private Boolean standalone = DEFAULT_STANDALONE_DOCUMENT; + private @Nullable Boolean standalone = DEFAULT_STANDALONE_DOCUMENT; // name of the root tag private String rootTagName = DEFAULT_ROOT_TAG_NAME; @@ -129,32 +131,32 @@ public class StaxEventItemWriter extends AbstractItemStreamItemWriter private String rootTagNamespace = ""; // root element attributes - private Map rootElementAttributes = null; + private Map rootElementAttributes = new HashMap<>(); // TRUE means, that output file will be overwritten if exists - default is // TRUE private boolean overwriteOutput = true; // file channel - private FileChannel channel; + private @Nullable FileChannel channel; // wrapper for XML event writer that swallows StartDocument and EndDocument // events - private XMLEventWriter eventWriter; + private @Nullable XMLEventWriter eventWriter; // XML event writer - private XMLEventWriter delegateEventWriter; + private @Nullable XMLEventWriter delegateEventWriter; // current count of processed records private long currentRecordCount = 0; private boolean saveState = true; - private StaxWriterCallback headerCallback; + private @Nullable StaxWriterCallback headerCallback; - private StaxWriterCallback footerCallback; + private @Nullable StaxWriterCallback footerCallback; - private Writer bufferedWriter; + private @Nullable Writer bufferedWriter; private boolean transactional = true; @@ -276,7 +278,7 @@ public void setVersion(String version) { * * @since 4.3 */ - public Boolean getStandalone() { + public @Nullable Boolean getStandalone() { return standalone; } @@ -287,7 +289,7 @@ public Boolean getStandalone() { * * @since 4.3 */ - public void setStandalone(Boolean standalone) { + public void setStandalone(@Nullable Boolean standalone) { this.standalone = standalone; } @@ -346,7 +348,7 @@ public Map getRootElementAttributes() { * @param rootElementAttributes attributes of the root element */ public void setRootElementAttributes(Map rootElementAttributes) { - this.rootElementAttributes = rootElementAttributes; + this.rootElementAttributes = new HashMap<>(rootElementAttributes); } /** @@ -386,7 +388,7 @@ public void afterPropertiesSet() throws Exception { * * @see org.springframework.batch.item.ItemStream#open(ExecutionContext) */ - @SuppressWarnings("unchecked") + @SuppressWarnings({ "unchecked", "DataFlowIssue" }) @Override public void open(ExecutionContext executionContext) { super.open(executionContext); @@ -444,6 +446,7 @@ public void open(ExecutionContext executionContext) { /** * Helper method for opening output source at given file position */ + @SuppressWarnings("DataFlowIssue") private void open(long position) { File file; @@ -548,6 +551,7 @@ protected XMLEventFactory createXmlEventFactory() throws FactoryConfigurationErr * Subclasses can override to customize the STAX result. * @return a result for writing to */ + @SuppressWarnings("DataFlowIssue") protected Result createStaxResult() { return StaxUtils.createStaxResult(eventWriter); } @@ -656,6 +660,7 @@ protected void startDocument(XMLEventWriter writer) throws XMLStreamException { * @param writer XML event writer * @throws XMLStreamException thrown if error occurs. */ + @SuppressWarnings("DataFlowIssue") protected void endDocument(XMLEventWriter writer) throws XMLStreamException { // writer.writeEndDocument(); <- this doesn't work after restart @@ -675,6 +680,7 @@ protected void endDocument(XMLEventWriter writer) throws XMLStreamException { * * @see org.springframework.batch.item.ItemStream#close() */ + @SuppressWarnings("DataFlowIssue") @Override public void close() { super.close(); @@ -739,6 +745,7 @@ public void close() { this.initialized = false; } + @SuppressWarnings("DataFlowIssue") private void closeStream() { try { channel.close(); @@ -754,6 +761,7 @@ private void closeStream() { * @throws IOException thrown if general error occurs. * @throws XmlMappingException thrown if error occurs during XML Mapping. */ + @SuppressWarnings("DataFlowIssue") @Override public void write(Chunk items) throws XmlMappingException, IOException { @@ -806,8 +814,8 @@ public void update(ExecutionContext executionContext) { * * @return byte offset in file channel */ + @SuppressWarnings("DataFlowIssue") private long getPosition() { - long position; try { @@ -828,8 +836,8 @@ private long getPosition() { * Set the file channel position. * @param newPosition new file channel position */ + @SuppressWarnings("DataFlowIssue") private void setPosition(long newPosition) { - try { channel.truncate(newPosition); channel.position(newPosition); @@ -837,7 +845,6 @@ private void setPosition(long newPosition) { catch (IOException e) { throw new ItemStreamException("Unable to write to file resource: [" + resource + "]", e); } - } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/StaxEventItemReaderBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/StaxEventItemReaderBuilder.java index 85f3746984..808c74614a 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/StaxEventItemReaderBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/StaxEventItemReaderBuilder.java @@ -23,10 +23,10 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.xml.StaxEventItemReader; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.oxm.Unmarshaller; import org.springframework.util.Assert; import org.springframework.util.StringUtils; @@ -47,15 +47,15 @@ public class StaxEventItemReaderBuilder { private boolean strict = true; - private Resource resource; + private @Nullable Resource resource; - private Unmarshaller unmarshaller; + private @Nullable Unmarshaller unmarshaller; private final List fragmentRootElements = new ArrayList<>(); private boolean saveState = true; - private String name; + private @Nullable String name; private int maxItemCount = Integer.MAX_VALUE; @@ -63,7 +63,7 @@ public class StaxEventItemReaderBuilder { private XMLInputFactory xmlInputFactory = StaxUtils.createDefensiveInputFactory(); - private String encoding = StaxEventItemReader.DEFAULT_ENCODING; + private @Nullable String encoding = StaxEventItemReader.DEFAULT_ENCODING; /** * Configure if the state of the @@ -214,25 +214,29 @@ public StaxEventItemReaderBuilder encoding(@Nullable String encoding) { public StaxEventItemReader build() { StaxEventItemReader reader = new StaxEventItemReader<>(); - if (this.resource == null) { + if (this.resource != null) { + reader.setResource(this.resource); + } + else { logger.debug("The resource is null. This is only a valid scenario when " + "injecting resource later as in when using the MultiResourceItemReader"); } - if (this.saveState) { Assert.state(StringUtils.hasText(this.name), "A name is required when saveState is set to true."); } Assert.notEmpty(this.fragmentRootElements, "At least one fragment root element is required"); - reader.setName(this.name); + if (this.name != null) { + reader.setName(this.name); + } reader.setSaveState(this.saveState); - reader.setResource(this.resource); - reader.setFragmentRootElementNames( - this.fragmentRootElements.toArray(new String[this.fragmentRootElements.size()])); + reader.setFragmentRootElementNames(this.fragmentRootElements.toArray(new String[0])); reader.setStrict(this.strict); - reader.setUnmarshaller(this.unmarshaller); + if (this.unmarshaller != null) { + reader.setUnmarshaller(this.unmarshaller); + } reader.setCurrentItemCount(this.currentItemCount); reader.setMaxItemCount(this.maxItemCount); reader.setXmlInputFactory(this.xmlInputFactory); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/StaxEventItemWriterBuilder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/StaxEventItemWriterBuilder.java index 95ecff3c04..38d727eeb0 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/StaxEventItemWriterBuilder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/StaxEventItemWriterBuilder.java @@ -17,6 +17,7 @@ import java.util.Map; +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.xml.StaxEventItemWriter; import org.springframework.batch.item.xml.StaxWriterCallback; import org.springframework.core.io.WritableResource; @@ -34,13 +35,13 @@ */ public class StaxEventItemWriterBuilder { - private WritableResource resource; + private @Nullable WritableResource resource; - private Marshaller marshaller; + private @Nullable Marshaller marshaller; - private StaxWriterCallback headerCallback; + private @Nullable StaxWriterCallback headerCallback; - private StaxWriterCallback footerCallback; + private @Nullable StaxWriterCallback footerCallback; private boolean transactional = true; @@ -52,17 +53,17 @@ public class StaxEventItemWriterBuilder { private String version = StaxEventItemWriter.DEFAULT_XML_VERSION; - private Boolean standalone = StaxEventItemWriter.DEFAULT_STANDALONE_DOCUMENT; + private @Nullable Boolean standalone = StaxEventItemWriter.DEFAULT_STANDALONE_DOCUMENT; private String rootTagName = StaxEventItemWriter.DEFAULT_ROOT_TAG_NAME; - private Map rootElementAttributes; + private @Nullable Map rootElementAttributes; private boolean overwriteOutput = true; private boolean saveState = true; - private String name; + private @Nullable String name; /** * The name used to calculate the key within the @@ -268,20 +269,32 @@ public StaxEventItemWriter build() { StaxEventItemWriter writer = new StaxEventItemWriter<>(); writer.setEncoding(this.encoding); - writer.setFooterCallback(this.footerCallback); + if (this.footerCallback != null) { + writer.setFooterCallback(this.footerCallback); + } writer.setForceSync(this.forceSync); - writer.setHeaderCallback(this.headerCallback); + if (this.headerCallback != null) { + writer.setHeaderCallback(this.headerCallback); + } writer.setMarshaller(this.marshaller); writer.setOverwriteOutput(this.overwriteOutput); - writer.setResource(this.resource); - writer.setRootElementAttributes(this.rootElementAttributes); + if (this.resource != null) { + writer.setResource(this.resource); + } + if (this.rootElementAttributes != null) { + writer.setRootElementAttributes(this.rootElementAttributes); + } writer.setRootTagName(this.rootTagName); writer.setSaveState(this.saveState); writer.setShouldDeleteIfEmpty(this.shouldDeleteIfEmpty); writer.setTransactional(this.transactional); writer.setVersion(this.version); - writer.setName(this.name); - writer.setStandalone(this.standalone); + if (this.name != null) { + writer.setName(this.name); + } + if (this.standalone != null) { + writer.setStandalone(this.standalone); + } return writer; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/package-info.java index 8f60fbf801..c7061e204e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/builder/package-info.java @@ -18,8 +18,9 @@ * Builders for Stax event item reader and writer. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.xml.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/package-info.java index 6b81565cb7..2d6ce6042e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of xml input and output. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.item.xml; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/AbstractEventReaderWrapper.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/AbstractEventReaderWrapper.java index 8f190a788a..559212fbf0 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/AbstractEventReaderWrapper.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/AbstractEventReaderWrapper.java @@ -16,6 +16,8 @@ package org.springframework.batch.item.xml.stax; +import org.jspecify.annotations.Nullable; + import javax.xml.stream.XMLEventReader; import javax.xml.stream.XMLStreamException; import javax.xml.stream.events.XMLEvent; @@ -66,7 +68,7 @@ public XMLEvent nextTag() throws XMLStreamException { } @Override - public XMLEvent peek() throws XMLStreamException { + public @Nullable XMLEvent peek() throws XMLStreamException { return wrappedEventReader.peek(); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/DefaultFragmentEventReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/DefaultFragmentEventReader.java index e134759411..54c5b7cfec 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/DefaultFragmentEventReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/DefaultFragmentEventReader.java @@ -30,6 +30,8 @@ import org.springframework.batch.item.ItemStreamException; +import org.jspecify.annotations.Nullable; + /** * Default implementation of {@link FragmentEventReader} * @@ -56,7 +58,7 @@ public class DefaultFragmentEventReader extends AbstractEventReaderWrapper imple // fragment root name is remembered so that the matching closing element can // be identified - private QName fragmentRootName = null; + private @Nullable QName fragmentRootName; // counts the occurrences of current fragmentRootName (increased for // StartElement, decreased for EndElement) @@ -166,7 +168,7 @@ else if (endFragmentFollows) { } @Override - public XMLEvent peek() throws XMLStreamException { + public @Nullable XMLEvent peek() throws XMLStreamException { if (fakeDocumentEnd) { return null; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/package-info.java index b1f51036c8..6e9acd60c9 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/stax/package-info.java @@ -18,8 +18,9 @@ * Item reader and writer based on Stax. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.item.xml.stax; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/package-info.java index 8293c2f96d..27a2c1d1eb 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of . concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/poller/DirectPoller.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/poller/DirectPoller.java index ace3a24763..0a30d91934 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/poller/DirectPoller.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/poller/DirectPoller.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.poller; +import org.jspecify.annotations.Nullable; + import java.util.concurrent.Callable; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; @@ -24,7 +26,7 @@ /** * A {@link Poller} that uses the callers thread to poll for a result as soon as it is * asked for. This is often appropriate if you expect a result relatively quickly, or if - * there is only one such result expected (otherwise it is more efficient to use a + * there is only one such result expected (otherwise, it is more efficient to use a * background thread to do the polling). * * @author Dave Syer @@ -57,7 +59,7 @@ private static class DirectPollingFuture implements Future { private volatile boolean cancelled; - private volatile S result = null; + private volatile @Nullable S result = null; private final long interval; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/poller/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/poller/package-info.java index 5318e22460..8d83b0dad5 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/poller/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/poller/package-info.java @@ -19,7 +19,7 @@ * * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.poller; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/RepeatContext.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/RepeatContext.java index 7ca05e82fc..6d1af44000 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/RepeatContext.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/RepeatContext.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2007 the original author or authors. + * Copyright 2006-2025 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. @@ -16,6 +16,7 @@ package org.springframework.batch.repeat; +import org.jspecify.annotations.Nullable; import org.springframework.core.AttributeAccessor; /** @@ -35,7 +36,7 @@ public interface RepeatContext extends AttributeAccessor { * parent. This is an accessor for the parent if it exists. * @return the parent context or null if there is none */ - RepeatContext getParent(); + @Nullable RepeatContext getParent(); /** * Public access to a counter for the number of operations attempted. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/callback/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/callback/package-info.java index 878daec20c..c27b8fee69 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/callback/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/callback/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of repeat callback concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.repeat.callback; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/RepeatContextCounter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/RepeatContextCounter.java index f18c193e69..e5e36220ab 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/RepeatContextCounter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/RepeatContextCounter.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2007 the original author or authors. + * Copyright 2006-2025 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. @@ -28,35 +28,13 @@ * decision is based on the aggregate of a number of sibling batches. * * @author Dave Syer - * + * @author Stefano Cordio */ public class RepeatContextCounter { - final private String countKey; + private final String countKey; - /** - * Flag to indicate whether the count is stored at the level of the parent context, or - * just local to the current context. Default value is false. - */ - final private boolean useParent; - - final private RepeatContext context; - - /** - * Increment the counter. - * @param delta the amount by which to increment the counter. - */ - final public void increment(int delta) { - AtomicInteger count = getCounter(); - count.addAndGet(delta); - } - - /** - * Increment by 1. - */ - final public void increment() { - increment(1); - } + private final RepeatContext context; /** * Convenience constructor with useParent=false. @@ -76,26 +54,16 @@ public RepeatContextCounter(RepeatContext context, String countKey) { * itself. */ public RepeatContextCounter(RepeatContext context, String countKey, boolean useParent) { - - super(); - Assert.notNull(context, "The context must be provided to initialize a counter"); this.countKey = countKey; - this.useParent = useParent; RepeatContext parent = context.getParent(); - if (this.useParent && parent != null) { - this.context = parent; - } - else { - this.context = context; - } + this.context = useParent && parent != null ? parent : context; if (!this.context.hasAttribute(countKey)) { this.context.setAttribute(countKey, new AtomicInteger()); } - } /** @@ -105,6 +73,22 @@ public int getCount() { return getCounter().intValue(); } + /** + * Increment the counter. + * @param delta the amount by which to increment the counter. + */ + public final void increment(int delta) { + getCounter().addAndGet(delta); + } + + /** + * Increment by 1. + */ + public final void increment() { + increment(1); + } + + @SuppressWarnings("DataFlowIssue") private AtomicInteger getCounter() { return ((AtomicInteger) context.getAttribute(countKey)); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/RepeatContextSupport.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/RepeatContextSupport.java index ac80aa0a65..af57c87b9b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/RepeatContextSupport.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/RepeatContextSupport.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2023 the original author or authors. + * Copyright 2006-2025 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. @@ -44,7 +44,6 @@ public class RepeatContextSupport extends SynchronizedAttributeAccessor implemen * @param parent {@link RepeatContext} to be used as the parent context. */ public RepeatContextSupport(RepeatContext parent) { - super(); this.parent = parent; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/SynchronizedAttributeAccessor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/SynchronizedAttributeAccessor.java index 0413baa10e..e1de773fd9 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/SynchronizedAttributeAccessor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/SynchronizedAttributeAccessor.java @@ -16,9 +16,10 @@ package org.springframework.batch.repeat.context; +import org.jspecify.annotations.Nullable; + import org.springframework.core.AttributeAccessor; import org.springframework.core.AttributeAccessorSupport; -import org.springframework.lang.Nullable; /** * An {@link AttributeAccessor} that synchronizes on a mutex (not this) before modifying @@ -68,7 +69,7 @@ else if (other instanceof AttributeAccessorSupport attributeAccessorSupport) { } @Override - public Object getAttribute(String name) { + public @Nullable Object getAttribute(String name) { synchronized (support) { return support.getAttribute(name); } @@ -87,14 +88,14 @@ public int hashCode() { } @Override - public Object removeAttribute(String name) { + public @Nullable Object removeAttribute(String name) { synchronized (support) { return support.removeAttribute(name); } } @Override - public void setAttribute(String name, Object value) { + public void setAttribute(String name, @Nullable Object value) { synchronized (support) { support.setAttribute(name, value); } @@ -106,8 +107,7 @@ public void setAttribute(String name, Object value) { * @param value the value of the attribute * @return null if the attribute was not already set, the existing value otherwise. */ - @Nullable - public Object setAttributeIfAbsent(String name, Object value) { + public @Nullable Object setAttributeIfAbsent(String name, Object value) { synchronized (support) { Object old = getAttribute(name); if (old != null) { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/package-info.java index e8d0f11f93..b4b38ceb55 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/context/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of repeat context concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.repeat.context; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/exception/SimpleLimitExceptionHandler.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/exception/SimpleLimitExceptionHandler.java index d3592695a1..ba42ea6842 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/exception/SimpleLimitExceptionHandler.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/exception/SimpleLimitExceptionHandler.java @@ -116,7 +116,7 @@ public void handleException(RepeatContext context, Throwable throwable) throws T * rethrown. * @param limit the limit */ - public void setLimit(final int limit) { + public void setLimit(int limit) { this.limit = limit; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/exception/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/exception/package-info.java index e32d20693c..c9fd7223d0 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/exception/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/exception/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of repeat exception handler concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.repeat.exception; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/interceptor/RepeatOperationsInterceptor.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/interceptor/RepeatOperationsInterceptor.java index de3df9427a..cf17e8537d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/interceptor/RepeatOperationsInterceptor.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/interceptor/RepeatOperationsInterceptor.java @@ -18,6 +18,7 @@ import org.aopalliance.intercept.MethodInterceptor; import org.aopalliance.intercept.MethodInvocation; +import org.jspecify.annotations.Nullable; import org.springframework.aop.ProxyMethodInvocation; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.batch.repeat.RepeatException; @@ -59,7 +60,7 @@ public void setRepeatOperations(RepeatOperations batchTemplate) { * @see org.aopalliance.intercept.MethodInterceptor#invoke(org.aopalliance.intercept.MethodInvocation) */ @Override - public Object invoke(final MethodInvocation invocation) throws Throwable { + public @Nullable Object invoke(MethodInvocation invocation) throws Throwable { final ResultHolder result = new ResultHolder(); // Cache void return value if intercepted method returns void @@ -121,7 +122,7 @@ public Object invoke(final MethodInvocation invocation) throws Throwable { + ". The invocation was never called, so maybe there is a problem with the completion policy?"); } - private boolean isComplete(Object result) { + private boolean isComplete(@Nullable Object result) { return (result == null) || ((result instanceof Boolean b) && !b); } @@ -148,7 +149,7 @@ public RepeatOperationsInterceptorException(String message, Throwable e) { */ private static class ResultHolder { - private Object value = null; + private @Nullable Object value; private boolean ready = false; @@ -156,12 +157,12 @@ private static class ResultHolder { * Public setter for the Object. * @param value the value to set */ - public void setValue(Object value) { + public void setValue(@Nullable Object value) { this.ready = true; this.value = value; } - public void setFinalValue(Object value) { + public void setFinalValue(@Nullable Object value) { if (ready) { // Only set the value the last time if the last time was also // the first time @@ -174,7 +175,7 @@ public void setFinalValue(Object value) { * Public getter for the Object. * @return the value */ - public Object getValue() { + public @Nullable Object getValue() { return value; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/interceptor/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/interceptor/package-info.java index d67cb6a468..d3ca06f58d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/interceptor/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/interceptor/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of repeat aop concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.repeat.interceptor; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/listener/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/listener/package-info.java index db3be41dae..e26921e1e2 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/listener/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/listener/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of repeat interceptor concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.repeat.listener; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/package-info.java index e247cdbeeb..205c741b57 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of repeat concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.repeat; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/policy/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/policy/package-info.java index 6cdf5440d6..189c508fd6 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/policy/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/policy/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of repeat policy concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.repeat.policy; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/RepeatTemplate.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/RepeatTemplate.java index 1fc00e8bbb..4a90a268bb 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/RepeatTemplate.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/RepeatTemplate.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2023 the original author or authors. + * Copyright 2006-2025 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. @@ -24,6 +24,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.repeat.CompletionPolicy; import org.springframework.batch.repeat.RepeatCallback; import org.springframework.batch.repeat.RepeatContext; @@ -34,6 +35,7 @@ import org.springframework.batch.repeat.exception.DefaultExceptionHandler; import org.springframework.batch.repeat.exception.ExceptionHandler; import org.springframework.batch.repeat.policy.DefaultResultCompletionPolicy; +import org.springframework.lang.Contract; import org.springframework.util.Assert; /** @@ -61,7 +63,7 @@ * * @author Dave Syer * @author Mahmoud Ben Hassine - * + * @author Stefano Cordio */ public class RepeatTemplate implements RepeatOperations { @@ -79,7 +81,7 @@ public class RepeatTemplate implements RepeatOperations { * @param listeners listeners to be used */ public void setListeners(RepeatListener[] listeners) { - this.listeners = Arrays.asList(listeners).toArray(new RepeatListener[listeners.length]); + this.listeners = listeners.clone(); } /** @@ -89,7 +91,7 @@ public void setListeners(RepeatListener[] listeners) { public void registerListener(RepeatListener listener) { List list = new ArrayList<>(Arrays.asList(listeners)); list.add(listener); - listeners = list.toArray(new RepeatListener[list.size()]); + listeners = list.toArray(new RepeatListener[0]); } /** @@ -126,7 +128,7 @@ public void setCompletionPolicy(CompletionPolicy terminationPolicy) { * finished. Wait for the whole batch to finish before returning even if the task * executor is asynchronous. * - * @see org.springframework.batch.repeat.RepeatOperations#iterate(org.springframework.batch.repeat.RepeatCallback) + * @see RepeatOperations#iterate(RepeatCallback) */ @Override public RepeatStatus iterate(RepeatCallback callback) { @@ -156,7 +158,7 @@ public RepeatStatus iterate(RepeatCallback callback) { * the results from the callback. * */ - private RepeatStatus executeInternal(final RepeatCallback callback) { + private RepeatStatus executeInternal(RepeatCallback callback) { // Reset the termination policy if there is one... RepeatContext context = start(); @@ -288,7 +290,7 @@ private void doHandle(Throwable throwable, RepeatContext context, Collection false") + protected final boolean canContinue(@Nullable RepeatStatus value) { + return value != null && value.isContinuable(); } private boolean isMarkedComplete(RepeatContext context) { @@ -408,12 +406,12 @@ private boolean isMarkedComplete(RepeatContext context) { * @param context the current batch context. * @param value the result of the callback to process. */ - protected void executeAfterInterceptors(final RepeatContext context, RepeatStatus value) { + protected void executeAfterInterceptors(RepeatContext context, @Nullable RepeatStatus value) { // Don't re-throw exceptions here: let the exception handler deal with // that... - if (value != null && value.isContinuable()) { + if (canContinue(value)) { for (int i = listeners.length; i-- > 0;) { RepeatListener interceptor = listeners[i]; interceptor.after(context, value); @@ -429,8 +427,7 @@ protected void executeAfterInterceptors(final RepeatContext context, RepeatStatu * @param result the result of the latest batch item processing. * @return true if complete according to policy and result value, else false. * - * @see org.springframework.batch.repeat.CompletionPolicy#isComplete(RepeatContext, - * RepeatStatus) + * @see CompletionPolicy#isComplete(RepeatContext, RepeatStatus) */ protected boolean isComplete(RepeatContext context, RepeatStatus result) { boolean complete = completionPolicy.isComplete(context, result); @@ -446,7 +443,7 @@ protected boolean isComplete(RepeatContext context, RepeatStatus result) { * @return true if complete according to policy alone not including result value, else * false. * - * @see org.springframework.batch.repeat.CompletionPolicy#isComplete(RepeatContext) + * @see CompletionPolicy#isComplete(RepeatContext) */ protected boolean isComplete(RepeatContext context) { boolean complete = completionPolicy.isComplete(context); @@ -461,7 +458,7 @@ protected boolean isComplete(RepeatContext context) { * @return a {@link RepeatContext} object that can be used by the implementation to * store internal state for a batch step. * - * @see org.springframework.batch.repeat.CompletionPolicy#start(RepeatContext) + * @see CompletionPolicy#start(RepeatContext) */ protected RepeatContext start() { RepeatContext parent = RepeatSynchronizationManager.getContext(); @@ -475,7 +472,7 @@ protected RepeatContext start() { * Delegate to the {@link CompletionPolicy}. * @param context the value returned by start. * - * @see org.springframework.batch.repeat.CompletionPolicy#update(RepeatContext) + * @see CompletionPolicy#update(RepeatContext) */ protected void update(RepeatContext context) { completionPolicy.update(context); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/ResultHolder.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/ResultHolder.java index 86764f3f47..d1d8c43212 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/ResultHolder.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/ResultHolder.java @@ -16,6 +16,7 @@ package org.springframework.batch.repeat.support; +import org.jspecify.annotations.Nullable; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.batch.repeat.RepeatContext; @@ -34,14 +35,14 @@ interface ResultHolder { * yet. * @return the result, or null if there is none. */ - RepeatStatus getResult(); + @Nullable RepeatStatus getResult(); /** * Get the error for client from this holder if any. Does not block if none is * available yet. * @return the error, or null if there is none. */ - Throwable getError(); + @Nullable Throwable getError(); /** * Get the context in which the result evaluation is executing. diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/TaskExecutorRepeatTemplate.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/TaskExecutorRepeatTemplate.java index 3ee8e22617..f49afc2245 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/TaskExecutorRepeatTemplate.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/TaskExecutorRepeatTemplate.java @@ -16,6 +16,7 @@ package org.springframework.batch.repeat.support; +import org.jspecify.annotations.Nullable; import org.springframework.batch.repeat.RepeatCallback; import org.springframework.batch.repeat.RepeatContext; import org.springframework.batch.repeat.RepeatException; @@ -25,6 +26,8 @@ import org.springframework.core.task.TaskExecutor; import org.springframework.util.Assert; +import java.util.Objects; + /** * Provides {@link RepeatOperations} support including interceptors that can be used to * modify or monitor the behaviour at run time.
@@ -44,7 +47,7 @@ * * @author Dave Syer * @author Mahmoud Ben Hassine - * + * @author Stefano Cordio */ public class TaskExecutorRepeatTemplate extends RepeatTemplate { @@ -126,7 +129,7 @@ protected RepeatStatus getNextResult(RepeatContext context, RepeatCallback callb if (result.getError() != null) { throw result.getError(); } - return result.getResult(); + return Objects.requireNonNull(result.getResult()); } /** @@ -196,18 +199,14 @@ private class ExecutingRunnable implements Runnable, ResultHolder { private final ResultQueue queue; - private volatile RepeatStatus result; + private volatile @Nullable RepeatStatus result; - private volatile Throwable error; + private volatile @Nullable Throwable error; public ExecutingRunnable(RepeatCallback callback, RepeatContext context, ResultQueue queue) { - - super(); - this.callback = callback; this.context = context; this.queue = queue; - } /** @@ -264,7 +263,7 @@ public void run() { * finish. */ @Override - public RepeatStatus getResult() { + public @Nullable RepeatStatus getResult() { return result; } @@ -273,7 +272,7 @@ public RepeatStatus getResult() { * finish. */ @Override - public Throwable getError() { + public @Nullable Throwable getError() { return error; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/package-info.java index 6d690403cc..100283229d 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of repeat support concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.repeat.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/AnnotationMethodResolver.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/AnnotationMethodResolver.java index 69c75abb43..4c7c2d1535 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/AnnotationMethodResolver.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/AnnotationMethodResolver.java @@ -23,8 +23,9 @@ import java.util.concurrent.atomic.AtomicReference; import org.springframework.aop.support.AopUtils; + +import org.jspecify.annotations.Nullable; import org.springframework.core.annotation.AnnotationUtils; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ObjectUtils; import org.springframework.util.ReflectionUtils; @@ -61,9 +62,8 @@ public AnnotationMethodResolver(Class annotationType) { * @throws IllegalArgumentException if more than one Method has the specified * annotation */ - @Nullable @Override - public Method findMethod(Object candidate) { + public @Nullable Method findMethod(Object candidate) { Assert.notNull(candidate, "candidate object must not be null"); Class targetClass = AopUtils.getTargetClass(candidate); if (targetClass == null) { @@ -81,9 +81,8 @@ public Method findMethod(Object candidate) { * @throws IllegalArgumentException if more than one Method has the specified * annotation */ - @Nullable @Override - public Method findMethod(final Class clazz) { + public @Nullable Method findMethod(Class clazz) { Assert.notNull(clazz, "class must not be null"); final AtomicReference annotatedMethod = new AtomicReference<>(); ReflectionUtils.doWithMethods(clazz, method -> { diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DatabaseType.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DatabaseType.java index d727cdc3cc..d5641a097b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DatabaseType.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DatabaseType.java @@ -16,14 +16,18 @@ package org.springframework.batch.support; +import org.jspecify.annotations.Nullable; import org.springframework.jdbc.support.JdbcUtils; import org.springframework.jdbc.support.MetaDataAccessException; import org.springframework.util.StringUtils; import javax.sql.DataSource; import java.sql.DatabaseMetaData; -import java.util.HashMap; + +import java.util.Arrays; import java.util.Map; +import java.util.function.Function; +import java.util.stream.Collectors; /** * Enum representing a database type, such as DB2 or oracle. The type also contains a @@ -32,6 +36,7 @@ * * @author Lucas Ward * @author Mahmoud Ben Hassine + * @author Stefano Cordio * @since 2.0 */ public enum DatabaseType { @@ -40,14 +45,9 @@ public enum DatabaseType { HSQL("HSQL Database Engine"), SQLSERVER("Microsoft SQL Server"), MYSQL("MySQL"), ORACLE("Oracle"), POSTGRES("PostgreSQL"), SYBASE("Sybase"), H2("H2"), SQLITE("SQLite"), HANA("HDB"), MARIADB("MariaDB"); - private static final Map nameMap; + private static final Map DATABASE_TYPES = Arrays.stream(DatabaseType.values()) + .collect(Collectors.toMap(DatabaseType::getProductName, Function.identity())); - static { - nameMap = new HashMap<>(); - for (DatabaseType type : values()) { - nameMap.put(type.getProductName(), type); - } - } // A description is necessary due to the nature of database descriptions // in metadata. private final String productName; @@ -66,13 +66,11 @@ public String getProductName() { * @return the {@link DatabaseType} for given product name. * @throws IllegalArgumentException if none is found. */ - public static DatabaseType fromProductName(String productName) { - if (!nameMap.containsKey(productName)) { + public static DatabaseType fromProductName(@Nullable String productName) { + if (!DATABASE_TYPES.containsKey(productName)) { throw new IllegalArgumentException("DatabaseType not found for product name: [" + productName + "]"); } - else { - return nameMap.get(productName); - } + return DATABASE_TYPES.get(productName); } /** @@ -80,7 +78,7 @@ public static DatabaseType fromProductName(String productName) { * metadata. * @param dataSource {@link DataSource} to the database to be used. * @return {@link DatabaseType} for the {@link DataSource} specified. - * @throws MetaDataAccessException thrown if error occured during Metadata lookup. + * @throws MetaDataAccessException if an error occurred during Metadata lookup. */ public static DatabaseType fromMetaData(DataSource dataSource) throws MetaDataAccessException { String databaseProductName = JdbcUtils.extractDatabaseMetaData(dataSource, diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DefaultPropertyEditorRegistrar.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DefaultPropertyEditorRegistrar.java index 68e6d7f6fe..390d7db768 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DefaultPropertyEditorRegistrar.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DefaultPropertyEditorRegistrar.java @@ -20,6 +20,7 @@ import java.util.Map; import java.util.Map.Entry; +import org.jspecify.annotations.Nullable; import org.springframework.beans.PropertyEditorRegistrar; import org.springframework.beans.PropertyEditorRegistry; import org.springframework.beans.factory.config.CustomEditorConfigurer; @@ -34,11 +35,11 @@ * * @author Dave Syer * @author Mahmoud Ben Hassine - * + * @author Stefano Cordio */ public class DefaultPropertyEditorRegistrar implements PropertyEditorRegistrar { - private Map, PropertyEditor> customEditors; + private final Map, PropertyEditor> customEditors = new HashMap<>(); /** * Register the custom editors with the given registry. @@ -47,10 +48,8 @@ public class DefaultPropertyEditorRegistrar implements PropertyEditorRegistrar { */ @Override public void registerCustomEditors(PropertyEditorRegistry registry) { - if (this.customEditors != null) { - for (Entry, PropertyEditor> entry : customEditors.entrySet()) { - registry.registerCustomEditor(entry.getKey(), entry.getValue()); - } + for (Entry, PropertyEditor> entry : customEditors.entrySet()) { + registry.registerCustomEditor(entry.getKey(), entry.getValue()); } } @@ -61,7 +60,6 @@ public void registerCustomEditors(PropertyEditorRegistry registry) { * @see CustomEditorConfigurer#setCustomEditors(Map) */ public void setCustomEditors(Map customEditors) { - this.customEditors = new HashMap<>(); for (Entry entry : customEditors.entrySet()) { Object key = entry.getKey(); Class requiredType; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodInvoker.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodInvoker.java index 16d95c7092..27441b2177 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodInvoker.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodInvoker.java @@ -16,7 +16,7 @@ package org.springframework.batch.support; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * A strategy interface for invoking a method. Typically used by adapters. @@ -26,7 +26,6 @@ */ public interface MethodInvoker { - @Nullable - Object invokeMethod(Object... args); + @Nullable Object invokeMethod(Object... args); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodInvokerUtils.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodInvokerUtils.java index 10603064fa..1ffc127112 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodInvokerUtils.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodInvokerUtils.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2024 the original author or authors. + * Copyright 2002-2025 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. @@ -21,9 +21,11 @@ import java.lang.reflect.Method; import java.util.concurrent.atomic.AtomicReference; +import org.jspecify.annotations.NonNull; import org.springframework.aop.framework.Advised; + +import org.jspecify.annotations.Nullable; import org.springframework.core.annotation.AnnotationUtils; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; import org.springframework.util.ObjectUtils; @@ -35,6 +37,7 @@ * @author Lucas Ward * @author Mahmoud Ben Hassine * @author Taeik Lim + * @author Stefano Cordio * @since 2.0 */ public abstract class MethodInvokerUtils { @@ -93,8 +96,7 @@ public static String getParamTypesString(Class... paramTypes) { * @param paramTypes - parameter types of the method to search for. * @return MethodInvoker if the method is found, null if it is not. */ - @Nullable - public static MethodInvoker getMethodInvokerForInterface(Class cls, String methodName, Object object, + public static @Nullable MethodInvoker getMethodInvokerForInterface(Class cls, String methodName, Object object, Class... paramTypes) { if (cls.isAssignableFrom(object.getClass())) { @@ -106,17 +108,18 @@ public static MethodInvoker getMethodInvokerForInterface(Class cls, String me } /** - * Create a MethodInvoker from the delegate based on the annotationType. Ensure that - * the annotated method has a valid set of parameters. + * Create a {@link MethodInvoker} from the delegate based on the annotationType. When + * found, it is ensured that the annotated method has a valid set of parameters. * @param annotationType the annotation to scan for * @param target the target object * @param expectedParamTypes the expected parameter types for the method - * @return a MethodInvoker + * @return a MethodInvoker, null if none is found. */ - public static MethodInvoker getMethodInvokerByAnnotation(final Class annotationType, - final Object target, final Class... expectedParamTypes) { + @SuppressWarnings("DataFlowIssue") + public static @Nullable MethodInvoker getMethodInvokerByAnnotation(Class annotationType, + Object target, Class... expectedParamTypes) { MethodInvoker mi = MethodInvokerUtils.getMethodInvokerByAnnotation(annotationType, target); - final Class targetClass = (target instanceof Advised advised) ? advised.getTargetSource().getTargetClass() + Class targetClass = (target instanceof Advised advised) ? advised.getTargetSource().getTargetClass() : target.getClass(); if (mi != null) { ReflectionUtils.doWithMethods(targetClass, method -> { @@ -141,28 +144,27 @@ public static MethodInvoker getMethodInvokerByAnnotation(final Class annotationType, - final Object target) { + public static @Nullable MethodInvoker getMethodInvokerByAnnotation(Class annotationType, + Object target) { Assert.notNull(target, "Target must not be null"); Assert.notNull(annotationType, "AnnotationType must not be null"); Assert.isTrue( ObjectUtils.containsElement(annotationType.getAnnotation(Target.class).value(), ElementType.METHOD), "Annotation [" + annotationType + "] is not a Method-level annotation."); - final Class targetClass = (target instanceof Advised advised) ? advised.getTargetSource().getTargetClass() + Class targetClass = (target instanceof Advised advised) ? advised.getTargetSource().getTargetClass() : target.getClass(); if (targetClass == null) { // Proxy with no target cannot have annotations return null; } - final AtomicReference annotatedMethod = new AtomicReference<>(); + AtomicReference<@Nullable Method> annotatedMethod = new AtomicReference<>(); ReflectionUtils.doWithMethods(targetClass, method -> { Annotation annotation = AnnotationUtils.findAnnotation(method, annotationType); if (annotation != null) { @@ -173,23 +175,19 @@ public static MethodInvoker getMethodInvokerByAnnotation(final Class methodHolder = new AtomicReference<>(); + public static @Nullable MethodInvoker getMethodInvokerForSingleArgument(Object target) { + AtomicReference<@Nullable Method> methodHolder = new AtomicReference<>(); ReflectionUtils.doWithMethods(target.getClass(), method -> { - if (method.getParameterTypes() == null || method.getParameterTypes().length != 1) { + if (method.getParameterTypes().length != 1) { return; } if (method.getReturnType().equals(Void.TYPE) || ReflectionUtils.isEqualsMethod(method)) { @@ -200,7 +198,7 @@ public static MethodInvoker getMethodInvokerForSingleArgument(Object target) { methodHolder.set(method); }); Method method = methodHolder.get(); - return new SimpleMethodInvoker(target, method); + return method == null ? null : new SimpleMethodInvoker(target, method); } } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodResolver.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodResolver.java index d06ca49809..e8ebd4f82b 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodResolver.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/MethodResolver.java @@ -18,7 +18,7 @@ import java.lang.reflect.Method; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Strategy interface for detecting a single Method on a Class. @@ -36,8 +36,7 @@ public interface MethodResolver { * @throws IllegalArgumentException if more than one Method defined on the given * candidate's Class matches this resolver's criteria */ - @Nullable - Method findMethod(Object candidate) throws IllegalArgumentException; + @Nullable Method findMethod(Object candidate) throws IllegalArgumentException; /** * Find a single Method on the given Class that matches this resolver's @@ -48,7 +47,6 @@ public interface MethodResolver { * @throws IllegalArgumentException if more than one Method defined on the given Class * matches this resolver's criteria */ - @Nullable - Method findMethod(Class clazz); + @Nullable Method findMethod(Class clazz); } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/PropertiesConverter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/PropertiesConverter.java index e108d6c0f4..06a2598dc7 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/PropertiesConverter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/PropertiesConverter.java @@ -21,8 +21,8 @@ import java.util.Map; import java.util.Properties; -import org.springframework.lang.NonNull; import org.springframework.util.Assert; + import org.springframework.util.StringUtils; /** @@ -50,7 +50,7 @@ private PropertiesConverter() { * @param stringToParse String to parse. Must not be {@code null}. * @return Properties parsed from each key=value pair. */ - public static Properties stringToProperties(@NonNull String stringToParse) { + public static Properties stringToProperties(String stringToParse) { Assert.notNull(stringToParse, "stringToParse must not be null"); if (!StringUtils.hasText(stringToParse)) { return new Properties(); @@ -76,7 +76,7 @@ public static Properties stringToProperties(@NonNull String stringToParse) { * {@code null}. * @return String representation of the properties object */ - public static String propertiesToString(@NonNull Properties propertiesToParse) { + public static String propertiesToString(Properties propertiesToParse) { Assert.notNull(propertiesToParse, "propertiesToParse must not be null"); if (propertiesToParse.isEmpty()) { return ""; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/SimpleMethodInvoker.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/SimpleMethodInvoker.java index 926dca6284..f2879861c7 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/SimpleMethodInvoker.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/SimpleMethodInvoker.java @@ -35,7 +35,8 @@ import java.util.Arrays; import org.springframework.aop.framework.Advised; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -53,7 +54,7 @@ public class SimpleMethodInvoker implements MethodInvoker { private final Object object; - private Method method; + private final Method method; public SimpleMethodInvoker(Object object, Method method) { Assert.notNull(object, "Object to invoke must not be null"); @@ -64,21 +65,25 @@ public SimpleMethodInvoker(Object object, Method method) { public SimpleMethodInvoker(Object object, String methodName, Class... paramTypes) { Assert.notNull(object, "Object to invoke must not be null"); - this.method = ClassUtils.getMethodIfAvailable(object.getClass(), methodName, paramTypes); - if (this.method == null) { + this.method = getMethodIfAvailable(object.getClass(), methodName, paramTypes); + this.object = object; + } + + private static Method getMethodIfAvailable(Class clazz, String methodName, Class... paramTypes) { + Method method = ClassUtils.getMethodIfAvailable(clazz, methodName, paramTypes); + if (method == null) { // try with no params - this.method = ClassUtils.getMethodIfAvailable(object.getClass(), methodName); + method = ClassUtils.getMethodIfAvailable(clazz, methodName); } - if (this.method == null) { - throw new IllegalArgumentException("No methods found for name: [" + methodName + "] in class: [" - + object.getClass() + "] with arguments of type: [" + Arrays.toString(paramTypes) + "]"); + if (method == null) { + throw new IllegalArgumentException("No methods found for name: [" + methodName + "] in class: [" + clazz + + "] with arguments of type: [" + Arrays.toString(paramTypes) + "]"); } - this.object = object; + return method; } - @Nullable @Override - public Object invokeMethod(Object... args) { + public @Nullable Object invokeMethod(Object... args) { Class[] parameterTypes = method.getParameterTypes(); Object[] invokeArgs; @@ -107,6 +112,7 @@ else if (parameterTypes.length != args.length) { } } + @SuppressWarnings("DataFlowIssue") private Object extractTarget(Object target, Method method) { if (target instanceof Advised) { Object source; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/package-info.java index 01ab17a99f..616df1b58c 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of support concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/ResourcelessTransactionManager.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/ResourcelessTransactionManager.java index 9675f54a3a..ba67102a6e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/ResourcelessTransactionManager.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/ResourcelessTransactionManager.java @@ -39,6 +39,7 @@ protected void doCommit(DefaultTransactionStatus status) throws TransactionExcep } } + @SuppressWarnings("DataFlowIssue") @Override protected Object doGetTransaction() throws TransactionException { Object transaction = new ResourcelessTransaction(); @@ -63,6 +64,7 @@ protected void doRollback(DefaultTransactionStatus status) throws TransactionExc } } + @SuppressWarnings("DataFlowIssue") @Override protected boolean isExistingTransaction(Object transaction) throws TransactionException { if (TransactionSynchronizationManager.hasResource(this)) { @@ -76,6 +78,7 @@ protected boolean isExistingTransaction(Object transaction) throws TransactionEx protected void doSetRollbackOnly(DefaultTransactionStatus status) throws TransactionException { } + @SuppressWarnings("DataFlowIssue") @Override protected void doCleanupAfterCompletion(Object transaction) { List resources = (List) TransactionSynchronizationManager.getResource(this); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/TransactionAwareBufferedWriter.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/TransactionAwareBufferedWriter.java index 808e073666..8b9d32a8b9 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/TransactionAwareBufferedWriter.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/TransactionAwareBufferedWriter.java @@ -87,6 +87,7 @@ public void setForceSync(boolean forceSync) { /** * @return the current buffer */ + @SuppressWarnings("DataFlowIssue") private StringBuilder getCurrentBuffer() { if (!TransactionSynchronizationManager.hasResource(bufferKey)) { @@ -175,7 +176,7 @@ private boolean transactionActive() { @Override public void close() throws IOException { if (transactionActive()) { - if (getCurrentBuffer().length() > 0) { + if (!getCurrentBuffer().isEmpty()) { TransactionSynchronizationManager.bindResource(closeKey, Boolean.TRUE); } return; diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/TransactionAwareProxyFactory.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/TransactionAwareProxyFactory.java index 6877db4a84..e518f07e39 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/TransactionAwareProxyFactory.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/TransactionAwareProxyFactory.java @@ -30,6 +30,7 @@ import org.aopalliance.intercept.MethodInterceptor; import org.aopalliance.intercept.MethodInvocation; +import org.jspecify.annotations.Nullable; import org.springframework.aop.framework.ProxyFactory; import org.springframework.transaction.support.TransactionSynchronization; import org.springframework.transaction.support.TransactionSynchronizationManager; @@ -217,7 +218,7 @@ public void afterCompletion(int status) { private class TransactionAwareInterceptor implements MethodInterceptor { @Override - public Object invoke(MethodInvocation invocation) throws Throwable { + public @Nullable Object invoke(MethodInvocation invocation) throws Throwable { if (!TransactionSynchronizationManager.isActualTransactionActive()) { return invocation.proceed(); diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/package-info.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/package-info.java index 19e932270a..5cfd27b96e 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/package-info.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/support/transaction/package-info.java @@ -3,7 +3,7 @@ * Infrastructure implementations of support transaction concerns. *

*/ -@NonNullApi +@NullMarked package org.springframework.batch.support.transaction; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/container/jms/BatchMessageListenerContainer.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/container/jms/BatchMessageListenerContainer.java index 5fab1c2686..9a191fbb32 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/container/jms/BatchMessageListenerContainer.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/container/jms/BatchMessageListenerContainer.java @@ -121,7 +121,7 @@ else if (ex instanceof Error error) { * jakarta.jms.Session, jakarta.jms.MessageConsumer) */ @Override - protected boolean receiveAndExecute(final Object invoker, final Session session, final MessageConsumer consumer) + protected boolean receiveAndExecute(Object invoker, final Session session, final MessageConsumer consumer) throws JMSException { return proxy.receiveAndExecute(invoker, session, consumer); } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/avro/support/AvroItemWriterTestSupport.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/avro/support/AvroItemWriterTestSupport.java index fbce9fad49..42d062172d 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/avro/support/AvroItemWriterTestSupport.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/avro/support/AvroItemWriterTestSupport.java @@ -26,6 +26,8 @@ import java.util.List; import org.springframework.batch.item.Chunk; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.avro.AvroItemReader; import org.springframework.batch.item.avro.builder.AvroItemReaderBuilder; @@ -91,17 +93,17 @@ public boolean exists() { } @Override - public URL getURL() throws IOException { + public @Nullable URL getURL() throws IOException { return null; } @Override - public URI getURI() throws IOException { + public @Nullable URI getURI() throws IOException { return null; } @Override - public File getFile() throws IOException { + public @Nullable File getFile() throws IOException { return null; } @@ -116,12 +118,12 @@ public long lastModified() throws IOException { } @Override - public Resource createRelative(String relativePath) throws IOException { + public @Nullable Resource createRelative(String relativePath) throws IOException { return null; } @Override - public String getFilename() { + public @Nullable String getFilename() { return null; } @@ -131,7 +133,7 @@ public String getDescription() { } @Override - public InputStream getInputStream() throws IOException { + public @Nullable InputStream getInputStream() throws IOException { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/AbstractPagingItemReaderParameterTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/AbstractPagingItemReaderParameterTests.java index d3d09d374e..ae100c172a 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/AbstractPagingItemReaderParameterTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/AbstractPagingItemReaderParameterTests.java @@ -48,13 +48,13 @@ void setUp() throws Exception { @AfterEach void tearDown() { - ((ItemStream) tested).close(); + tested.close(); } @Test void testRead() throws Exception { - ((ItemStream) tested).open(executionContext); + tested.open(executionContext); Foo foo2 = tested.read(); assertEquals(2, foo2.getValue()); @@ -76,7 +76,7 @@ void testRead() throws Exception { void testReadAfterJumpFirstPage() throws Exception { executionContext.putInt(getName() + ".read.count", 2); - ((ItemStream) tested).open(executionContext); + tested.open(executionContext); Foo foo4 = tested.read(); assertEquals(4, foo4.getValue()); @@ -92,7 +92,7 @@ void testReadAfterJumpFirstPage() throws Exception { void testReadAfterJumpSecondPage() throws Exception { executionContext.putInt(getName() + ".read.count", 3); - ((ItemStream) tested).open(executionContext); + tested.open(executionContext); Foo foo5 = tested.read(); assertEquals(5, foo5.getValue()); diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcBatchItemWriterNamedParameterTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcBatchItemWriterNamedParameterTests.java index b44ae947ae..f088c27821 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcBatchItemWriterNamedParameterTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcBatchItemWriterNamedParameterTests.java @@ -19,6 +19,7 @@ import org.hamcrest.BaseMatcher; import org.hamcrest.Description; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; @@ -184,7 +185,7 @@ void testWriteAndFlushWithFailure() { assertEquals("ERROR", exception.getMessage()); } - public static SqlParameterSource[] eqSqlParameterSourceArray(SqlParameterSource[] in) { + public static @Nullable SqlParameterSource[] eqSqlParameterSourceArray(SqlParameterSource[] in) { argThat(new SqlParameterSourceArrayEquals(in)); return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingItemReaderCommonTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingItemReaderCommonTests.java index c80cfc9c90..f760076a6d 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingItemReaderCommonTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingItemReaderCommonTests.java @@ -26,8 +26,11 @@ import org.springframework.batch.item.database.support.HsqlPagingQueryProvider; import org.springframework.batch.item.sample.Foo; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; +import static org.springframework.test.annotation.DirtiesContext.ClassMode.BEFORE_CLASS; + /** * @author Dave Syer * @author Thomas Risberg @@ -35,6 +38,7 @@ * @author Mahmoud Ben Hassine */ @SpringJUnitConfig +@DirtiesContext(classMode = BEFORE_CLASS) public class JdbcPagingItemReaderCommonTests extends AbstractItemStreamItemReaderTests { @Autowired diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingItemReaderIntegrationTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingItemReaderIntegrationTests.java index aa3c0f52fc..b5e0b7bef2 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingItemReaderIntegrationTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingItemReaderIntegrationTests.java @@ -23,38 +23,38 @@ import org.springframework.batch.item.sample.Foo; /** - * Tests for {@link JpaPagingItemReader}. + * Tests for {@link JdbcPagingItemReader}. * * @author Thomas Risberg * @author Michael Minella * @author Mahmoud Ben Hassine */ -public class JdbcPagingItemReaderIntegrationTests extends AbstractGenericDataSourceItemReaderIntegrationTests { +class JdbcPagingItemReaderIntegrationTests extends AbstractGenericDataSourceItemReaderIntegrationTests { @Override protected ItemReader createItemReader() throws Exception { - JdbcPagingItemReader inputSource = new JdbcPagingItemReader<>(); - inputSource.setDataSource(dataSource); + JdbcPagingItemReader itemReader = new JdbcPagingItemReader<>(); + itemReader.setDataSource(dataSource); HsqlPagingQueryProvider queryProvider = new HsqlPagingQueryProvider(); queryProvider.setSelectClause("select ID, NAME, VALUE"); queryProvider.setFromClause("from T_FOOS"); Map sortKeys = new LinkedHashMap<>(); sortKeys.put("ID", Order.ASCENDING); queryProvider.setSortKeys(sortKeys); - inputSource.setQueryProvider(queryProvider); - inputSource.setRowMapper((rs, i) -> { + itemReader.setQueryProvider(queryProvider); + itemReader.setRowMapper((rs, i) -> { Foo foo = new Foo(); foo.setId(rs.getInt(1)); foo.setName(rs.getString(2)); foo.setValue(rs.getInt(3)); return foo; }); - inputSource.setPageSize(3); - inputSource.afterPropertiesSet(); - inputSource.setSaveState(true); + itemReader.setPageSize(3); + itemReader.afterPropertiesSet(); + itemReader.setSaveState(true); - return inputSource; + return itemReader; } } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingQueryIntegrationTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingQueryIntegrationTests.java index 0df112ad57..f70f6ce943 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingQueryIntegrationTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/JdbcPagingQueryIntegrationTests.java @@ -41,6 +41,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotSame; import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.springframework.test.annotation.DirtiesContext.ClassMode.BEFORE_CLASS; /** * @author Dave Syer @@ -49,7 +50,7 @@ * @since 2.1 */ @SpringJUnitConfig(locations = "JdbcPagingItemReaderCommonTests-context.xml") -@DirtiesContext(classMode = DirtiesContext.ClassMode.BEFORE_CLASS) +@DirtiesContext(classMode = BEFORE_CLASS) class JdbcPagingQueryIntegrationTests { private static final Log logger = LogFactory.getLog(JdbcPagingQueryIntegrationTests.class); diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/orm/JpaNamedQueryProviderTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/orm/JpaNamedQueryProviderTests.java index ac659c8f31..d33fd56f63 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/orm/JpaNamedQueryProviderTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/orm/JpaNamedQueryProviderTests.java @@ -20,6 +20,7 @@ import jakarta.persistence.TypedQuery; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; @@ -65,7 +66,6 @@ void testJpaNamedQueryProviderEntityClassIsProvided() { } @Test - @SuppressWarnings("unchecked") void testNamedQueryCreation() throws Exception { // given String namedQuery = "allFoos"; @@ -82,7 +82,7 @@ void testNamedQueryCreation() throws Exception { Query result = jpaNamedQueryProvider.createQuery(); // then - Assert.notNull(result, "Result query must not be null"); + assertNotNull(result); verify(entityManager).createNamedQuery(namedQuery, Foo.class); } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/support/SqlPagingQueryUtilsTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/support/SqlPagingQueryUtilsTests.java index b3ff056e29..6ce2e30504 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/support/SqlPagingQueryUtilsTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/database/support/SqlPagingQueryUtilsTests.java @@ -21,6 +21,7 @@ import java.util.LinkedHashMap; import java.util.Map; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.item.database.Order; @@ -118,12 +119,12 @@ public TestSqlPagingQueryProvider(String select, String from, Map } @Override - public String generateFirstPageQuery(int pageSize) { + public @Nullable String generateFirstPageQuery(int pageSize) { return null; } @Override - public String generateRemainingPagesQuery(int pageSize) { + public @Nullable String generateRemainingPagesQuery(int pageSize) { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemReaderTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemReaderTests.java index daacb784b1..05edd689aa 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemReaderTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemReaderTests.java @@ -27,6 +27,7 @@ import java.io.IOException; import java.io.InputStream; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -540,7 +541,7 @@ public String getDescription() { } @Override - public InputStream getInputStream() throws IOException { + public @Nullable InputStream getInputStream() throws IOException { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemWriterTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemWriterTests.java index f8f4df0ccb..be127212c2 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemWriterTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemWriterTests.java @@ -328,7 +328,7 @@ void testWriteStringNotTransactional() { writeStringTransactionCheck(TEST_STRING); } - private void writeStringTransactionCheck(final String expectedInTransaction) { + private void writeStringTransactionCheck(String expectedInTransaction) { PlatformTransactionManager transactionManager = new ResourcelessTransactionManager(); writer.open(executionContext); diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/MultiResourceItemReaderIntegrationTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/MultiResourceItemReaderIntegrationTests.java index 80a6a5b32c..5362a27e1a 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/MultiResourceItemReaderIntegrationTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/MultiResourceItemReaderIntegrationTests.java @@ -21,6 +21,7 @@ import java.io.InputStream; import java.util.Comparator; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -34,7 +35,6 @@ import org.springframework.core.io.ByteArrayResource; import org.springframework.core.io.FileSystemResource; import org.springframework.core.io.Resource; -import org.springframework.lang.Nullable; import org.springframework.test.util.ReflectionTestUtils; /** @@ -428,9 +428,9 @@ private static class ItemStreamReaderImpl implements ResourceAwareItemReaderItem private boolean closeCalled = false; - @Nullable @Override - public String read() throws Exception, UnexpectedInputException, ParseException, NonTransientResourceException { + public @Nullable String read() + throws Exception, UnexpectedInputException, ParseException, NonTransientResourceException { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/MultiResourceItemWriterFlatFileTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/MultiResourceItemWriterFlatFileTests.java index ab23affa63..f2e4a6e7b5 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/MultiResourceItemWriterFlatFileTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/MultiResourceItemWriterFlatFileTests.java @@ -17,6 +17,7 @@ import java.io.File; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -49,7 +50,7 @@ public WriterCallback(Chunk list) { } @Override - public Void doInTransaction(TransactionStatus status) { + public @Nullable Void doInTransaction(TransactionStatus status) { try { tested.write(list); } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/mapping/BeanWrapperFieldSetMapperTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/mapping/BeanWrapperFieldSetMapperTests.java index 9802d8622b..7f9fc3fef7 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/mapping/BeanWrapperFieldSetMapperTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/mapping/BeanWrapperFieldSetMapperTests.java @@ -29,6 +29,7 @@ import java.util.Properties; import java.util.TimeZone; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -46,7 +47,6 @@ import org.springframework.core.convert.ConversionService; import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.support.DefaultConversionService; -import org.springframework.lang.Nullable; import org.springframework.test.util.ReflectionTestUtils; import org.springframework.validation.BindException; import org.springframework.validation.DataBinder; @@ -799,16 +799,15 @@ public boolean canConvert(@Nullable TypeDescriptor sourceType, TypeDescriptor ta return true; } - @Nullable @Override @SuppressWarnings("unchecked") - public T convert(@Nullable Object source, Class targetType) { + public @Nullable T convert(@Nullable Object source, Class targetType) { return (T) "CONVERTED"; } - @Nullable @Override - public Object convert(@Nullable Object source, @Nullable TypeDescriptor sourceType, TypeDescriptor targetType) { + public @Nullable Object convert(@Nullable Object source, @Nullable TypeDescriptor sourceType, + TypeDescriptor targetType) { return "CONVERTED"; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/transform/DefaultFieldSetTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/transform/DefaultFieldSetTests.java index 2c4d09c58b..692d8476b1 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/transform/DefaultFieldSetTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/transform/DefaultFieldSetTests.java @@ -457,7 +457,7 @@ void testToStringWithoutNames() { @Test void testToStringNullTokens() { fieldSet = new DefaultFieldSet(null); - assertEquals("", fieldSet.toString()); + assertEquals("[]", fieldSet.toString()); } @Test diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/function/SupplierItemReaderTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/function/SupplierItemReaderTests.java index f7587661d1..435e71278d 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/function/SupplierItemReaderTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/function/SupplierItemReaderTests.java @@ -17,6 +17,7 @@ import java.util.function.Supplier; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; @@ -31,7 +32,7 @@ class SupplierItemReaderTests { private int count = 1; @Override - public String get() { + public @Nullable String get() { return count <= 2 ? "foo" + count++ : null; } }; diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/json/JsonItemReaderTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/json/JsonItemReaderTests.java index dbffb91588..a251475be9 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/json/JsonItemReaderTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/json/JsonItemReaderTests.java @@ -18,6 +18,7 @@ import java.io.InputStream; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.Mock; @@ -114,7 +115,7 @@ public String getDescription() { } @Override - public InputStream getInputStream() { + public @Nullable InputStream getInputStream() { return null; } @@ -141,7 +142,7 @@ public String getDescription() { } @Override - public InputStream getInputStream() { + public @Nullable InputStream getInputStream() { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/sample/FooService.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/sample/FooService.java index 64f078e485..df56cbda1c 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/sample/FooService.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/sample/FooService.java @@ -18,6 +18,8 @@ import java.util.ArrayList; import java.util.List; +import org.jspecify.annotations.Nullable; + /** * Custom class that contains the logic of providing and processing {@link Foo} objects. * It serves the purpose to show how providing/processing logic contained in a custom @@ -38,7 +40,7 @@ public class FooService { private final List processedFooNameValuePairs = new ArrayList<>(GENERATION_LIMIT); - public Foo generateFoo() { + public @Nullable Foo generateFoo() { if (counter++ >= GENERATION_LIMIT) return null; diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/ClassifierCompositeItemProcessorTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/ClassifierCompositeItemProcessorTests.java index de0fa213d5..6fa093e981 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/ClassifierCompositeItemProcessorTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/ClassifierCompositeItemProcessorTests.java @@ -20,11 +20,11 @@ import java.util.HashMap; import java.util.Map; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.item.ItemProcessor; import org.springframework.classify.PatternMatchingClassifier; import org.springframework.classify.SubclassClassifier; -import org.springframework.lang.Nullable; /** * @author Jimmy Praet @@ -37,16 +37,16 @@ void testBasicClassifierCompositeItemProcessor() throws Exception { ClassifierCompositeItemProcessor processor = new ClassifierCompositeItemProcessor<>(); ItemProcessor fooProcessor = new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { return "foo: " + item; } }; ItemProcessor defaultProcessor = new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { return item; } }; @@ -70,23 +70,23 @@ void testGenericsClassifierCompositeItemProcessor() throws Exception { ClassifierCompositeItemProcessor processor = new ClassifierCompositeItemProcessor<>(); ItemProcessor intProcessor = new ItemProcessor<>() { - @Nullable + @Override - public String process(Integer item) throws Exception { + public @Nullable String process(Integer item) throws Exception { return "int: " + item; } }; ItemProcessor longProcessor = new ItemProcessor<>() { - @Nullable + @Override - public StringBuffer process(Long item) throws Exception { + public @Nullable StringBuffer process(Long item) throws Exception { return new StringBuffer("long: " + item); } }; ItemProcessor defaultProcessor = new ItemProcessor<>() { - @Nullable + @Override - public StringBuilder process(Number item) throws Exception { + public @Nullable StringBuilder process(Number item) throws Exception { return new StringBuilder("number: " + item); } }; diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/ItemCountingItemStreamItemReaderTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/ItemCountingItemStreamItemReaderTests.java index c2d75646cf..8c7f7113e4 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/ItemCountingItemStreamItemReaderTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/ItemCountingItemStreamItemReaderTests.java @@ -23,10 +23,10 @@ import java.util.Arrays; import java.util.Iterator; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -145,9 +145,8 @@ protected void doOpen() throws Exception { openCalled = true; } - @Nullable @Override - protected String doRead() throws Exception { + protected @Nullable String doRead() throws Exception { if (!items.hasNext()) { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/SingleItemPeekableItemReaderTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/SingleItemPeekableItemReaderTests.java index ef72d9ab26..e10b61615d 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/SingleItemPeekableItemReaderTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/SingleItemPeekableItemReaderTests.java @@ -21,9 +21,9 @@ import java.util.Arrays; import java.util.List; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -128,9 +128,8 @@ protected void doOpen() throws Exception { counter = 0; } - @Nullable @Override - protected T doRead() throws Exception { + protected @Nullable T doRead() throws Exception { if (counter >= list.size()) { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/xml/StaxEventItemReaderTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/xml/StaxEventItemReaderTests.java index c1a5ecad43..39553e7b3a 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/xml/StaxEventItemReaderTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/item/xml/StaxEventItemReaderTests.java @@ -17,6 +17,7 @@ import org.hamcrest.MatcherAssert; import org.hamcrest.Matchers; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -767,7 +768,7 @@ private boolean isFragmentRootElement(String name) { private static class ItemCountAwareMockFragmentUnmarshaller extends MockFragmentUnmarshaller { @Override - public Object unmarshal(Source source) throws XmlMappingException, IOException { + public @Nullable Object unmarshal(Source source) throws XmlMappingException, IOException { List fragment = (List) super.unmarshal(source); if (fragment != null) { return new ItemCountAwareFragment(fragment); @@ -833,7 +834,7 @@ public String getDescription() { } @Override - public InputStream getInputStream() throws IOException { + public @Nullable InputStream getInputStream() throws IOException { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/poller/DirectPollerTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/poller/DirectPollerTests.java index 9295e9e535..6a2f77bd00 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/poller/DirectPollerTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/poller/DirectPollerTests.java @@ -96,7 +96,7 @@ void testWithError() { assertEquals("Expected", exception.getCause().getMessage()); } - private void sleepAndCreateStringInBackground(final long duration) { + private void sleepAndCreateStringInBackground(long duration) { new Thread(() -> { try { Thread.sleep(duration); diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/interceptor/RepeatOperationsInterceptorTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/interceptor/RepeatOperationsInterceptorTests.java index 419553bea6..d68f8bb8bd 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/interceptor/RepeatOperationsInterceptorTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/interceptor/RepeatOperationsInterceptorTests.java @@ -23,6 +23,7 @@ import org.aopalliance.intercept.MethodInterceptor; import org.aopalliance.intercept.MethodInvocation; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.aop.framework.Advised; @@ -236,7 +237,7 @@ public void setMaxService(int maxService) { } @Override - public Object service() throws Exception { + public @Nullable Object service() throws Exception { count++; if (count <= maxService) { return count; diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/support/ChunkedRepeatTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/support/ChunkedRepeatTests.java index c6c5e4c88c..bc9f3aef39 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/support/ChunkedRepeatTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/support/ChunkedRepeatTests.java @@ -16,6 +16,7 @@ package org.springframework.batch.repeat.support; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.item.ItemReader; @@ -25,7 +26,6 @@ import org.springframework.batch.repeat.callback.NestedRepeatCallback; import org.springframework.batch.repeat.policy.SimpleCompletionPolicy; import org.springframework.core.task.SimpleAsyncTaskExecutor; -import org.springframework.lang.Nullable; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; @@ -156,9 +156,8 @@ void increment() { ItemReader truncated = new ItemReader<>() { int count = 0; - @Nullable @Override - public Trade read() throws Exception { + public @Nullable Trade read() throws Exception { if (count++ < 2) return provider.read(); return null; diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/support/ResultHolderResultQueueTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/support/ResultHolderResultQueueTests.java index 9d516b3e8f..15264550a7 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/support/ResultHolderResultQueueTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/repeat/support/ResultHolderResultQueueTests.java @@ -18,6 +18,7 @@ import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertTrue; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.repeat.RepeatContext; import org.springframework.batch.repeat.RepeatStatus; @@ -61,7 +62,7 @@ public TestResultHolder(RepeatStatus result) { } @Override - public RepeatContext getContext() { + public @Nullable RepeatContext getContext() { return null; } diff --git a/spring-batch-infrastructure/src/test/java/org/springframework/batch/support/transaction/ConcurrentTransactionAwareProxyTests.java b/spring-batch-infrastructure/src/test/java/org/springframework/batch/support/transaction/ConcurrentTransactionAwareProxyTests.java index 7cd708dd10..664418166f 100644 --- a/spring-batch-infrastructure/src/test/java/org/springframework/batch/support/transaction/ConcurrentTransactionAwareProxyTests.java +++ b/spring-batch-infrastructure/src/test/java/org/springframework/batch/support/transaction/ConcurrentTransactionAwareProxyTests.java @@ -112,7 +112,7 @@ void testTransactionalContains() { assertFalse(result); } - private void testSet(final Set set) throws Exception { + private void testSet(Set set) throws Exception { for (int i = 0; i < outerMax; i++) { @@ -138,7 +138,7 @@ private void testSet(final Set set) throws Exception { } - private void testList(final List list, final boolean mutate) throws Exception { + private void testList(List list, final boolean mutate) throws Exception { for (int i = 0; i < outerMax; i++) { @@ -170,7 +170,7 @@ private void testList(final List list, final boolean mutate) throws Exce } - private void testMap(final Map> map) throws Exception { + private void testMap(Map> map) throws Exception { int numberOfKeys = outerMax; @@ -197,7 +197,7 @@ private void testMap(final Map> map) throws Exception } - private String saveInSetAndAssert(final Set set, final String value) { + private String saveInSetAndAssert(Set set, final String value) { new TransactionTemplate(transactionManager).execute((TransactionCallback) status -> { set.add(value); @@ -210,7 +210,7 @@ private String saveInSetAndAssert(final Set set, final String value) { } - private String saveInListAndAssert(final List list, final String value) { + private String saveInListAndAssert(List list, final String value) { new TransactionTemplate(transactionManager).execute((TransactionCallback) status -> { list.add(value); @@ -223,7 +223,7 @@ private String saveInListAndAssert(final List list, final String value) } - private Map saveInMapAndAssert(final Map> map, final Long id, + private Map saveInMapAndAssert(Map> map, final Long id, final String value) { new TransactionTemplate(transactionManager).execute((TransactionCallback) status -> { From f8c02e56fbddeb065757cad70fefe4c3b075e053 Mon Sep 17 00:00:00 2001 From: Stefano Cordio Date: Mon, 9 Jun 2025 15:54:20 +0200 Subject: [PATCH 2/2] Migrate `spring-batch-core` to JSpecify annotations Signed-off-by: Stefano Cordio --- .../batch/core/SpringBatchVersion.java | 5 +- .../batch/core/configuration/JobLocator.java | 3 +- .../annotation/package-info.java | 4 +- .../core/configuration/package-info.java | 4 +- .../support/DefaultJobLoader.java | 10 +-- .../configuration/support/GroupAwareJob.java | 6 +- .../configuration/support/MapJobRegistry.java | 3 +- .../support/MapStepRegistry.java | 4 +- .../configuration/support/package-info.java | 4 +- .../xml/ExceptionElementParser.java | 4 +- .../core/configuration/xml/JobParser.java | 4 +- .../core/configuration/xml/package-info.java | 4 +- .../DefaultJobParametersConverter.java | 6 +- .../converter/JobParametersConverter.java | 4 ++ .../batch/core/converter/package-info.java | 4 +- .../batch/core/job/AbstractJob.java | 5 +- .../springframework/batch/core/job/Job.java | 6 +- .../batch/core/job/JobExecution.java | 14 ++-- .../batch/core/job/SimpleJob.java | 4 +- .../batch/core/job/builder/package-info.java | 5 +- .../batch/core/job/flow/FlowExecutor.java | 6 +- .../batch/core/job/flow/FlowJob.java | 6 +- .../core/job/flow/JobExecutionDecider.java | 3 +- .../batch/core/job/flow/JobFlowExecutor.java | 6 +- .../batch/core/job/flow/package-info.java | 5 +- .../core/job/flow/support/SimpleFlow.java | 3 +- .../job/flow/support/StateTransition.java | 3 +- .../core/job/flow/support/package-info.java | 5 +- .../job/flow/support/state/SplitState.java | 7 +- .../job/flow/support/state/package-info.java | 5 +- .../batch/core/job/package-info.java | 5 +- .../CompositeJobParametersValidator.java | 6 +- .../DefaultJobParametersValidator.java | 2 +- .../core/job/parameters/JobParameter.java | 5 +- .../core/job/parameters/JobParameters.java | 48 +++++-------- .../job/parameters/JobParametersBuilder.java | 33 +++++---- .../parameters/JobParametersIncrementer.java | 2 +- .../parameters/JobParametersValidator.java | 2 +- .../batch/core/launch/JobOperator.java | 6 +- .../batch/core/launch/package-info.java | 5 +- ...FieldMaxValueJobParametersIncrementer.java | 3 +- .../core/launch/support/RunIdIncrementer.java | 3 +- .../launch/support/SimpleJobOperator.java | 5 +- .../support/TaskExecutorJobLauncher.java | 5 +- .../core/launch/support/package-info.java | 5 +- .../CompositeItemProcessListener.java | 3 +- .../CompositeStepExecutionListener.java | 6 +- .../ExecutionContextPromotionListener.java | 6 +- .../core/listener/ItemProcessListener.java | 3 +- .../core/listener/JobListenerMetaData.java | 6 +- .../MethodInvokerMethodInterceptor.java | 4 +- .../listener/MulticasterBatchListener.java | 6 +- .../core/listener/StepExecutionListener.java | 6 +- .../core/listener/StepListenerMetaData.java | 6 +- .../batch/core/listener/package-info.java | 5 +- .../core/observability/BatchMetrics.java | 7 +- .../batch/core/package-info.java | 5 +- .../batch/core/partition/package-info.java | 4 +- .../support/AbstractPartitionHandler.java | 2 +- .../support/TaskExecutorPartitionHandler.java | 4 +- .../core/partition/support/package-info.java | 4 +- .../repository/dao/ExecutionContextDao.java | 10 +-- .../core/repository/dao/JobExecutionDao.java | 8 +-- .../core/repository/dao/JobInstanceDao.java | 15 ++-- .../core/repository/dao/StepExecutionDao.java | 9 ++- .../dao/jdbc/JdbcExecutionContextDao.java | 12 ++-- .../dao/jdbc/JdbcJobExecutionDao.java | 13 ++-- .../dao/jdbc/JdbcJobInstanceDao.java | 15 ++-- .../dao/jdbc/JdbcStepExecutionDao.java | 9 ++- .../dao/mongodb/MongoJobExecutionDao.java | 6 +- .../dao/mongodb/MongoJobInstanceDao.java | 8 ++- .../dao/mongodb/MongoStepExecutionDao.java | 6 +- .../core/repository/dao/package-info.java | 4 +- .../core/repository/explore/JobExplorer.java | 27 +++---- .../core/repository/explore/package-info.java | 4 +- .../support/JobExplorerFactoryBean.java | 6 +- .../explore/support/SimpleJobExplorer.java | 27 +++---- .../explore/support/package-info.java | 4 +- .../batch/core/repository/package-info.java | 4 +- .../support/JdbcJobRepositoryFactoryBean.java | 5 +- .../support/JobRepositoryFactoryBean.java | 12 ++-- .../core/repository/support/package-info.java | 4 +- .../batch/core/scope/context/JobContext.java | 6 +- .../context/JobSynchronizationManager.java | 6 +- .../batch/core/scope/context/StepContext.java | 6 +- .../context/StepSynchronizationManager.java | 6 +- .../SynchronizationManagerSupport.java | 8 +-- .../core/scope/context/package-info.java | 5 +- .../batch/core/scope/package-info.java | 5 +- .../NoWorkFoundStepExecutionListener.java | 6 +- .../batch/core/step/StepExecution.java | 14 ++-- .../batch/core/step/builder/package-info.java | 5 +- .../batch/core/step/factory/package-info.java | 5 +- .../core/step/item/ChunkOrientedTasklet.java | 6 +- .../item/FaultTolerantChunkProcessor.java | 12 ++-- .../core/step/item/SimpleChunkProcessor.java | 2 +- .../core/step/item/SimpleChunkProvider.java | 11 ++- .../batch/core/step/item/package-info.java | 5 +- .../job/DefaultJobParametersExtractor.java | 3 +- .../batch/core/step/job/package-info.java | 5 +- .../batch/core/step/package-info.java | 5 +- .../batch/core/step/skip/package-info.java | 5 +- .../step/tasklet/CallableTaskletAdapter.java | 6 +- ...nfigurableSystemProcessExitCodeMapper.java | 4 +- .../tasklet/MethodInvokingTaskletAdapter.java | 6 +- .../step/tasklet/SystemCommandTasklet.java | 5 +- .../batch/core/step/tasklet/Tasklet.java | 6 +- .../batch/core/step/tasklet/TaskletStep.java | 2 +- .../batch/core/step/tasklet/package-info.java | 5 +- .../JobBuilderConfigurationTests.java | 11 +-- .../JobScopeConfigurationTests.java | 6 +- .../StepScopeConfigurationTests.java | 6 +- .../support/DefaultJobLoaderTests.java | 7 +- .../xml/DecisionJobParserTests.java | 2 +- .../xml/DefaultUnknownJobParserTests.java | 5 +- .../xml/DummyCompletionPolicy.java | 4 +- .../xml/DummyItemHandlerAdapter.java | 6 +- .../configuration/xml/DummyItemProcessor.java | 6 +- .../configuration/xml/DummyItemReader.java | 6 +- .../configuration/xml/DummyJobRepository.java | 16 ++--- .../xml/DummyPlatformTransactionManager.java | 4 +- .../core/configuration/xml/DummyTasklet.java | 6 +- .../configuration/xml/FailingTasklet.java | 6 +- .../xml/FlowStepParserTests.java | 2 +- .../xml/InterruptibleTasklet.java | 6 +- .../configuration/xml/NameStoringTasklet.java | 6 +- .../NextAttributeUnknownJobParserTests.java | 5 +- .../core/configuration/xml/NoopTasklet.java | 6 +- .../xml/PartitionStepWithFlowParserTests.java | 2 +- .../core/configuration/xml/StepNameTests.java | 5 +- .../configuration/xml/StopJobParserTests.java | 2 +- .../xml/TestCustomStatusListener.java | 6 +- .../configuration/xml/TestIncrementer.java | 5 +- .../core/configuration/xml/TestListener.java | 6 +- .../core/configuration/xml/TestProcessor.java | 6 +- .../core/configuration/xml/TestReader.java | 6 +- .../core/configuration/xml/TestTasklet.java | 6 +- .../JobParametersConverterSupport.java | 3 +- .../core/job/ExtendedAbstractJobTests.java | 4 +- .../core/job/builder/FlowJobBuilderTests.java | 2 +- .../flow/support/JobFlowExecutorSupport.java | 8 +-- .../support/CommandLineJobRunnerTests.java | 22 +++--- .../support/TaskExecutorJobOperatorTests.java | 10 +-- .../support/TestJobParametersIncrementer.java | 3 +- .../CompositeStepExecutionListenerTests.java | 14 ++-- .../core/listener/ItemListenerErrorTests.java | 8 +-- .../MulticasterBatchListenerTests.java | 13 ++-- .../StepListenerFactoryBeanTests.java | 8 +-- .../StepListenerMethodInterceptorTests.java | 9 +-- .../core/partition/ExampleItemReader.java | 6 +- .../dao/OptimisticLockingFailureTests.java | 6 +- .../core/repository/dao/TablePrefixTests.java | 6 +- .../JobRepositoryFactoryBeanTests.java | 4 +- .../batch/core/scope/TestJob.java | 8 +-- .../batch/core/step/JobRepositorySupport.java | 14 ++-- .../batch/core/step/NonAbstractStepTests.java | 5 +- .../core/step/RestartInPriorStepTests.java | 6 +- .../batch/core/step/RestartLoopTests.java | 6 +- .../step/StepLocatorStepFactoryBeanTests.java | 2 +- .../builder/RegisterMultiListenerTests.java | 8 +-- .../core/step/builder/StepBuilderTests.java | 5 +- .../core/step/item/ChunkMonitorTests.java | 14 ++-- .../item/ExceptionThrowingTaskletStub.java | 6 +- .../FaultTolerantChunkProcessorTests.java | 30 ++++---- ...aultTolerantStepFactoryBeanRetryTests.java | 45 ++++++------ .../FaultTolerantStepFactoryBeanTests.java | 14 ++-- .../step/item/SimpleChunkProcessorTests.java | 6 +- .../step/item/SimpleStepFactoryBeanTests.java | 5 +- .../core/step/item/SkipProcessorStub.java | 6 +- .../batch/core/step/item/SkipReaderStub.java | 6 +- .../step/item/TaskletStepExceptionTests.java | 72 +++++++++---------- .../step/skip/ReprocessExceptionTests.java | 5 +- .../StepExecutorInterruptionTests.java | 2 +- .../core/step/tasklet/TaskletStepTests.java | 53 +++++++------- .../ConcurrentTransactionTests.java | 20 +++--- .../football/internal/GameFieldSetMapper.java | 4 +- .../internal/PlayerFieldSetMapper.java | 4 +- .../batch/core/test/ldif/MyMapper.java | 6 +- .../MappingLdifReaderBuilderTests.java | 5 +- .../config/DummyNamespaceHandler.java | 5 +- ...lerantStepFactoryBeanIntegrationTests.java | 5 +- ...epFactoryBeanRollbackIntegrationTests.java | 5 +- .../FaultTolerantStepIntegrationTests.java | 5 +- .../test/timeout/SleepingItemProcessor.java | 6 +- .../core/test/timeout/SleepingTasklet.java | 6 +- .../database/AbstractCursorItemReader.java | 3 +- .../integration/async/AsyncItemProcessor.java | 6 +- .../batch/integration/async/package-info.java | 5 +- .../chunk/ChunkMessageChannelItemWriter.java | 6 +- .../integration/chunk/ChunkResponse.java | 3 +- .../batch/integration/chunk/package-info.java | 5 +- .../config/annotation/package-info.java | 5 +- .../xml/RemoteChunkingManagerParser.java | 4 +- .../integration/config/xml/package-info.java | 5 +- .../integration/launch/package-info.java | 5 +- .../batch/integration/package-info.java | 4 +- .../MessageChannelPartitionHandler.java | 2 +- .../integration/partition/package-info.java | 5 +- .../integration/JobRepositorySupport.java | 13 ++-- ...RemoteChunkingManagerStepBuilderTests.java | 5 +- .../integration/chunk/TestItemReader.java | 6 +- .../config/xml/RemoteChunkingParserTests.java | 5 +- .../MessagingGatewayIntegrationTests.java | 3 +- .../partition/ExampleItemReader.java | 6 +- ...tTransactionalPollingIntegrationTests.java | 3 +- ...tTransactionalPollingIntegrationTests.java | 3 +- ...yTransactionalPollingIntegrationTests.java | 3 +- .../integration/retry/SimpleRecoverer.java | 4 +- .../TransactionalPollingIntegrationTests.java | 3 +- .../batch/integration/step/TestTasklet.java | 6 +- .../batch/samples/amqp/MessageProcessor.java | 6 +- .../batch/samples/common/ErrorLogTasklet.java | 9 ++- .../samples/common/SkipCheckingDecider.java | 3 +- .../samples/common/SkipCheckingListener.java | 4 +- .../samples/common/StagingItemProcessor.java | 6 +- .../samples/common/StagingItemReader.java | 8 +-- .../samples/common/StagingItemWriter.java | 8 +-- .../samples/domain/person/PersonService.java | 4 +- .../CompositeCustomerUpdateLineTokenizer.java | 5 +- .../domain/trade/CustomerOperation.java | 4 +- .../trade/CustomerUpdateFieldSetMapper.java | 4 +- .../domain/trade/CustomerUpdateProcessor.java | 6 +- .../CustomerCreditIncreaseProcessor.java | 6 +- .../internal/GeneratingTradeItemReader.java | 6 +- .../trade/internal/JdbcCustomerDao.java | 4 +- .../domain/trade/internal/TradeProcessor.java | 6 +- .../multiline/MultiLineTradeItemReader.java | 6 +- .../AggregateItemReader.java | 6 +- .../internal/OrderItemReader.java | 6 +- .../patternmatching/internal/xml/Order.java | 4 +- .../football/internal/GameFieldSetMapper.java | 4 +- .../internal/PlayerFieldSetMapper.java | 4 +- .../samples/launch/DefaultJobLoader.java | 4 +- .../GeneratingTradeResettingListener.java | 6 +- .../batch/samples/loop/LimitDecider.java | 3 +- .../samples/mail/UserMailItemProcessor.java | 6 +- .../samples/misc/jmx/InfiniteLoopReader.java | 6 +- .../ExceptionThrowingItemReaderProxy.java | 6 +- .../batch/test/ExecutionContextTestUtils.java | 12 ++-- .../batch/test/JobLauncherTestUtils.java | 2 +- .../batch/test/JobRepositoryTestUtils.java | 3 +- .../test/JobScopeTestExecutionListener.java | 4 +- .../batch/test/StepRunner.java | 3 +- .../test/StepScopeTestExecutionListener.java | 10 +-- .../BatchTestContextCustomizerFactory.java | 3 +- .../batch/test/context/package-info.java | 5 +- .../batch/test/package-info.java | 5 +- .../batch/test/JobLauncherTestUtilsTests.java | 7 +- ...copeAnnotatedListenerIntegrationTests.java | 8 +-- .../batch/test/sample/LoggingTasklet.java | 6 +- .../batch/test/sample/SampleTasklet.java | 6 +- 251 files changed, 888 insertions(+), 861 deletions(-) diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/SpringBatchVersion.java b/spring-batch-core/src/main/java/org/springframework/batch/core/SpringBatchVersion.java index 57493f3eef..0b4c40bfd0 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/SpringBatchVersion.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/SpringBatchVersion.java @@ -15,7 +15,7 @@ */ package org.springframework.batch.core; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Class that exposes the Spring Batch version. Fetches the "Implementation-Version" @@ -43,8 +43,7 @@ private SpringBatchVersion() { * {@code "N/A"} if it cannot be determined. * @see Package#getImplementationVersion() */ - @Nullable - public static String getVersion() { + public static @Nullable String getVersion() { Package pkg = SpringBatchVersion.class.getPackage(); if (pkg != null && pkg.getImplementationVersion() != null) { return pkg.getImplementationVersion(); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/JobLocator.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/JobLocator.java index 202026cb92..7dcbff8309 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/JobLocator.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/JobLocator.java @@ -15,9 +15,10 @@ */ package org.springframework.batch.core.configuration; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.Job; import org.springframework.batch.core.launch.NoSuchJobException; -import org.springframework.lang.Nullable; /** * A runtime service locator interface for retrieving job configurations by diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/package-info.java index 6b876be28c..5c6ba0004d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.configuration.annotation; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/package-info.java index 95c8411bae..e5d9b41039 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.configuration; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java index aa14354826..d34e7b9d7d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java @@ -23,6 +23,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.Job; import org.springframework.batch.core.step.Step; @@ -34,7 +35,6 @@ import org.springframework.beans.factory.InitializingBean; import org.springframework.context.ApplicationContext; import org.springframework.context.ConfigurableApplicationContext; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -222,9 +222,9 @@ private Collection doLoad(ApplicationContextFactory factory, boolean unregi * @return all the {@link Step} defined by the given step locator and context * @see StepLocator */ - private Collection getSteps(final StepLocator stepLocator, final ApplicationContext jobApplicationContext) { - final Collection stepNames = stepLocator.getStepNames(); - final Collection result = new ArrayList<>(); + private Collection getSteps(StepLocator stepLocator, ApplicationContext jobApplicationContext) { + Collection stepNames = stepLocator.getStepNames(); + Collection result = new ArrayList<>(); for (String stepName : stepNames) { result.add(stepLocator.getStep(stepName)); } @@ -234,7 +234,7 @@ private Collection getSteps(final StepLocator stepLocator, final Applicati // are more Step instances defined. Right now they are registered as being // available in the // context of the job but we have no idea if they are linked to that Job or not. - final Map allSteps = jobApplicationContext.getBeansOfType(Step.class); + Map allSteps = jobApplicationContext.getBeansOfType(Step.class); for (Map.Entry entry : allSteps.entrySet()) { if (!stepNames.contains(entry.getKey())) { result.add(entry.getValue()); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GroupAwareJob.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GroupAwareJob.java index b0cbce6657..0899b113c8 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GroupAwareJob.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GroupAwareJob.java @@ -15,11 +15,12 @@ */ package org.springframework.batch.core.configuration.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.Job; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.parameters.JobParametersIncrementer; import org.springframework.batch.core.job.parameters.JobParametersValidator; -import org.springframework.lang.Nullable; import org.springframework.util.ClassUtils; /** @@ -87,8 +88,7 @@ public boolean isRestartable() { } @Override - @Nullable - public JobParametersIncrementer getJobParametersIncrementer() { + public @Nullable JobParametersIncrementer getJobParametersIncrementer() { return delegate.getJobParametersIncrementer(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java index 9058740855..a1159adac7 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java @@ -23,6 +23,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.Job; import org.springframework.batch.core.configuration.DuplicateJobException; import org.springframework.batch.core.configuration.JobRegistry; @@ -31,7 +33,6 @@ import org.springframework.beans.factory.SmartInitializingSingleton; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapStepRegistry.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapStepRegistry.java index 051a44edd0..cdb60e5094 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapStepRegistry.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapStepRegistry.java @@ -22,6 +22,8 @@ import java.util.concurrent.ConcurrentMap; import org.springframework.batch.core.step.Step; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.configuration.DuplicateJobException; import org.springframework.batch.core.configuration.StepRegistry; import org.springframework.batch.core.launch.NoSuchJobException; @@ -62,7 +64,7 @@ public void unregisterStepsFromJob(String jobName) { } @Override - public Step getStep(String jobName, String stepName) throws NoSuchJobException { + public @Nullable Step getStep(String jobName, String stepName) throws NoSuchJobException { Assert.notNull(jobName, "The job name cannot be null."); Assert.notNull(stepName, "The step name cannot be null."); if (!map.containsKey(jobName)) { diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/package-info.java index ba3ed75998..1656999517 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.configuration.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ExceptionElementParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ExceptionElementParser.java index de8aff9119..3f4c5bb81f 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ExceptionElementParser.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ExceptionElementParser.java @@ -22,11 +22,13 @@ import org.springframework.beans.factory.support.ManagedMap; import org.springframework.beans.factory.xml.ParserContext; import org.springframework.util.xml.DomUtils; + +import org.jspecify.annotations.Nullable; import org.w3c.dom.Element; public class ExceptionElementParser { - public ManagedMap parse(Element element, ParserContext parserContext, + public @Nullable ManagedMap parse(Element element, ParserContext parserContext, String exceptionListName) { List children = DomUtils.getChildElementsByTagName(element, exceptionListName); if (children.size() == 1) { diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobParser.java index 9931c03172..e72068c353 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobParser.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobParser.java @@ -30,6 +30,8 @@ import org.springframework.beans.factory.xml.ParserContext; import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; + +import org.jspecify.annotations.Nullable; import org.w3c.dom.Element; /** @@ -158,7 +160,7 @@ else if (listenersElements.size() > 1) { * @param parserContext The {@link ParserContext}. * @return the {@link BeanMetadataElement} extracted from the element parameter. */ - public BeanMetadataElement parseBeanElement(Element element, ParserContext parserContext) { + public @Nullable BeanMetadataElement parseBeanElement(Element element, ParserContext parserContext) { String refAttribute = element.getAttribute(REF_ATTR); Element beanElement = DomUtils.getChildElementByTagName(element, BEAN_ELE); Element refElement = DomUtils.getChildElementByTagName(element, REF_ELE); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/package-info.java index 06d7e96347..87b7d7dcd2 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.configuration.xml; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/converter/DefaultJobParametersConverter.java b/spring-batch-core/src/main/java/org/springframework/batch/core/converter/DefaultJobParametersConverter.java index 454c691872..e148e2e75f 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/converter/DefaultJobParametersConverter.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/converter/DefaultJobParametersConverter.java @@ -20,12 +20,12 @@ import java.util.Properties; import org.springframework.batch.core.job.parameters.JobParameter; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.job.parameters.JobParametersBuilder; import org.springframework.core.convert.support.ConfigurableConversionService; import org.springframework.core.convert.support.DefaultConversionService; -import org.springframework.lang.NonNull; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.StringUtils; @@ -130,7 +130,7 @@ public Properties getProperties(@Nullable JobParameters jobParameters) { * @param conversionService the conversion service to use. Must not be {@code null}. * @since 5.0 */ - public void setConversionService(@NonNull ConfigurableConversionService conversionService) { + public void setConversionService(ConfigurableConversionService conversionService) { Assert.notNull(conversionService, "The conversionService must not be null"); this.conversionService = conversionService; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/converter/JobParametersConverter.java b/spring-batch-core/src/main/java/org/springframework/batch/core/converter/JobParametersConverter.java index 128938f48f..2b90ae5277 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/converter/JobParametersConverter.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/converter/JobParametersConverter.java @@ -21,6 +21,10 @@ import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.job.parameters.JobParametersBuilder; import org.springframework.lang.Nullable; +import org.springframework.batch.core.JobParameters; + +import org.jspecify.annotations.Nullable; +import org.springframework.batch.core.JobParametersBuilder; /** * A factory for {@link JobParameters} instances. A job can be executed with many possible diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/converter/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/converter/package-info.java index 8948cd2218..dff24fa489 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/converter/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/converter/package-info.java @@ -5,7 +5,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.converter; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/AbstractJob.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/AbstractJob.java index 9ca23315f4..7a59c8a741 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/AbstractJob.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/AbstractJob.java @@ -29,6 +29,7 @@ import io.micrometer.observation.ObservationRegistry; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.ExitStatus; @@ -55,7 +56,6 @@ import org.springframework.batch.repeat.RepeatException; import org.springframework.beans.factory.BeanNameAware; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; @@ -207,8 +207,7 @@ public void setJobParametersIncrementer(JobParametersIncrementer jobParametersIn } @Override - @Nullable - public JobParametersIncrementer getJobParametersIncrementer() { + public @Nullable JobParametersIncrementer getJobParametersIncrementer() { return this.jobParametersIncrementer; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/Job.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/Job.java index 22c91a5651..58f468c98a 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/Job.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/Job.java @@ -19,6 +19,9 @@ import org.springframework.batch.core.job.parameters.JobParametersIncrementer; import org.springframework.batch.core.job.parameters.JobParametersValidator; import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; + +import org.springframework.batch.core.job.DefaultJobParametersValidator; /** * Batch domain object representing a job. {@code Job} is an explicit abstraction @@ -66,8 +69,7 @@ default boolean isRestartable() { * @return an incrementer to be used for creating new parameters. Defaults to * {@code null}. */ - @Nullable - default JobParametersIncrementer getJobParametersIncrementer() { + default @Nullable JobParametersIncrementer getJobParametersIncrementer() { return null; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/JobExecution.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/JobExecution.java index bfccba5e4b..3662f6903d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/JobExecution.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/JobExecution.java @@ -32,7 +32,8 @@ import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; /** * Batch domain object representing the execution of a job. @@ -141,8 +142,7 @@ public JobParameters getJobParameters() { /** * @return The current end time. */ - @Nullable - public LocalDateTime getEndTime() { + public @Nullable LocalDateTime getEndTime() { return endTime; } @@ -165,8 +165,7 @@ public void setEndTime(LocalDateTime endTime) { /** * @return The current start time. */ - @Nullable - public LocalDateTime getStartTime() { + public @Nullable LocalDateTime getStartTime() { return startTime; } @@ -208,7 +207,7 @@ public void upgradeStatus(BatchStatus status) { * implementations. * @return the {@code id} of the enclosing job. */ - public Long getJobId() { + public @Nullable Long getJobId() { if (jobInstance != null) { return jobInstance.getId(); } @@ -318,8 +317,7 @@ public void addStepExecution(StepExecution stepExecution) { * @return a {@link LocalDateTime} object representing the last time this * {@code JobExecution} was updated. */ - @Nullable - public LocalDateTime getLastUpdated() { + public @Nullable LocalDateTime getLastUpdated() { return lastUpdated; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/SimpleJob.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/SimpleJob.java index d2d2db1825..19e5175fec 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/SimpleJob.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/SimpleJob.java @@ -21,6 +21,8 @@ import java.util.List; import org.springframework.batch.core.BatchStatus; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.Step; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.repository.JobRestartException; @@ -91,7 +93,7 @@ public void addStep(Step step) { } @Override - public Step getStep(String stepName) { + public @Nullable Step getStep(String stepName) { for (Step step : this.steps) { if (step.getName().equals(stepName)) { return step; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/package-info.java index 8ebd881b89..83a03e74f9 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.job.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecutor.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecutor.java index 9b916d749a..126b986084 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecutor.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecutor.java @@ -15,13 +15,14 @@ */ package org.springframework.batch.core.job.flow; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.JobInterruptedException; import org.springframework.batch.core.job.StartLimitExceededException; import org.springframework.batch.core.step.Step; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.repository.JobRestartException; -import org.springframework.lang.Nullable; /** * Context and execution strategy for {@link FlowJob} to allow it to delegate its @@ -50,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 diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowJob.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowJob.java index 65e3604e85..c887df0a67 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowJob.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowJob.java @@ -20,6 +20,8 @@ import java.util.concurrent.ConcurrentHashMap; import org.springframework.batch.core.job.Job; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.JobExecutionException; import org.springframework.batch.core.step.Step; @@ -73,7 +75,7 @@ public void setFlow(Flow flow) { * {@inheritDoc} */ @Override - public Step getStep(String stepName) { + public @Nullable Step getStep(String stepName) { if (!initialized) { init(); } @@ -125,7 +127,7 @@ public Collection 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); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobExecutionDecider.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobExecutionDecider.java index 34db827b1d..bf66fccff1 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobExecutionDecider.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobExecutionDecider.java @@ -15,9 +15,10 @@ */ package org.springframework.batch.core.job.flow; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.step.StepExecution; -import org.springframework.lang.Nullable; /** * Interface allowing for programmatic access to the decision on what the status of a flow diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobFlowExecutor.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobFlowExecutor.java index e72278f638..eac74cd255 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobFlowExecutor.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobFlowExecutor.java @@ -16,6 +16,8 @@ package org.springframework.batch.core.job.flow; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.JobExecution; @@ -26,7 +28,6 @@ import org.springframework.batch.core.job.StepHandler; import org.springframework.batch.core.repository.JobRepository; import org.springframework.batch.core.repository.JobRestartException; -import org.springframework.lang.Nullable; /** * Implementation of {@link FlowExecutor} for use in components that need to execute a @@ -111,8 +112,7 @@ public JobExecution getJobExecution() { } @Override - @Nullable - public StepExecution getStepExecution() { + public @Nullable StepExecution getStepExecution() { return stepExecutionHolder.get(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/package-info.java index f64efbb060..46bcf73b01 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.job.flow; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/SimpleFlow.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/SimpleFlow.java index e90f7db82a..434807d73f 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/SimpleFlow.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/SimpleFlow.java @@ -28,6 +28,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.Step; import org.springframework.batch.core.step.StepExecution; @@ -106,7 +107,7 @@ public void setStateTransitions(List stateTransitions) { * {@inheritDoc} */ @Override - public State getState(String stateName) { + public @Nullable State getState(String stateName) { return stateMap.get(stateName); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/StateTransition.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/StateTransition.java index 6757f9cc69..bdc82933d7 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/StateTransition.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/StateTransition.java @@ -18,12 +18,13 @@ import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.flow.State; import org.springframework.batch.support.PatternMatcher; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.StringUtils; import java.util.Objects; +import org.jspecify.annotations.Nullable; + /** * Value object representing a potential transition from one {@link State} to another. The * originating State name and the next {@link State} to execute are linked by a pattern diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/package-info.java index 3764d3be60..3a5866e98f 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.job.flow.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/SplitState.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/SplitState.java index 8bedef1114..a90a93930b 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/SplitState.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/SplitState.java @@ -25,6 +25,8 @@ import java.util.concurrent.FutureTask; import org.springframework.batch.core.job.flow.Flow; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.flow.FlowExecution; import org.springframework.batch.core.job.flow.FlowExecutionException; import org.springframework.batch.core.job.flow.FlowExecutionStatus; @@ -34,7 +36,6 @@ import org.springframework.core.task.SyncTaskExecutor; import org.springframework.core.task.TaskExecutor; import org.springframework.core.task.TaskRejectedException; -import org.springframework.lang.Nullable; /** * A {@link State} implementation that splits a {@link Flow} into multiple parallel @@ -96,13 +97,13 @@ public Collection 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> tasks = new ArrayList<>(); - for (final Flow flow : flows) { + for (Flow flow : flows) { final FutureTask task = new FutureTask<>(() -> flow.start(executor)); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/package-info.java index 4277ac4e97..8bd7ef37dc 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.job.flow.support.state; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/package-info.java index a96f7e8954..150720aedf 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.job; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/CompositeJobParametersValidator.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/CompositeJobParametersValidator.java index 743afa4d85..918996f819 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/CompositeJobParametersValidator.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/CompositeJobParametersValidator.java @@ -17,8 +17,12 @@ import java.util.List; +import org.springframework.batch.core.JobParameters; + +import org.jspecify.annotations.Nullable; +import org.springframework.batch.core.JobParametersInvalidException; +import org.springframework.batch.core.JobParametersValidator; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/DefaultJobParametersValidator.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/DefaultJobParametersValidator.java index 836cc74803..3ec33f12e4 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/DefaultJobParametersValidator.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/DefaultJobParametersValidator.java @@ -22,9 +22,9 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParameter.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParameter.java index 7c02f48b5c..8b3048a1fa 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParameter.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParameter.java @@ -18,7 +18,6 @@ import java.io.Serializable; -import org.springframework.lang.NonNull; import org.springframework.util.Assert; /** @@ -48,7 +47,7 @@ public class JobParameter implements Serializable { * @param type the type of the parameter. Must not be {@code null}. * @param identifying true if the parameter is identifying. false otherwise. */ - public JobParameter(@NonNull T value, @NonNull Class type, boolean identifying) { + public JobParameter(T value, Class type, boolean identifying) { Assert.notNull(value, "value must not be null"); Assert.notNull(type, "type must not be null"); this.value = value; @@ -61,7 +60,7 @@ public JobParameter(@NonNull T value, @NonNull Class type, boolean identifyin * @param value the value of the parameter. Must not be {@code null}. * @param type the type of the parameter. Must not be {@code null}. */ - public JobParameter(@NonNull T value, @NonNull Class type) { + public JobParameter(T value, Class type) { this(value, type, true); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParameters.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParameters.java index b4de56936f..7c4fe66d2c 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParameters.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParameters.java @@ -27,9 +27,10 @@ import java.util.List; import java.util.Map; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; +import org.jspecify.annotations.Nullable; + /** * Value object representing runtime parameters to a batch job. Because the parameters * have no individual meaning outside of the {@code JobParameters} object they are @@ -73,8 +74,7 @@ public JobParameters(Map> parameters) { * @param key The key for which to get a value. * @return The {@link Long} value or {@code null} if the key is absent. */ - @Nullable - public Long getLong(String key) { + public @Nullable Long getLong(String key) { if (!parameters.containsKey(key)) { return null; } @@ -93,8 +93,7 @@ public Long getLong(String key) { * @return the parameter represented by the provided key or, if that is missing, the * default value. */ - @Nullable - public Long getLong(String key, @Nullable Long defaultValue) { + public @Nullable Long getLong(String key, @Nullable Long defaultValue) { if (parameters.containsKey(key)) { return getLong(key); } @@ -108,8 +107,7 @@ public Long getLong(String key, @Nullable Long defaultValue) { * @param key The key for which to get a value. * @return The {@link String} value or {@code null} if the key is absent. */ - @Nullable - public String getString(String key) { + public @Nullable String getString(String key) { if (!parameters.containsKey(key)) { return null; } @@ -128,8 +126,7 @@ public String getString(String key) { * @return the parameter represented by the provided key or, if that is missing, the * default value. */ - @Nullable - public String getString(String key, @Nullable String defaultValue) { + public @Nullable String getString(String key, @Nullable String defaultValue) { if (parameters.containsKey(key)) { return getString(key); } @@ -143,8 +140,7 @@ public String getString(String key, @Nullable String defaultValue) { * @param key The key for which to get a value. * @return The {@link Double} value or {@code null} if the key is absent. */ - @Nullable - public Double getDouble(String key) { + public @Nullable Double getDouble(String key) { if (!parameters.containsKey(key)) { return null; } @@ -163,8 +159,7 @@ public Double getDouble(String key) { * @return the parameter represented by the provided key or, if that is missing, the * default value. */ - @Nullable - public Double getDouble(String key, @Nullable Double defaultValue) { + public @Nullable Double getDouble(String key, @Nullable Double defaultValue) { if (parameters.containsKey(key)) { return getDouble(key); } @@ -178,8 +173,7 @@ public Double getDouble(String key, @Nullable Double defaultValue) { * @param key The key for which to get a value. * @return the {@link java.util.Date} value or {@code null} if the key is absent. */ - @Nullable - public Date getDate(String key) { + public @Nullable Date getDate(String key) { if (!parameters.containsKey(key)) { return null; } @@ -198,8 +192,7 @@ public Date getDate(String key) { * @return the parameter represented by the provided key or, if that is missing, the * default value. */ - @Nullable - public Date getDate(String key, @Nullable Date defaultValue) { + public @Nullable Date getDate(String key, @Nullable Date defaultValue) { if (parameters.containsKey(key)) { return getDate(key); } @@ -213,8 +206,7 @@ public Date getDate(String key, @Nullable Date defaultValue) { * @param key The key for which to get a value. * @return the {@link LocalDate} value or {@code null} if the key is absent. */ - @Nullable - public LocalDate getLocalDate(String key) { + public @Nullable LocalDate getLocalDate(String key) { if (!parameters.containsKey(key)) { return null; } @@ -233,8 +225,7 @@ public LocalDate getLocalDate(String key) { * @return the parameter represented by the provided key or, if that is missing, the * default value. */ - @Nullable - public LocalDate getLocalDate(String key, @Nullable LocalDate defaultValue) { + public @Nullable LocalDate getLocalDate(String key, @Nullable LocalDate defaultValue) { if (parameters.containsKey(key)) { return getLocalDate(key); } @@ -248,8 +239,7 @@ public LocalDate getLocalDate(String key, @Nullable LocalDate defaultValue) { * @param key The key for which to get a value. * @return the {@link LocalTime} value or {@code null} if the key is absent. */ - @Nullable - public LocalTime getLocalTime(String key) { + public @Nullable LocalTime getLocalTime(String key) { if (!parameters.containsKey(key)) { return null; } @@ -268,8 +258,7 @@ public LocalTime getLocalTime(String key) { * @return the parameter represented by the provided key or, if that is missing, the * default value. */ - @Nullable - public LocalTime getLocalTime(String key, @Nullable LocalTime defaultValue) { + public @Nullable LocalTime getLocalTime(String key, @Nullable LocalTime defaultValue) { if (parameters.containsKey(key)) { return getLocalTime(key); } @@ -283,8 +272,7 @@ public LocalTime getLocalTime(String key, @Nullable LocalTime defaultValue) { * @param key The key for which to get a value. * @return the {@link LocalDateTime} value or {@code null} if the key is absent. */ - @Nullable - public LocalDateTime getLocalDateTime(String key) { + public @Nullable LocalDateTime getLocalDateTime(String key) { if (!parameters.containsKey(key)) { return null; } @@ -303,8 +291,7 @@ public LocalDateTime getLocalDateTime(String key) { * @return the parameter represented by the provided key or, if that is missing, the * default value. */ - @Nullable - public LocalDateTime getLocalDateTime(String key, @Nullable LocalDateTime defaultValue) { + public @Nullable LocalDateTime getLocalDateTime(String key, @Nullable LocalDateTime defaultValue) { if (parameters.containsKey(key)) { return getLocalDateTime(key); } @@ -313,8 +300,7 @@ public LocalDateTime getLocalDateTime(String key, @Nullable LocalDateTime defaul } } - @Nullable - public JobParameter getParameter(String key) { + public @Nullable JobParameter getParameter(String key) { Assert.notNull(key, "key must not be null"); return parameters.get(key); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersBuilder.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersBuilder.java index 7bebeedcd9..182e9a9a05 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersBuilder.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersBuilder.java @@ -24,7 +24,6 @@ import java.util.Map; import org.springframework.batch.core.job.JobInstance; -import org.springframework.lang.NonNull; import org.springframework.util.Assert; /** @@ -70,7 +69,7 @@ public JobParametersBuilder(JobParameters jobParameters) { * @param parameter The runtime parameter. Must not be {@code null}. * @return a reference to this object. */ - public JobParametersBuilder addString(String key, @NonNull String parameter) { + public JobParametersBuilder addString(String key, String parameter) { return addString(key, parameter, true); } @@ -82,7 +81,7 @@ public JobParametersBuilder addString(String key, @NonNull String parameter) { * job instance. * @return a reference to this object. */ - public JobParametersBuilder addString(String key, @NonNull String parameter, boolean identifying) { + public JobParametersBuilder addString(String key, String parameter, boolean identifying) { Assert.notNull(parameter, "Value for parameter '" + key + "' must not be null"); this.parameterMap.put(key, new JobParameter<>(parameter, String.class, identifying)); return this; @@ -94,7 +93,7 @@ public JobParametersBuilder addString(String key, @NonNull String parameter, boo * @param parameter The runtime parameter. Must not be {@code null}. * @return a reference to this object. */ - public JobParametersBuilder addDate(String key, @NonNull Date parameter) { + public JobParametersBuilder addDate(String key, Date parameter) { return addDate(key, parameter, true); } @@ -106,7 +105,7 @@ public JobParametersBuilder addDate(String key, @NonNull Date parameter) { * instance * @return a reference to this object. */ - public JobParametersBuilder addDate(String key, @NonNull Date parameter, boolean identifying) { + public JobParametersBuilder addDate(String key, Date parameter, boolean identifying) { Assert.notNull(parameter, "Value for parameter '" + key + "' must not be null"); this.parameterMap.put(key, new JobParameter<>(parameter, Date.class, identifying)); return this; @@ -118,7 +117,7 @@ public JobParametersBuilder addDate(String key, @NonNull Date parameter, boolean * @param parameter The runtime parameter. Must not be {@code null}. * @return a reference to this object. */ - public JobParametersBuilder addLocalDate(String key, @NonNull LocalDate parameter) { + public JobParametersBuilder addLocalDate(String key, LocalDate parameter) { return addLocalDate(key, parameter, true); } @@ -130,7 +129,7 @@ public JobParametersBuilder addLocalDate(String key, @NonNull LocalDate paramete * instance * @return a reference to this object. */ - public JobParametersBuilder addLocalDate(String key, @NonNull LocalDate parameter, boolean identifying) { + public JobParametersBuilder addLocalDate(String key, LocalDate parameter, boolean identifying) { Assert.notNull(parameter, "Value for parameter '" + key + "' must not be null"); this.parameterMap.put(key, new JobParameter<>(parameter, LocalDate.class, identifying)); return this; @@ -142,7 +141,7 @@ public JobParametersBuilder addLocalDate(String key, @NonNull LocalDate paramete * @param parameter The runtime parameter. Must not be {@code null}. * @return a reference to this object. */ - public JobParametersBuilder addLocalTime(String key, @NonNull LocalTime parameter) { + public JobParametersBuilder addLocalTime(String key, LocalTime parameter) { return addLocalTime(key, parameter, true); } @@ -154,7 +153,7 @@ public JobParametersBuilder addLocalTime(String key, @NonNull LocalTime paramete * instance * @return a reference to this object. */ - public JobParametersBuilder addLocalTime(String key, @NonNull LocalTime parameter, boolean identifying) { + public JobParametersBuilder addLocalTime(String key, LocalTime parameter, boolean identifying) { Assert.notNull(parameter, "Value for parameter '" + key + "' must not be null"); this.parameterMap.put(key, new JobParameter<>(parameter, LocalTime.class, identifying)); return this; @@ -166,7 +165,7 @@ public JobParametersBuilder addLocalTime(String key, @NonNull LocalTime paramete * @param parameter The runtime parameter. Must not be {@code null}. * @return a reference to this object. */ - public JobParametersBuilder addLocalDateTime(String key, @NonNull LocalDateTime parameter) { + public JobParametersBuilder addLocalDateTime(String key, LocalDateTime parameter) { return addLocalDateTime(key, parameter, true); } @@ -178,7 +177,7 @@ public JobParametersBuilder addLocalDateTime(String key, @NonNull LocalDateTime * instance * @return a reference to this object. */ - public JobParametersBuilder addLocalDateTime(String key, @NonNull LocalDateTime parameter, boolean identifying) { + public JobParametersBuilder addLocalDateTime(String key, LocalDateTime parameter, boolean identifying) { Assert.notNull(parameter, "Value for parameter '" + key + "' must not be null"); this.parameterMap.put(key, new JobParameter<>(parameter, LocalDateTime.class, identifying)); return this; @@ -190,7 +189,7 @@ public JobParametersBuilder addLocalDateTime(String key, @NonNull LocalDateTime * @param parameter The runtime parameter. Must not be {@code null}. * @return a reference to this object. */ - public JobParametersBuilder addLong(String key, @NonNull Long parameter) { + public JobParametersBuilder addLong(String key, Long parameter) { return addLong(key, parameter, true); } @@ -202,7 +201,7 @@ public JobParametersBuilder addLong(String key, @NonNull Long parameter) { * instance. * @return a reference to this object. */ - public JobParametersBuilder addLong(String key, @NonNull Long parameter, boolean identifying) { + public JobParametersBuilder addLong(String key, Long parameter, boolean identifying) { Assert.notNull(parameter, "Value for parameter '" + key + "' must not be null"); this.parameterMap.put(key, new JobParameter<>(parameter, Long.class, identifying)); return this; @@ -214,7 +213,7 @@ public JobParametersBuilder addLong(String key, @NonNull Long parameter, boolean * @param parameter The runtime parameter. Must not be {@code null}. * @return a reference to this object. */ - public JobParametersBuilder addDouble(String key, @NonNull Double parameter) { + public JobParametersBuilder addDouble(String key, Double parameter) { return addDouble(key, parameter, true); } @@ -226,7 +225,7 @@ public JobParametersBuilder addDouble(String key, @NonNull Double parameter) { * instance. * @return a reference to this object. */ - public JobParametersBuilder addDouble(String key, @NonNull Double parameter, boolean identifying) { + public JobParametersBuilder addDouble(String key, Double parameter, boolean identifying) { Assert.notNull(parameter, "Value for parameter '" + key + "' must not be null"); this.parameterMap.put(key, new JobParameter<>(parameter, Double.class, identifying)); return this; @@ -263,7 +262,7 @@ public JobParametersBuilder addJobParameter(String key, JobParameter jobParam * @param the type of the parameter * @since 5.0 */ - public JobParametersBuilder addJobParameter(String name, @NonNull T value, Class type, boolean identifying) { + public JobParametersBuilder addJobParameter(String name, T value, Class type, boolean identifying) { Assert.notNull(value, "Value for parameter '" + name + "' must not be null"); return addJobParameter(name, new JobParameter<>(value, type, identifying)); } @@ -277,7 +276,7 @@ public JobParametersBuilder addJobParameter(String name, @NonNull T value, C * @param the type of the parameter * @since 5.0 */ - public JobParametersBuilder addJobParameter(String name, @NonNull T value, Class type) { + public JobParametersBuilder addJobParameter(String name, T value, Class type) { return addJobParameter(name, value, type, true); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersIncrementer.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersIncrementer.java index 61caebe6a2..940874adf9 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersIncrementer.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersIncrementer.java @@ -15,7 +15,7 @@ */ package org.springframework.batch.core.job.parameters; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Interface for obtaining the next {@link JobParameters} object in a sequence. diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersValidator.java b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersValidator.java index c794e2b385..1336cf1339 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersValidator.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersValidator.java @@ -16,7 +16,7 @@ package org.springframework.batch.core.job.parameters; import org.springframework.batch.core.job.Job; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Strategy interface for a {@link Job} to use in validating its parameters for an 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 a50d0dda95..405447cc53 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 @@ -21,6 +21,8 @@ import java.util.Set; import org.springframework.batch.core.job.Job; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.parameters.JobParameters; @@ -32,7 +34,6 @@ import org.springframework.batch.core.repository.JobExecutionAlreadyRunningException; import org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException; import org.springframework.batch.core.repository.JobRestartException; -import org.springframework.lang.Nullable; /** * High level interface for operating batch jobs. @@ -302,8 +303,7 @@ JobExecution startNextInstance(Job job) throws JobRestartException, JobExecution * Scheduled for removal in 6.2 or later. */ @Deprecated(since = "6.0", forRemoval = true) - @Nullable - default JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + default @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { throw new UnsupportedOperationException(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/package-info.java index 0b629cc889..124e19b6ab 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.launch; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/DataFieldMaxValueJobParametersIncrementer.java b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/DataFieldMaxValueJobParametersIncrementer.java index 759aa4400e..7fffb10408 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/DataFieldMaxValueJobParametersIncrementer.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/DataFieldMaxValueJobParametersIncrementer.java @@ -15,11 +15,12 @@ */ package org.springframework.batch.core.launch.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.job.parameters.JobParametersBuilder; import org.springframework.batch.core.job.parameters.JobParametersIncrementer; import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/RunIdIncrementer.java b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/RunIdIncrementer.java index ee2fac0417..b1824b2428 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/RunIdIncrementer.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/RunIdIncrementer.java @@ -15,11 +15,12 @@ */ package org.springframework.batch.core.launch.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.parameters.JobParameter; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.job.parameters.JobParametersBuilder; import org.springframework.batch.core.job.parameters.JobParametersIncrementer; -import org.springframework.lang.Nullable; /** * This incrementer increments a "run.id" parameter of type {@link Long} from the given diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/SimpleJobOperator.java b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/SimpleJobOperator.java index db0c1a351a..d658f0ca16 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/SimpleJobOperator.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/SimpleJobOperator.java @@ -27,6 +27,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.job.Job; @@ -60,7 +61,6 @@ import org.springframework.batch.core.step.tasklet.TaskletStep; import org.springframework.batch.support.PropertiesConverter; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -479,9 +479,8 @@ public List getJobInstances(String jobName, int start, int count) throws N } @Override - @Nullable @Deprecated(since = "6.0", forRemoval = true) - public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { return this.jobRepository.getJobInstance(jobName, jobParameters); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/TaskExecutorJobLauncher.java b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/TaskExecutorJobLauncher.java index 0448c533bf..d7cd1441a7 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/TaskExecutorJobLauncher.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/TaskExecutorJobLauncher.java @@ -99,9 +99,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."); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/package-info.java index 8a468e015a..4968a2f240 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.launch.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeItemProcessListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeItemProcessListener.java index 19c966a503..935ef36013 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeItemProcessListener.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeItemProcessListener.java @@ -19,7 +19,8 @@ import java.util.List; import org.springframework.core.Ordered; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; /** * @author Dave Syer diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeStepExecutionListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeStepExecutionListener.java index b3421897ae..d115a4e898 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeStepExecutionListener.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeStepExecutionListener.java @@ -19,9 +19,10 @@ import java.util.Iterator; import org.springframework.batch.core.ExitStatus; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.StepExecution; import org.springframework.core.Ordered; -import org.springframework.lang.Nullable; /** * @author Lucas Ward @@ -56,9 +57,8 @@ public void register(StepExecutionListener stepExecutionListener) { * that implement {@link Ordered}. * @see StepExecutionListener#afterStep(StepExecution) */ - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { for (Iterator iterator = list.reverse(); iterator.hasNext();) { StepExecutionListener listener = iterator.next(); ExitStatus close = listener.afterStep(stepExecution); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/ExecutionContextPromotionListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/ExecutionContextPromotionListener.java index 262cda639a..efd7a3fac2 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/ExecutionContextPromotionListener.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/ExecutionContextPromotionListener.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.core.listener; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.Job; import org.springframework.batch.core.step.Step; @@ -22,7 +24,6 @@ import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.support.PatternMatcher; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ObjectUtils; @@ -49,9 +50,8 @@ public class ExecutionContextPromotionListener implements StepExecutionListener, private boolean strict = false; - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { ExecutionContext stepContext = stepExecution.getExecutionContext(); ExecutionContext jobContext = stepExecution.getJobExecution().getExecutionContext(); String exitCode = stepExecution.getExitStatus().getExitCode(); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/ItemProcessListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/ItemProcessListener.java index fb3d394fcc..84694ca70d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/ItemProcessListener.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/ItemProcessListener.java @@ -15,8 +15,9 @@ */ package org.springframework.batch.core.listener; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; /** * Listener interface for the processing of an item. Implementations of this interface are diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/JobListenerMetaData.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/JobListenerMetaData.java index a268ebcc3d..2433d8f03d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/JobListenerMetaData.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/JobListenerMetaData.java @@ -20,9 +20,10 @@ import java.util.Map; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.annotation.AfterJob; import org.springframework.batch.core.annotation.BeforeJob; -import org.springframework.lang.Nullable; /** * Enumeration for {@link JobExecutionListener} meta data, which ties together the names @@ -89,8 +90,7 @@ public Class[] getParamTypes() { * @param propertyName name of the property to retrieve. * @return meta data with supplied property name, {@code null} if none exists. */ - @Nullable - public static JobListenerMetaData fromPropertyName(String propertyName) { + public static @Nullable JobListenerMetaData fromPropertyName(String propertyName) { return propertyMap.get(propertyName); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/MethodInvokerMethodInterceptor.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/MethodInvokerMethodInterceptor.java index 78a5d81701..9b95dd76f8 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/MethodInvokerMethodInterceptor.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/MethodInvokerMethodInterceptor.java @@ -20,6 +20,8 @@ import org.aopalliance.intercept.MethodInterceptor; import org.aopalliance.intercept.MethodInvocation; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.support.MethodInvoker; @@ -52,7 +54,7 @@ public MethodInvokerMethodInterceptor(Map> invokerMap } @Override - public Object invoke(MethodInvocation invocation) throws Throwable { + public @Nullable Object invoke(MethodInvocation invocation) throws Throwable { String methodName = invocation.getMethod().getName(); if (ordered && methodName.equals("getOrder")) { diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/MulticasterBatchListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/MulticasterBatchListener.java index 02ef2821fa..95dc131078 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/MulticasterBatchListener.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/MulticasterBatchListener.java @@ -19,11 +19,12 @@ import java.util.List; import org.springframework.batch.core.ExitStatus; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemStream; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -143,9 +144,8 @@ public void onProcessError(T item, Exception ex) { /** * @see org.springframework.batch.core.listener.CompositeStepExecutionListener#afterStep(StepExecution) */ - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { try { return stepListener.afterStep(stepExecution); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepExecutionListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepExecutionListener.java index 9c451b417c..7b903a03c3 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepExecutionListener.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepExecutionListener.java @@ -15,10 +15,11 @@ */ package org.springframework.batch.core.listener; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.Step; import org.springframework.batch.core.step.StepExecution; -import org.springframework.lang.Nullable; /** * Listener interface for the lifecycle of a {@link Step}. @@ -49,8 +50,7 @@ default void beforeStep(StepExecution stepExecution) { * @return an {@link ExitStatus} to combine with the normal value. Return {@code null} * (the default) to leave the old value unchanged. */ - @Nullable - default ExitStatus afterStep(StepExecution stepExecution) { + default @Nullable ExitStatus afterStep(StepExecution stepExecution) { return null; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepListenerMetaData.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepListenerMetaData.java index 4fb5aad1b1..3a82770be4 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepListenerMetaData.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepListenerMetaData.java @@ -20,6 +20,8 @@ import java.util.Map; import org.springframework.batch.core.step.StepExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.annotation.AfterChunk; import org.springframework.batch.core.annotation.AfterChunkError; import org.springframework.batch.core.annotation.AfterProcess; @@ -39,7 +41,6 @@ import org.springframework.batch.core.annotation.OnWriteError; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.item.Chunk; -import org.springframework.lang.Nullable; /** * Enumeration for {@link StepListener} meta data, which ties together the names of @@ -135,8 +136,7 @@ public String getPropertyName() { * @param propertyName property name to retrieve data for. * @return meta data with supplied property name, null if none exists. */ - @Nullable - public static StepListenerMetaData fromPropertyName(String propertyName) { + public static @Nullable StepListenerMetaData fromPropertyName(String propertyName) { return propertyMap.get(propertyName); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/package-info.java index 0f23a4ab87..7aa5718d06 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/listener/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/listener/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.listener; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/observability/BatchMetrics.java b/spring-batch-core/src/main/java/org/springframework/batch/core/observability/BatchMetrics.java index 6884dac28a..106004d612 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/observability/BatchMetrics.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/observability/BatchMetrics.java @@ -28,8 +28,7 @@ import io.micrometer.core.instrument.observation.DefaultMeterObservationHandler; import io.micrometer.observation.Observation; import io.micrometer.observation.ObservationRegistry; - -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Central class for batch metrics. It provides: @@ -160,8 +159,8 @@ public static LongTaskTimer createLongTaskTimer(MeterRegistry meterRegistry, Str * @param endTime the end time * @return the duration between start time and end time */ - @Nullable - public static Duration calculateDuration(@Nullable LocalDateTime startTime, @Nullable LocalDateTime endTime) { + public static @Nullable Duration calculateDuration(@Nullable LocalDateTime startTime, + @Nullable LocalDateTime endTime) { if (startTime == null || endTime == null) { return null; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/package-info.java index 9728478b81..7316d4f312 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/package-info.java @@ -6,8 +6,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/partition/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/partition/package-info.java index c6e4a484b6..266938e275 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/partition/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/partition/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.partition; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/AbstractPartitionHandler.java b/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/AbstractPartitionHandler.java index 0d7692eba1..fbaeda9cbe 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/AbstractPartitionHandler.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/AbstractPartitionHandler.java @@ -52,7 +52,7 @@ protected abstract Set doHandle(StepExecution managerStepExecutio * @see PartitionHandler#handle(StepExecutionSplitter, StepExecution) */ @Override - public Collection handle(final StepExecutionSplitter stepSplitter, + public Collection handle(StepExecutionSplitter stepSplitter, final StepExecution managerStepExecution) throws Exception { final Set stepExecutions = stepSplitter.split(managerStepExecution, gridSize); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/TaskExecutorPartitionHandler.java b/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/TaskExecutorPartitionHandler.java index bc0ff6d1a7..f8e7605909 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/TaskExecutorPartitionHandler.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/TaskExecutorPartitionHandler.java @@ -93,7 +93,7 @@ protected Set doHandle(StepExecution managerStepExecution, final Set> tasks = new HashSet<>(getGridSize()); final Set result = new HashSet<>(); - for (final StepExecution stepExecution : partitionStepExecutions) { + for (StepExecution stepExecution : partitionStepExecutions) { final FutureTask task = createTask(step, stepExecution); try { @@ -127,7 +127,7 @@ protected Set doHandle(StepExecution managerStepExecution, * @param stepExecution the given execution * @return the task executing the given step */ - protected FutureTask createTask(final Step step, final StepExecution stepExecution) { + protected FutureTask createTask(Step step, final StepExecution stepExecution) { return new FutureTask<>(() -> { step.execute(stepExecution); return stepExecution; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/package-info.java index 2e8601b4fc..ae805fdf79 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/partition/support/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.partition.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/ExecutionContextDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/ExecutionContextDao.java index 53921956e4..f6ab4ca603 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/ExecutionContextDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/ExecutionContextDao.java @@ -48,14 +48,14 @@ 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 @@ -63,21 +63,21 @@ public interface ExecutionContextDao { * @param stepExecutions a collection of {@link StepExecution}s that contain the * contexts. */ - void saveExecutionContexts(final Collection stepExecutions); + void saveExecutionContexts(Collection 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}. diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobExecutionDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobExecutionDao.java index 4bdb677018..37f64d4695 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobExecutionDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobExecutionDao.java @@ -19,9 +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; /** * Data Access Object for job executions. @@ -64,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. @@ -78,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 diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobInstanceDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobInstanceDao.java index 581e02c00d..d4eab5f958 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobInstanceDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobInstanceDao.java @@ -19,10 +19,11 @@ import java.util.List; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.launch.NoSuchJobException; -import org.springframework.lang.Nullable; /** * Data Access Object for job instances. @@ -57,16 +58,14 @@ 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. @@ -74,8 +73,7 @@ public interface JobInstanceDao { * @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 @@ -97,8 +95,7 @@ public interface JobInstanceDao { * * @since 4.2 */ - @Nullable - default JobInstance getLastJobInstance(String jobName) { + default @Nullable JobInstance getLastJobInstance(String jobName) { throw new UnsupportedOperationException(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/StepExecutionDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/StepExecutionDao.java index 5bdc678471..a50d0d89b3 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/StepExecutionDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/StepExecutionDao.java @@ -19,9 +19,10 @@ import java.util.Collection; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.step.StepExecution; -import org.springframework.lang.Nullable; public interface StepExecutionDao { @@ -59,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 @@ -69,8 +69,7 @@ public interface StepExecutionDao { * @param stepName the name of the step * @return a {@link StepExecution} */ - @Nullable - default StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + default @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { throw new UnsupportedOperationException(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcExecutionContextDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcExecutionContextDao.java index e585661a80..db717b1f56 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcExecutionContextDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcExecutionContextDao.java @@ -34,6 +34,7 @@ import java.util.stream.Stream; import org.springframework.batch.core.job.JobExecution; + import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.repository.ExecutionContextSerializer; import org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao; @@ -43,7 +44,6 @@ import org.springframework.core.serializer.Serializer; import org.springframework.jdbc.core.BatchPreparedStatementSetter; import org.springframework.jdbc.core.RowMapper; -import org.springframework.lang.NonNull; import org.springframework.util.Assert; /** @@ -144,7 +144,7 @@ public void setShortContextLength(int shortContextLength) { * @param charset to use when serializing/deserializing the execution context. * @since 5.0 */ - public void setCharset(@NonNull Charset charset) { + public void setCharset(Charset charset) { Assert.notNull(charset, "Charset must not be null"); this.charset = charset; } @@ -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 serializedContexts, String sql) { + private void persistSerializedContexts(Map serializedContexts, String sql) { if (!serializedContexts.isEmpty()) { final Iterator executionIdIterator = serializedContexts.keySet().iterator(); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobExecutionDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobExecutionDao.java index 012f42982f..7c31ac4d80 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobExecutionDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobExecutionDao.java @@ -32,6 +32,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.ExitStatus; @@ -58,8 +59,6 @@ import org.springframework.jdbc.core.RowCallbackHandler; import org.springframework.jdbc.core.RowMapper; import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer; -import org.springframework.lang.NonNull; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -196,7 +195,7 @@ public void setJobExecutionIncrementer(DataFieldMaxValueIncrementer jobExecution * Set the conversion service to use to convert job parameters from String literals to * typed values and vice versa. */ - public void setConversionService(@NonNull ConfigurableConversionService conversionService) { + public void setConversionService(ConfigurableConversionService conversionService) { Assert.notNull(conversionService, "conversionService must not be null"); this.conversionService = conversionService; } @@ -208,7 +207,7 @@ public void afterPropertiesSet() throws Exception { } @Override - public List findJobExecutions(final JobInstance job) { + public List findJobExecutions(JobInstance job) { Assert.notNull(job, "Job cannot be null."); Assert.notNull(job.getId(), "Job Id cannot be null."); @@ -331,9 +330,8 @@ public void updateJobExecution(JobExecution jobExecution) { } } - @Nullable @Override - public JobExecution getLastJobExecution(JobInstance jobInstance) { + public @Nullable JobExecution getLastJobExecution(JobInstance jobInstance) { Long id = jobInstance.getId(); @@ -344,8 +342,7 @@ public JobExecution getLastJobExecution(JobInstance jobInstance) { } @Override - @Nullable - public JobExecution getJobExecution(Long executionId) { + public @Nullable JobExecution getJobExecution(Long executionId) { try { return getJdbcTemplate().queryForObject(getQuery(GET_EXECUTION_BY_ID), new JobExecutionRowMapper(), executionId); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobInstanceDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobInstanceDao.java index 6e39d21584..b22bd99112 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobInstanceDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobInstanceDao.java @@ -24,6 +24,8 @@ import java.util.stream.Stream; import org.springframework.batch.core.job.DefaultJobKeyGenerator; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.JobKeyGenerator; @@ -38,7 +40,6 @@ import org.springframework.jdbc.core.ResultSetExtractor; import org.springframework.jdbc.core.RowMapper; import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.StringUtils; @@ -166,8 +167,7 @@ public JobInstance createJobInstance(String jobName, JobParameters jobParameters * @throws IllegalArgumentException if any {@link JobParameters} fields are null. */ @Override - @Nullable - public 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."); @@ -185,8 +185,7 @@ public JobInstance getJobInstance(final String jobName, final JobParameters jobP } @Override - @Nullable - public JobInstance getJobInstance(@Nullable Long instanceId) { + public @Nullable JobInstance getJobInstance(@Nullable Long instanceId) { try { return getJdbcTemplate().queryForObject(getQuery(GET_JOB_FROM_ID), new JobInstanceRowMapper(), instanceId); @@ -233,8 +232,7 @@ public List extractData(ResultSet rs) throws SQLException, DataAcce } @Override - @Nullable - public JobInstance getLastJobInstance(String jobName) { + public @Nullable JobInstance getLastJobInstance(String jobName) { try { return getJdbcTemplate().queryForObject(getQuery(FIND_LAST_JOB_INSTANCE_BY_JOB_NAME), new JobInstanceRowMapper(), jobName, jobName); @@ -245,8 +243,7 @@ public JobInstance getLastJobInstance(String jobName) { } @Override - @Nullable - public JobInstance getJobInstance(JobExecution jobExecution) { + public @Nullable JobInstance getJobInstance(JobExecution jobExecution) { try { return getJdbcTemplate().queryForObject(getQuery(GET_JOB_FROM_EXECUTION_ID), new JobInstanceRowMapper(), diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcStepExecutionDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcStepExecutionDao.java index a9c910eb09..b0c8097901 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcStepExecutionDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcStepExecutionDao.java @@ -33,6 +33,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.ExitStatus; @@ -46,7 +47,6 @@ import org.springframework.jdbc.core.BatchPreparedStatementSetter; import org.springframework.jdbc.core.RowMapper; import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -176,7 +176,7 @@ public void saveStepExecution(StepExecution stepExecution) { * @see StepExecutionDao#saveStepExecutions(Collection) */ @Override - public void saveStepExecutions(final Collection stepExecutions) { + public void saveStepExecutions(Collection stepExecutions) { Assert.notNull(stepExecutions, "Attempt to save a null collection of step executions"); if (!stepExecutions.isEmpty()) { @@ -325,8 +325,7 @@ private String truncateExitDescription(String description) { } @Override - @Nullable - public StepExecution getStepExecution(JobExecution jobExecution, Long stepExecutionId) { + public @Nullable StepExecution getStepExecution(JobExecution jobExecution, Long stepExecutionId) { try (Stream stream = getJdbcTemplate().queryForStream(getQuery(GET_STEP_EXECUTION), new StepExecutionRowMapper(jobExecution), stepExecutionId)) { return stream.findFirst().orElse(null); @@ -334,7 +333,7 @@ public StepExecution getStepExecution(JobExecution jobExecution, Long stepExecut } @Override - public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + public @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { List executions = getJdbcTemplate().query(getQuery(GET_LAST_STEP_EXECUTION), (rs, rowNum) -> { Long jobExecutionId = rs.getLong(19); JobExecution jobExecution = new JobExecution(jobExecutionId); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobExecutionDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobExecutionDao.java index d95c8d9105..3abcfed95d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobExecutionDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobExecutionDao.java @@ -20,6 +20,8 @@ import java.util.Set; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.repository.dao.JobExecutionDao; import org.springframework.batch.core.repository.persistence.converter.JobExecutionConverter; @@ -91,7 +93,7 @@ public List findJobExecutions(JobInstance jobInstance) { } @Override - public JobExecution getLastJobExecution(JobInstance jobInstance) { + public @Nullable JobExecution getLastJobExecution(JobInstance jobInstance) { Query query = query(where("jobInstanceId").is(jobInstance.getId())); Sort.Order sortOrder = Sort.Order.desc("jobExecutionId"); org.springframework.batch.core.repository.persistence.JobExecution jobExecution = this.mongoOperations.findOne( @@ -125,7 +127,7 @@ public Set findRunningJobExecutions(String jobName) { } @Override - public JobExecution getJobExecution(Long executionId) { + public @Nullable JobExecution getJobExecution(Long executionId) { Query jobExecutionQuery = query(where("jobExecutionId").is(executionId)); org.springframework.batch.core.repository.persistence.JobExecution jobExecution = this.mongoOperations.findOne( jobExecutionQuery, org.springframework.batch.core.repository.persistence.JobExecution.class, diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobInstanceDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobInstanceDao.java index 2d742aa9e6..13e5d8fc23 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobInstanceDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobInstanceDao.java @@ -18,6 +18,8 @@ import java.util.List; import org.springframework.batch.core.job.DefaultJobKeyGenerator; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.JobKeyGenerator; @@ -87,7 +89,7 @@ public JobInstance createJobInstance(String jobName, JobParameters jobParameters } @Override - public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { String key = this.jobKeyGenerator.generateKey(jobParameters); Query query = query(where("jobName").is(jobName).and("jobKey").is(key)); org.springframework.batch.core.repository.persistence.JobInstance jobInstance = this.mongoOperations @@ -96,7 +98,7 @@ public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { } @Override - public JobInstance getJobInstance(Long instanceId) { + public @Nullable JobInstance getJobInstance(Long instanceId) { Query query = query(where("jobInstanceId").is(instanceId)); org.springframework.batch.core.repository.persistence.JobInstance jobInstance = this.mongoOperations .findOne(query, org.springframework.batch.core.repository.persistence.JobInstance.class, COLLECTION_NAME); @@ -125,7 +127,7 @@ public List getJobInstances(String jobName, int start, int count) { } @Override - public JobInstance getLastJobInstance(String jobName) { + public @Nullable JobInstance getLastJobInstance(String jobName) { Query query = query(where("jobName").is(jobName)); Sort.Order sortOrder = Sort.Order.desc("jobInstanceId"); org.springframework.batch.core.repository.persistence.JobInstance jobInstance = this.mongoOperations.findOne( diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoStepExecutionDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoStepExecutionDao.java index a7bac8ce26..72c72f5cf4 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoStepExecutionDao.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoStepExecutionDao.java @@ -22,6 +22,8 @@ import java.util.Optional; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.repository.dao.StepExecutionDao; @@ -89,7 +91,7 @@ public void updateStepExecution(StepExecution stepExecution) { } @Override - public StepExecution getStepExecution(JobExecution jobExecution, Long stepExecutionId) { + public @Nullable StepExecution getStepExecution(JobExecution jobExecution, Long stepExecutionId) { Query query = query(where("stepExecutionId").is(stepExecutionId)); org.springframework.batch.core.repository.persistence.StepExecution stepExecution = this.mongoOperations .findOne(query, org.springframework.batch.core.repository.persistence.StepExecution.class, @@ -98,7 +100,7 @@ public StepExecution getStepExecution(JobExecution jobExecution, Long stepExecut } @Override - public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + public @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { // TODO optimize the query // get all step executions List stepExecutions = new ArrayList<>(); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/package-info.java index 88e0759c1e..6039232e2f 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.repository.dao; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/JobExplorer.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/JobExplorer.java index aae7366d76..2953879363 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/JobExplorer.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/JobExplorer.java @@ -20,13 +20,14 @@ import java.util.Set; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.launch.NoSuchJobException; import org.springframework.batch.core.repository.JobRepository; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; /** * Entry point for browsing the executions of running or historical jobs and steps. Since @@ -129,8 +130,7 @@ default boolean isJobInstanceExists(String jobName, JobParameters jobParameters) * @param instanceId {@link Long} The ID for the {@link JobInstance} to obtain. * @return the {@code JobInstance} that has this ID, or {@code null} if not found. */ - @Nullable - default JobInstance getJobInstance(@Nullable Long instanceId) { + default @Nullable JobInstance getJobInstance(@Nullable Long instanceId) { throw new UnsupportedOperationException(); } @@ -141,8 +141,7 @@ default JobInstance getJobInstance(@Nullable Long instanceId) { * * @since 4.2 */ - @Nullable - default JobInstance getLastJobInstance(String jobName) { + default @Nullable JobInstance getLastJobInstance(String jobName) { throw new UnsupportedOperationException(); } @@ -154,8 +153,7 @@ default JobInstance getLastJobInstance(String jobName) { * * @since 5.0 */ - @Nullable - default JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + default @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { throw new UnsupportedOperationException(); } @@ -186,8 +184,7 @@ default long getJobInstanceCount(@Nullable String jobName) throws NoSuchJobExcep * @param executionId The job execution ID. * @return the {@link JobExecution} that has this ID or {@code null} if not found. */ - @Nullable - default JobExecution getJobExecution(@Nullable Long executionId) { + default @Nullable JobExecution getJobExecution(@Nullable Long executionId) { throw new UnsupportedOperationException(); } @@ -227,8 +224,7 @@ default List findJobExecutions(JobInstance jobInstance) { * * @since 4.2 */ - @Nullable - default JobExecution getLastJobExecution(JobInstance jobInstance) { + default @Nullable JobExecution getLastJobExecution(JobInstance jobInstance) { throw new UnsupportedOperationException(); } @@ -237,8 +233,7 @@ default JobExecution getLastJobExecution(JobInstance jobInstance) { * @param jobParameters parameters identifying the {@link JobInstance} * @return the last execution of job if exists, null otherwise */ - @Nullable - default JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { + default @Nullable JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { throw new UnsupportedOperationException(); } @@ -271,8 +266,7 @@ default Set findRunningJobExecutions(@Nullable String jobName) { * * @see #getJobExecution(Long) */ - @Nullable - default StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable Long stepExecutionId) { + default @Nullable StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable Long stepExecutionId) { throw new UnsupportedOperationException(); } @@ -281,8 +275,7 @@ default StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable * @param stepName the name of the step execution that might have run. * @return the last execution of step for the given job instance. */ - @Nullable - default StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + default @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { throw new UnsupportedOperationException(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/package-info.java index c759d4d869..a210bed90c 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.repository.explore; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/JobExplorerFactoryBean.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/JobExplorerFactoryBean.java index 98da269d85..a43fee0ed2 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/JobExplorerFactoryBean.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/JobExplorerFactoryBean.java @@ -22,6 +22,7 @@ import javax.sql.DataSource; import org.springframework.batch.core.job.DefaultJobKeyGenerator; + import org.springframework.batch.core.job.JobKeyGenerator; import org.springframework.batch.core.converter.DateToStringConverter; import org.springframework.batch.core.converter.LocalDateTimeToStringConverter; @@ -51,7 +52,6 @@ import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.jdbc.support.incrementer.AbstractDataFieldMaxValueIncrementer; import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer; -import org.springframework.lang.NonNull; import org.springframework.util.Assert; /** @@ -145,7 +145,7 @@ public void setJobKeyGenerator(JobKeyGenerator jobKeyGenerator) { * @see JdbcExecutionContextDao#setCharset(Charset) * @since 5.0 */ - public void setCharset(@NonNull Charset charset) { + public void setCharset(Charset charset) { Assert.notNull(charset, "Charset must not be null"); this.charset = charset; } @@ -156,7 +156,7 @@ public void setCharset(@NonNull Charset charset) { * @param conversionService the conversion service to use * @since 5.0 */ - public void setConversionService(@NonNull ConfigurableConversionService conversionService) { + public void setConversionService(ConfigurableConversionService conversionService) { Assert.notNull(conversionService, "ConversionService must not be null"); this.conversionService = conversionService; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/SimpleJobExplorer.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/SimpleJobExplorer.java index 5e846060a3..b6423804c6 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/SimpleJobExplorer.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/SimpleJobExplorer.java @@ -28,11 +28,12 @@ import org.springframework.batch.core.repository.dao.StepExecutionDao; import org.springframework.batch.core.repository.support.SimpleJobRepository; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; import java.util.List; import java.util.Set; +import org.jspecify.annotations.Nullable; + /** * Implementation of {@link JobExplorer} that uses the injected DAOs. * @@ -118,21 +119,18 @@ public List findJobInstancesByName(String jobName, int start, int c return getJobInstances(jobName, start, count); } - @Nullable @Override - public JobInstance getJobInstance(@Nullable Long instanceId) { + public @Nullable JobInstance getJobInstance(@Nullable Long instanceId) { return jobInstanceDao.getJobInstance(instanceId); } - @Nullable @Override - public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { return jobInstanceDao.getJobInstance(jobName, jobParameters); } - @Nullable @Override - public JobInstance getLastJobInstance(String jobName) { + public @Nullable JobInstance getLastJobInstance(String jobName) { return jobInstanceDao.getLastJobInstance(jobName); } @@ -164,9 +162,8 @@ public List getJobExecutions(JobInstance jobInstance) { return executions; } - @Nullable @Override - public JobExecution getLastJobExecution(JobInstance jobInstance) { + public @Nullable JobExecution getLastJobExecution(JobInstance jobInstance) { JobExecution lastJobExecution = jobExecutionDao.getLastJobExecution(jobInstance); if (lastJobExecution != null) { getJobExecutionDependencies(lastJobExecution); @@ -188,8 +185,7 @@ public List findJobExecutions(JobInstance jobInstance) { } @Override - @Nullable - public JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { + public @Nullable JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { JobInstance jobInstance = jobInstanceDao.getJobInstance(jobName, jobParameters); if (jobInstance == null) { return null; @@ -215,9 +211,8 @@ public Set findRunningJobExecutions(@Nullable String jobName) { return executions; } - @Nullable @Override - public JobExecution getJobExecution(@Nullable Long executionId) { + public @Nullable JobExecution getJobExecution(@Nullable Long executionId) { if (executionId == null) { return null; } @@ -250,9 +245,8 @@ private void getJobExecutionDependencies(JobExecution jobExecution) { * =================================================================================== */ - @Nullable @Override - public StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable Long executionId) { + public @Nullable StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable Long executionId) { JobExecution jobExecution = jobExecutionDao.getJobExecution(jobExecutionId); if (jobExecution == null) { return null; @@ -264,8 +258,7 @@ public StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable L } @Override - @Nullable - public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + public @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { StepExecution latest = stepExecutionDao.getLastStepExecution(jobInstance, stepName); if (latest != null) { diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/package-info.java index 44b0a8f465..d7c1764b38 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.repository.explore.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/package-info.java index 46105e337d..797a6676ae 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.repository; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JdbcJobRepositoryFactoryBean.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JdbcJobRepositoryFactoryBean.java index cab693390e..d5d920212d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JdbcJobRepositoryFactoryBean.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JdbcJobRepositoryFactoryBean.java @@ -27,7 +27,6 @@ import org.springframework.core.convert.support.ConfigurableConversionService; import org.springframework.jdbc.core.JdbcOperations; import org.springframework.jdbc.core.JdbcTemplate; -import org.springframework.lang.NonNull; import javax.sql.DataSource; import java.nio.charset.Charset; @@ -165,7 +164,7 @@ public void setIncrementerFactory(DataFieldMaxValueIncrementerFactory incremente * @since 5.0 */ @Override - public void setCharset(@NonNull Charset charset) { + public void setCharset(Charset charset) { super.setCharset(charset); } @@ -176,7 +175,7 @@ public void setCharset(@NonNull Charset charset) { * @since 5.0 */ @Override - public void setConversionService(@NonNull ConfigurableConversionService conversionService) { + public void setConversionService(ConfigurableConversionService conversionService) { super.setConversionService(conversionService); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBean.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBean.java index f026439bda..e4e7afe6f6 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBean.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBean.java @@ -27,7 +27,12 @@ import org.springframework.batch.core.converter.StringToLocalDateTimeConverter; import org.springframework.batch.core.converter.StringToLocalTimeConverter; import org.springframework.batch.core.repository.ExecutionContextSerializer; -import org.springframework.batch.core.repository.dao.*; +import org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao; +import org.springframework.batch.core.repository.dao.DefaultExecutionContextSerializer; +import org.springframework.batch.core.repository.dao.ExecutionContextDao; +import org.springframework.batch.core.repository.dao.JobExecutionDao; +import org.springframework.batch.core.repository.dao.JobInstanceDao; +import org.springframework.batch.core.repository.dao.StepExecutionDao; import org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao; import org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao; import org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao; @@ -41,7 +46,6 @@ import org.springframework.core.convert.support.DefaultConversionService; import org.springframework.jdbc.core.JdbcOperations; import org.springframework.jdbc.core.JdbcTemplate; -import org.springframework.lang.NonNull; import org.springframework.util.Assert; import org.springframework.util.StringUtils; @@ -201,7 +205,7 @@ public void setIncrementerFactory(DataFieldMaxValueIncrementerFactory incremente * @see JdbcExecutionContextDao#setCharset(Charset) * @since 5.0 */ - public void setCharset(@NonNull Charset charset) { + public void setCharset(Charset charset) { Assert.notNull(charset, "Charset must not be null"); this.charset = charset; } @@ -212,7 +216,7 @@ public void setCharset(@NonNull Charset charset) { * @param conversionService the conversion service to use * @since 5.0 */ - public void setConversionService(@NonNull ConfigurableConversionService conversionService) { + public void setConversionService(ConfigurableConversionService conversionService) { Assert.notNull(conversionService, "ConversionService must not be null"); this.conversionService = conversionService; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/package-info.java index 434f78772b..c9f66ec283 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/package-info.java @@ -4,7 +4,7 @@ * @author Michael Minella * @author Mahmoud Ben Hassine */ -@NonNullApi +@NullMarked package org.springframework.batch.core.repository.support; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/JobContext.java b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/JobContext.java index bd92302649..0e3e465dc1 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/JobContext.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/JobContext.java @@ -26,6 +26,8 @@ import java.util.Set; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.parameters.JobParameter; import org.springframework.batch.core.job.parameters.JobParameters; @@ -33,7 +35,6 @@ import org.springframework.batch.core.scope.StepScope; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.repeat.context.SynchronizedAttributeAccessor; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -121,8 +122,7 @@ private void unregisterDestructionCallbacks(String name) { * @see SynchronizedAttributeAccessor#removeAttribute(String) */ @Override - @Nullable - public Object removeAttribute(String name) { + public @Nullable Object removeAttribute(String name) { unregisterDestructionCallbacks(name); return super.removeAttribute(name); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/JobSynchronizationManager.java b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/JobSynchronizationManager.java index e3fa5d2ee3..e448cb711c 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/JobSynchronizationManager.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/JobSynchronizationManager.java @@ -15,9 +15,10 @@ */ package org.springframework.batch.core.scope.context; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.Job; import org.springframework.batch.core.job.JobExecution; -import org.springframework.lang.Nullable; /** * Central convenience class for framework use in managing the job scope context. @@ -51,8 +52,7 @@ protected void close(JobContext context) { * @return the current {@link JobContext} or {@code null} if there is none (if one has * not been registered for this thread). */ - @Nullable - public static JobContext getContext() { + public static @Nullable JobContext getContext() { return manager.getContext(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/StepContext.java b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/StepContext.java index 579aab3879..fb9057fea2 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/StepContext.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/StepContext.java @@ -26,6 +26,8 @@ import java.util.Set; import org.springframework.batch.core.job.JobInstance; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.parameters.JobParameter; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.step.StepExecution; @@ -33,7 +35,6 @@ import org.springframework.batch.core.scope.StepScope; import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.repeat.context.SynchronizedAttributeAccessor; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -157,8 +158,7 @@ private void unregisterDestructionCallbacks(String name) { * @see SynchronizedAttributeAccessor#removeAttribute(String) */ @Override - @Nullable - public Object removeAttribute(String name) { + public @Nullable Object removeAttribute(String name) { unregisterDestructionCallbacks(name); return super.removeAttribute(name); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/StepSynchronizationManager.java b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/StepSynchronizationManager.java index 34c24d0dc0..4f100cf2be 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/StepSynchronizationManager.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/StepSynchronizationManager.java @@ -15,9 +15,10 @@ */ package org.springframework.batch.core.scope.context; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.Step; import org.springframework.batch.core.step.StepExecution; -import org.springframework.lang.Nullable; /** * Central convenience class for framework use in managing the step scope context. @@ -51,8 +52,7 @@ protected void close(StepContext context) { * @return the current {@link StepContext} or {@code null} if there is none (if one * has not been registered for this thread). */ - @Nullable - public static StepContext getContext() { + public static @Nullable StepContext getContext() { return manager.getContext(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/SynchronizationManagerSupport.java b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/SynchronizationManagerSupport.java index f76a48b55a..816768e2f9 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/SynchronizationManagerSupport.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/SynchronizationManagerSupport.java @@ -20,7 +20,7 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicInteger; -import org.springframework.lang.Nullable; +import org.jspecify.annotations.Nullable; /** * Central convenience class for framework use in managing the scope context. @@ -63,8 +63,7 @@ public abstract class SynchronizationManagerSupport { * @return the current context or {@code null} if there is none (if one has not been * registered for this thread). */ - @Nullable - public C getContext() { + public @Nullable C getContext() { if (getCurrent().isEmpty()) { return null; } @@ -80,8 +79,7 @@ public C getContext() { * @param execution the execution to register * @return a new context or the current one if it has the same execution */ - @Nullable - public C register(@Nullable E execution) { + public @Nullable C register(@Nullable E execution) { if (execution == null) { return null; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/package-info.java index 48d5db3431..abd1c047f2 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/context/package-info.java @@ -4,8 +4,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.scope.context; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/package-info.java index b79fafb67d..6a538f3720 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/scope/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/scope/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.scope; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/NoWorkFoundStepExecutionListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/NoWorkFoundStepExecutionListener.java index 940230080a..535245564b 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/NoWorkFoundStepExecutionListener.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/NoWorkFoundStepExecutionListener.java @@ -16,9 +16,10 @@ package org.springframework.batch.core.step; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.listener.StepExecutionListener; -import org.springframework.lang.Nullable; /** * Fails the step if no items have been processed ( item count is 0). @@ -28,9 +29,8 @@ */ public class NoWorkFoundStepExecutionListener implements StepExecutionListener { - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { if (stepExecution.getReadCount() == 0) { return ExitStatus.FAILED; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/StepExecution.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/StepExecution.java index 939102aaa5..69d654101d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/StepExecution.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/StepExecution.java @@ -29,7 +29,8 @@ import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** @@ -159,8 +160,7 @@ public void setCommitCount(long commitCount) { * Returns the time when this execution ended or {@code null} if the step is running. * @return the time when this execution ended or {@code null} if the step is running. */ - @Nullable - public LocalDateTime getEndTime() { + public @Nullable LocalDateTime getEndTime() { return endTime; } @@ -256,8 +256,7 @@ public void setCreateTime(LocalDateTime createTime) { * Gets the time when this execution started. * @return the time when this execution started. */ - @Nullable - public LocalDateTime getStartTime() { + public @Nullable LocalDateTime getStartTime() { return startTime; } @@ -306,7 +305,7 @@ public String getStepName() { * Accessor for the job execution ID. * @return the {@code jobExecutionId}. */ - public Long getJobExecutionId() { + public @Nullable Long getJobExecutionId() { if (jobExecution != null) { return jobExecution.getId(); } @@ -460,8 +459,7 @@ public void setProcessSkipCount(long processSkipCount) { /** * @return the Date representing the last time this execution was persisted. */ - @Nullable - public LocalDateTime getLastUpdated() { + public @Nullable LocalDateTime getLastUpdated() { return lastUpdated; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/package-info.java index e8d832a425..252eac12c2 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.step.builder; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/factory/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/factory/package-info.java index 030917bc84..4332408c59 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/factory/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/factory/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.step.factory; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/ChunkOrientedTasklet.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/ChunkOrientedTasklet.java index d6a7bb47c8..cdf016d674 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/ChunkOrientedTasklet.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/ChunkOrientedTasklet.java @@ -18,12 +18,13 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.item.Chunk; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * A {@link Tasklet} implementing variations on read-process-write item handling. @@ -63,9 +64,8 @@ public void setBuffering(boolean buffering) { this.buffering = buffering; } - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { @SuppressWarnings("unchecked") Chunk inputs = (Chunk) chunkContext.getAttribute(INPUTS_KEY); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/FaultTolerantChunkProcessor.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/FaultTolerantChunkProcessor.java index 27cb244a1b..48a7270e54 100755 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/FaultTolerantChunkProcessor.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/FaultTolerantChunkProcessor.java @@ -204,7 +204,7 @@ protected Chunk getAdjustedOutputs(Chunk inputs, Chunk outputs) { } @Override - protected Chunk transform(final StepContribution contribution, Chunk inputs) throws Exception { + protected Chunk transform(StepContribution contribution, Chunk inputs) throws Exception { Chunk outputs = new Chunk<>(); @SuppressWarnings("unchecked") @@ -215,7 +215,7 @@ protected Chunk transform(final StepContribution contribution, Chunk input // final int scanLimit = processorTransactional && data.scanning() ? 1 : // 0; - for (final Chunk.ChunkIterator iterator = inputs.iterator(); iterator.hasNext();) { + for (Chunk.ChunkIterator iterator = inputs.iterator(); iterator.hasNext();) { final I item = iterator.next(); @@ -318,7 +318,7 @@ else if (shouldSkip(itemProcessSkipPolicy, e, contribution.getStepSkipCount())) } @Override - protected void write(final StepContribution contribution, final Chunk inputs, final Chunk outputs) + protected void write(StepContribution contribution, final Chunk inputs, final Chunk outputs) throws Exception { @SuppressWarnings("unchecked") final UserData data = (UserData) inputs.getUserData(); @@ -437,7 +437,7 @@ protected void write(final StepContribution contribution, final Chunk inputs, } - private void callSkipListeners(final Chunk inputs, final Chunk outputs) { + private void callSkipListeners(Chunk inputs, final Chunk outputs) { for (SkipWrapper wrapper : inputs.getSkips()) { I item = wrapper.getItem(); @@ -505,7 +505,7 @@ private Object getInputKey(I item) { return keyGenerator.getKey(item); } - private List getInputKeys(final Chunk inputs) { + private List getInputKeys(Chunk inputs) { if (keyGenerator == null) { return inputs.getItems(); } @@ -544,7 +544,7 @@ else if (e instanceof Error error) { } } - private void scan(final StepContribution contribution, final Chunk inputs, final Chunk outputs, + private void scan(StepContribution contribution, final Chunk inputs, final Chunk outputs, ChunkMonitor chunkMonitor, boolean recovery) throws Exception { @SuppressWarnings("unchecked") diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProcessor.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProcessor.java index 246cdbd5d6..08a41a131f 100755 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProcessor.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProcessor.java @@ -22,6 +22,7 @@ import io.micrometer.core.instrument.Metrics; import io.micrometer.core.instrument.Tag; import io.micrometer.core.instrument.Timer; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.step.StepExecution; @@ -32,7 +33,6 @@ import org.springframework.batch.item.ItemProcessor; import org.springframework.batch.item.ItemWriter; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProvider.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProvider.java index 2ba00208af..b9a528dad0 100755 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProvider.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProvider.java @@ -24,6 +24,8 @@ import io.micrometer.core.instrument.Timer; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepListener; @@ -33,7 +35,6 @@ import org.springframework.batch.item.ItemReader; import org.springframework.batch.repeat.RepeatOperations; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * Simple implementation of the ChunkProvider interface that does basic chunk providing @@ -105,8 +106,7 @@ public void registerListener(StepListener listener) { * @return the item or {@code null} if the data source is exhausted * @throws Exception is thrown if error occurs during read. */ - @Nullable - protected final I doRead() throws Exception { + protected final @Nullable I doRead() throws Exception { try { listener.beforeRead(); I item = itemReader.read(); @@ -125,7 +125,7 @@ protected final I doRead() throws Exception { } @Override - public Chunk provide(final StepContribution contribution) throws Exception { + public Chunk provide(StepContribution contribution) throws Exception { final Chunk inputs = new Chunk<>(); repeatOperations.iterate(context -> { @@ -181,8 +181,7 @@ public void postProcess(StepContribution contribution, Chunk chunk) { * data (e.g. skips) and it wants to force a commit. * @throws Exception if there is a generic issue */ - @Nullable - protected I read(StepContribution contribution, Chunk chunk) throws SkipOverflowException, Exception { + protected @Nullable I read(StepContribution contribution, Chunk chunk) throws SkipOverflowException, Exception { return doRead(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/package-info.java index 3b75c6cf67..71e81d0d63 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/item/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.step.item; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/job/DefaultJobParametersExtractor.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/job/DefaultJobParametersExtractor.java index dcbdb70ac3..71a9fec0c1 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/job/DefaultJobParametersExtractor.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/job/DefaultJobParametersExtractor.java @@ -29,7 +29,6 @@ import org.springframework.batch.core.converter.DefaultJobParametersConverter; import org.springframework.batch.core.converter.JobParametersConverter; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.NonNull; import org.springframework.util.Assert; /** @@ -103,7 +102,7 @@ public void setUseAllParentParameters(boolean useAllParentParameters) { * removal in 6.2 or later. */ @Deprecated(since = "6.0", forRemoval = true) - public void setJobParametersConverter(@NonNull JobParametersConverter jobParametersConverter) { + public void setJobParametersConverter(JobParametersConverter jobParametersConverter) { Assert.notNull(jobParametersConverter, "jobParametersConverter must not be null"); this.jobParametersConverter = jobParametersConverter; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/job/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/job/package-info.java index e088a032d3..e527bc2312 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/job/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/job/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.step.job; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/package-info.java index 08fe3c3b82..1091311244 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.step; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/skip/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/skip/package-info.java index 5305064e22..85a3cd2920 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/skip/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/skip/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.step.skip; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/CallableTaskletAdapter.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/CallableTaskletAdapter.java index d22f2e7360..6f377eab8e 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/CallableTaskletAdapter.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/CallableTaskletAdapter.java @@ -18,10 +18,11 @@ import java.util.concurrent.Callable; import org.springframework.batch.core.step.StepContribution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -75,9 +76,8 @@ public void afterPropertiesSet() { * {@link StepContribution} and the attributes. * @see Tasklet#execute(StepContribution, ChunkContext) */ - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { return callable.call(); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/ConfigurableSystemProcessExitCodeMapper.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/ConfigurableSystemProcessExitCodeMapper.java index c801d6d255..ad0baa0f73 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/ConfigurableSystemProcessExitCodeMapper.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/ConfigurableSystemProcessExitCodeMapper.java @@ -19,6 +19,8 @@ import java.util.Map; import org.springframework.batch.core.ExitStatus; + +import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** @@ -36,7 +38,7 @@ public class ConfigurableSystemProcessExitCodeMapper implements SystemProcessExi private Map mappings; @Override - public ExitStatus getExitStatus(int exitCode) { + public @Nullable ExitStatus getExitStatus(int exitCode) { ExitStatus exitStatus = mappings.get(exitCode); if (exitStatus != null) { return exitStatus; diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/MethodInvokingTaskletAdapter.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/MethodInvokingTaskletAdapter.java index c1ff049150..5f7d02d7cc 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/MethodInvokingTaskletAdapter.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/MethodInvokingTaskletAdapter.java @@ -15,12 +15,13 @@ */ package org.springframework.batch.core.step.tasklet; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.item.adapter.AbstractMethodInvokingDelegator; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * A {@link Tasklet} that wraps a method in a POJO. By default the return value is @@ -42,9 +43,8 @@ public class MethodInvokingTaskletAdapter extends AbstractMethodInvokingDelegato * * @see Tasklet#execute(StepContribution, ChunkContext) */ - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { if (getArguments() == null) { setArguments(new Object[] { contribution, chunkContext }); } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/SystemCommandTasklet.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/SystemCommandTasklet.java index 467eb473c9..4cdd02f71e 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/SystemCommandTasklet.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/SystemCommandTasklet.java @@ -21,6 +21,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.JobExecution; @@ -34,7 +35,6 @@ import org.springframework.beans.factory.InitializingBean; import org.springframework.core.task.SimpleAsyncTaskExecutor; import org.springframework.core.task.TaskExecutor; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ObjectUtils; import org.springframework.util.StringUtils; @@ -97,9 +97,8 @@ public class SystemCommandTasklet implements StepExecutionListener, StoppableTas * Execute system command and map its exit code to {@link ExitStatus} using * {@link SystemProcessExitCodeMapper}. */ - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { FutureTask systemCommandTask = new FutureTask<>(() -> { Process process = commandRunner.exec(cmdArray, environmentParams, workingDirectory); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/Tasklet.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/Tasklet.java index c0f9c6a56e..dbbadf8276 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/Tasklet.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/Tasklet.java @@ -15,10 +15,11 @@ */ package org.springframework.batch.core.step.tasklet; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * Strategy for processing in a step. @@ -43,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; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/TaskletStep.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/TaskletStep.java index 6b97def353..6549043d5b 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/TaskletStep.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/TaskletStep.java @@ -485,7 +485,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()); diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/package-info.java index ff6c2cd786..7877ffc9e8 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/package-info.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.core.step.tasklet; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/JobBuilderConfigurationTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/JobBuilderConfigurationTests.java index 3d5ba56c9b..287971ea0d 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/JobBuilderConfigurationTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/JobBuilderConfigurationTests.java @@ -18,6 +18,7 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; @@ -41,7 +42,6 @@ import org.springframework.context.annotation.Import; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; import org.springframework.jdbc.support.JdbcTransactionManager; -import org.springframework.lang.Nullable; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -127,9 +127,10 @@ protected Step step2() throws Exception { @Bean protected Tasklet tasklet() { return new Tasklet() { - @Nullable + @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext context) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext context) + throws Exception { if (fail) { throw new RuntimeException("Planned!"); } @@ -183,9 +184,9 @@ public Job beansConfigurerJob(JobRepository jobRepository) throws Exception { protected Step step1(JobRepository jobRepository) throws Exception { return new StepBuilder("step1", jobRepository).tasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return null; } }, this.transactionManager).build(); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/JobScopeConfigurationTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/JobScopeConfigurationTests.java index 1328c19622..f006706449 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/JobScopeConfigurationTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/JobScopeConfigurationTests.java @@ -18,6 +18,7 @@ import java.util.concurrent.Callable; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -40,7 +41,6 @@ import org.springframework.context.annotation.Scope; import org.springframework.context.annotation.ScopedProxyMode; import org.springframework.context.support.ClassPathXmlApplicationContext; -import org.springframework.lang.Nullable; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; @@ -232,9 +232,9 @@ public SimpleHolder getValue() { public static class TaskletSupport implements Tasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return RepeatStatus.FINISHED; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/StepScopeConfigurationTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/StepScopeConfigurationTests.java index b7f60b6d2e..e2cd034b76 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/StepScopeConfigurationTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/StepScopeConfigurationTests.java @@ -18,6 +18,7 @@ import java.util.concurrent.Callable; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -39,7 +40,6 @@ import org.springframework.context.annotation.Scope; import org.springframework.context.annotation.ScopedProxyMode; import org.springframework.context.support.ClassPathXmlApplicationContext; -import org.springframework.lang.Nullable; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; @@ -331,9 +331,9 @@ protected SimpleHolder value(@Value("#{stepExecution.stepName}") final String va public static class TaskletSupport implements Tasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return RepeatStatus.FINISHED; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/support/DefaultJobLoaderTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/support/DefaultJobLoaderTests.java index 84f13be9eb..fb8c35d310 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/support/DefaultJobLoaderTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/support/DefaultJobLoaderTests.java @@ -23,6 +23,7 @@ import java.util.Collections; import java.util.Map; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.job.Job; import org.springframework.batch.core.job.JobExecution; @@ -36,7 +37,6 @@ import org.springframework.batch.core.step.StepLocator; import org.springframework.core.io.ByteArrayResource; import org.springframework.core.io.ClassPathResource; -import org.springframework.lang.Nullable; import org.springframework.test.util.ReflectionTestUtils; /** @@ -211,9 +211,8 @@ public static class BasicStubJob implements Job { public void execute(JobExecution execution) { } - @Nullable @Override - public JobParametersIncrementer getJobParametersIncrementer() { + public @Nullable JobParametersIncrementer getJobParametersIncrementer() { return null; } @@ -228,7 +227,7 @@ public boolean isRestartable() { } @Override - public JobParametersValidator getJobParametersValidator() { + public @Nullable JobParametersValidator getJobParametersValidator() { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DecisionJobParserTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DecisionJobParserTests.java index e06c0d9b41..e66e5d3116 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DecisionJobParserTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DecisionJobParserTests.java @@ -18,6 +18,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.job.Job; @@ -29,7 +30,6 @@ import org.springframework.batch.core.repository.JobRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; /** diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DefaultUnknownJobParserTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DefaultUnknownJobParserTests.java index c768f78760..283d23220d 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DefaultUnknownJobParserTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DefaultUnknownJobParserTests.java @@ -17,13 +17,13 @@ import static org.junit.jupiter.api.Assertions.assertEquals; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; /** @@ -57,9 +57,8 @@ void testDefaultUnknown() throws Exception { public static class UnknownListener implements StepExecutionListener { - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { stepExecution.setStatus(BatchStatus.UNKNOWN); return ExitStatus.UNKNOWN; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyCompletionPolicy.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyCompletionPolicy.java index 34035195a9..e86668d2c5 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyCompletionPolicy.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyCompletionPolicy.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.repeat.CompletionPolicy; import org.springframework.batch.repeat.RepeatContext; import org.springframework.batch.repeat.RepeatStatus; @@ -36,7 +38,7 @@ public boolean isComplete(RepeatContext context) { } @Override - public RepeatContext start(RepeatContext parent) { + public @Nullable RepeatContext start(RepeatContext parent) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemHandlerAdapter.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemHandlerAdapter.java index 34f8ad2ea1..52c5098745 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemHandlerAdapter.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemHandlerAdapter.java @@ -15,17 +15,19 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + /** * @author Dan Garrette * @since 2.1 */ public class DummyItemHandlerAdapter { - public Object dummyRead() { + public @Nullable Object dummyRead() { return null; } - public Object dummyProcess(Object o) { + public @Nullable Object dummyProcess(Object o) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemProcessor.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemProcessor.java index faf7d12b43..b1f076021a 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemProcessor.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemProcessor.java @@ -15,8 +15,9 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -24,9 +25,8 @@ */ public class DummyItemProcessor implements ItemProcessor { - @Nullable @Override - public Object process(Object item) throws Exception { + public @Nullable Object process(Object item) throws Exception { return item; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemReader.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemReader.java index 2db54248c1..5427279d13 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemReader.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyItemReader.java @@ -15,10 +15,11 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ParseException; import org.springframework.batch.item.UnexpectedInputException; -import org.springframework.lang.Nullable; /** * @author Dan Garrette @@ -26,9 +27,8 @@ */ public class DummyItemReader implements ItemReader { - @Nullable @Override - public Object read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable Object read() throws Exception, UnexpectedInputException, ParseException { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyJobRepository.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyJobRepository.java index a79f2af2c9..2b135640ba 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyJobRepository.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyJobRepository.java @@ -18,6 +18,8 @@ import java.util.Collection; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.step.StepExecution; @@ -26,7 +28,6 @@ import org.springframework.batch.core.repository.JobRepository; import org.springframework.batch.core.repository.JobRestartException; import org.springframework.beans.factory.BeanNameAware; -import org.springframework.lang.Nullable; /** * @author Dan Garrette @@ -53,26 +54,23 @@ public void add(StepExecution stepExecution) { } @Override - public JobExecution createJobExecution(String jobName, JobParameters jobParameters) + public @Nullable JobExecution createJobExecution(String jobName, JobParameters jobParameters) throws JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException { return null; } - @Nullable @Override - public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { return null; } - @Nullable @Override - public JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { + public @Nullable JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { return null; } - @Nullable @Override - public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + public @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { return null; } @@ -108,7 +106,7 @@ public void addAll(Collection stepExecutions) { } @Override - public JobInstance createJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance createJobInstance(String jobName, JobParameters jobParameters) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyPlatformTransactionManager.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyPlatformTransactionManager.java index f1b423c08d..a808595534 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyPlatformTransactionManager.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyPlatformTransactionManager.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.beans.factory.BeanNameAware; import org.springframework.transaction.PlatformTransactionManager; import org.springframework.transaction.TransactionDefinition; @@ -47,7 +49,7 @@ public void rollback(TransactionStatus status) throws TransactionException { } @Override - public TransactionStatus getTransaction(TransactionDefinition definition) throws TransactionException { + public @Nullable TransactionStatus getTransaction(TransactionDefinition definition) throws TransactionException { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyTasklet.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyTasklet.java index 4cfc78c19a..cae732e887 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyTasklet.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyTasklet.java @@ -15,11 +15,12 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * @author Dan Garrette @@ -27,9 +28,8 @@ */ public class DummyTasklet implements Tasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/FailingTasklet.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/FailingTasklet.java index 8c346f3a72..1de51b759c 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/FailingTasklet.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/FailingTasklet.java @@ -15,10 +15,11 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * This tasklet will call @@ -30,9 +31,8 @@ */ public class FailingTasklet extends NameStoringTasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { super.execute(contribution, chunkContext); throw new RuntimeException(); } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/FlowStepParserTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/FlowStepParserTests.java index 97a55e82cf..3dc7276494 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/FlowStepParserTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/FlowStepParserTests.java @@ -21,6 +21,7 @@ import java.util.ArrayList; import java.util.List; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.job.Job; @@ -32,7 +33,6 @@ import org.springframework.batch.core.repository.JobRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; /** diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/InterruptibleTasklet.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/InterruptibleTasklet.java index f25827d724..bb2b7a1831 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/InterruptibleTasklet.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/InterruptibleTasklet.java @@ -15,10 +15,11 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * This tasklet will call @@ -32,9 +33,8 @@ public class InterruptibleTasklet extends NameStoringTasklet { private volatile boolean started = false; - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { if (!started) { super.execute(contribution, chunkContext); started = true; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NameStoringTasklet.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NameStoringTasklet.java index aa30a73bac..8dd2a77475 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NameStoringTasklet.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NameStoringTasklet.java @@ -18,12 +18,13 @@ import java.util.List; import org.springframework.batch.core.step.StepContribution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * This class will store the step name when it is executed. @@ -43,9 +44,8 @@ public void beforeStep(StepExecution stepExecution) { stepName = stepExecution.getStepName(); } - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { if (stepNamesList != null) { stepNamesList.add(stepName); } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NextAttributeUnknownJobParserTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NextAttributeUnknownJobParserTests.java index d415a4183a..eb1ec423e4 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NextAttributeUnknownJobParserTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NextAttributeUnknownJobParserTests.java @@ -17,13 +17,13 @@ import static org.junit.jupiter.api.Assertions.assertEquals; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; /** @@ -57,9 +57,8 @@ void testDefaultUnknown() throws Exception { public static class UnknownListener implements StepExecutionListener { - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { stepExecution.setStatus(BatchStatus.UNKNOWN); return ExitStatus.UNKNOWN; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NoopTasklet.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NoopTasklet.java index 91821305ec..35dd429b16 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NoopTasklet.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/NoopTasklet.java @@ -15,17 +15,17 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; public class NoopTasklet extends NameStoringTasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { super.execute(contribution, chunkContext); contribution.setExitStatus(ExitStatus.NOOP); return RepeatStatus.FINISHED; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/PartitionStepWithFlowParserTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/PartitionStepWithFlowParserTests.java index 3cfddf378c..e160cf813e 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/PartitionStepWithFlowParserTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/PartitionStepWithFlowParserTests.java @@ -22,6 +22,7 @@ import java.util.Collections; import java.util.List; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; @@ -34,7 +35,6 @@ import org.springframework.batch.core.repository.JobRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; /** diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StepNameTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StepNameTests.java index 82550d788e..933ab7a5ef 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StepNameTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StepNameTests.java @@ -24,6 +24,7 @@ import java.util.List; import java.util.Map; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; @@ -35,13 +36,11 @@ import org.springframework.context.support.FileSystemXmlApplicationContext; import org.springframework.core.io.Resource; import org.springframework.core.io.support.ResourceArrayPropertyEditor; -import org.springframework.lang.Nullable; import org.springframework.util.ClassUtils; class StepNameTests { - @Nullable - private ApplicationContext getContextFromResource(Resource resource) throws IOException { + private @Nullable ApplicationContext getContextFromResource(Resource resource) throws IOException { try { return new FileSystemXmlApplicationContext("file:///" + resource.getFile().getAbsolutePath()); } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StopJobParserTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StopJobParserTests.java index 098468a562..19c62c2dbf 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StopJobParserTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StopJobParserTests.java @@ -18,6 +18,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertTrue; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.ExitStatus; @@ -25,7 +26,6 @@ import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.job.flow.FlowExecutionStatus; import org.springframework.batch.core.job.flow.JobExecutionDecider; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; /** diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestCustomStatusListener.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestCustomStatusListener.java index e5796f1525..e9d7d7ee36 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestCustomStatusListener.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestCustomStatusListener.java @@ -15,16 +15,16 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; -import org.springframework.lang.Nullable; public class TestCustomStatusListener extends AbstractTestComponent implements StepExecutionListener { - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { return new ExitStatus("FOO").and(stepExecution.getExitStatus()); } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestIncrementer.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestIncrementer.java index 4bcc6957ea..24858b209c 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestIncrementer.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestIncrementer.java @@ -15,14 +15,15 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.job.parameters.JobParametersIncrementer; -import org.springframework.lang.Nullable; public class TestIncrementer implements JobParametersIncrementer { @Override - public JobParameters getNext(@Nullable JobParameters parameters) { + public @Nullable JobParameters getNext(@Nullable JobParameters parameters) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestListener.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestListener.java index c5489a053a..77dc1d8f0f 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestListener.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestListener.java @@ -15,17 +15,17 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; import org.springframework.batch.core.annotation.AfterRead; -import org.springframework.lang.Nullable; public class TestListener extends AbstractTestComponent implements StepExecutionListener { - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestProcessor.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestProcessor.java index 99838e6b0f..0d354a49ce 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestProcessor.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestProcessor.java @@ -15,14 +15,14 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; public class TestProcessor extends AbstractTestComponent implements ItemProcessor { - @Nullable @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { executed = true; return item; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestReader.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestReader.java index 77c5047745..0589994064 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestReader.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestReader.java @@ -19,10 +19,11 @@ import java.util.Collections; import java.util.List; import org.springframework.batch.item.ExecutionContext; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ItemStreamReader; import org.springframework.batch.item.ParseException; import org.springframework.batch.item.UnexpectedInputException; -import org.springframework.lang.Nullable; public class TestReader extends AbstractTestComponent implements ItemStreamReader { @@ -45,9 +46,8 @@ public void setOpened(boolean opened) { this.opened = opened; } - @Nullable @Override - public String read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable String read() throws Exception, UnexpectedInputException, ParseException { executed = true; synchronized (items) { if (items.size() > 0) { diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestTasklet.java b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestTasklet.java index 4b123fe2ba..4818a89e40 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestTasklet.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/TestTasklet.java @@ -15,19 +15,19 @@ */ package org.springframework.batch.core.configuration.xml; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; public class TestTasklet extends AbstractTestComponent implements Tasklet { private String name; - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { executed = true; return RepeatStatus.FINISHED; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/converter/JobParametersConverterSupport.java b/spring-batch-core/src/test/java/org/springframework/batch/core/converter/JobParametersConverterSupport.java index 6038ef378f..6bf7a1003c 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/converter/JobParametersConverterSupport.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/converter/JobParametersConverterSupport.java @@ -19,9 +19,10 @@ import java.util.Properties; import org.springframework.batch.core.job.parameters.JobParameter; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.job.parameters.JobParametersBuilder; -import org.springframework.lang.Nullable; public class JobParametersConverterSupport implements JobParametersConverter { diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/job/ExtendedAbstractJobTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/job/ExtendedAbstractJobTests.java index cbcdc661bd..60ee1cbc42 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/job/ExtendedAbstractJobTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/job/ExtendedAbstractJobTests.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.core.job; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; @@ -29,7 +30,6 @@ import org.springframework.jdbc.support.JdbcTransactionManager; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; -import org.springframework.lang.Nullable; import java.time.LocalDateTime; import java.util.Collection; @@ -214,7 +214,7 @@ protected void doExecute(JobExecution execution) throws JobExecutionException { } @Override - public Step getStep(String stepName) { + public @Nullable Step getStep(String stepName) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/job/builder/FlowJobBuilderTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/job/builder/FlowJobBuilderTests.java index 1c24477e31..85c43d6992 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/job/builder/FlowJobBuilderTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/job/builder/FlowJobBuilderTests.java @@ -23,6 +23,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -60,7 +61,6 @@ import org.springframework.jdbc.support.JdbcTransactionManager; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; -import org.springframework.lang.Nullable; import org.springframework.transaction.PlatformTransactionManager; /** diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/job/flow/support/JobFlowExecutorSupport.java b/spring-batch-core/src/test/java/org/springframework/batch/core/job/flow/support/JobFlowExecutorSupport.java index 2d0d955fbd..afebb34b16 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/job/flow/support/JobFlowExecutorSupport.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/job/flow/support/JobFlowExecutorSupport.java @@ -15,6 +15,8 @@ */ package org.springframework.batch.core.job.flow.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.JobInterruptedException; @@ -25,7 +27,6 @@ import org.springframework.batch.core.job.flow.FlowExecutionStatus; import org.springframework.batch.core.job.flow.FlowExecutor; import org.springframework.batch.core.repository.JobRestartException; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -40,13 +41,12 @@ public String executeStep(Step step) } @Override - public JobExecution getJobExecution() { + public @Nullable JobExecution getJobExecution() { return null; } - @Nullable @Override - public StepExecution getStepExecution() { + public @Nullable StepExecution getStepExecution() { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/CommandLineJobRunnerTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/CommandLineJobRunnerTests.java index d1eb434ba8..4076930c91 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/CommandLineJobRunnerTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/CommandLineJobRunnerTests.java @@ -25,6 +25,7 @@ import java.util.Properties; import java.util.Set; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Disabled; @@ -47,7 +48,6 @@ import org.springframework.batch.core.step.JobRepositorySupport; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.lang.Nullable; import org.springframework.util.ClassUtils; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -469,9 +469,8 @@ public Set findRunningJobExecutions(@Nullable String jobName) { return new HashSet<>(); } - @Nullable @Override - public JobExecution getJobExecution(@Nullable Long executionId) { + public @Nullable JobExecution getJobExecution(@Nullable Long executionId) { if (jobExecution != null) { return jobExecution; } @@ -479,7 +478,7 @@ public JobExecution getJobExecution(@Nullable Long executionId) { } @Override - public List getJobExecutions(JobInstance jobInstance) { + public @Nullable List getJobExecutions(JobInstance jobInstance) { if (jobInstance.getId() == 0) { return List.of(createJobExecution(jobInstance, BatchStatus.FAILED)); } @@ -512,27 +511,23 @@ private JobExecution createJobExecution(JobInstance jobInstance, BatchStatus sta return jobExecution; } - @Nullable @Override - public JobInstance getJobInstance(@Nullable Long instanceId) { + public @Nullable JobInstance getJobInstance(@Nullable Long instanceId) { throw new UnsupportedOperationException(); } - @Nullable @Override - public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { throw new UnsupportedOperationException(); } - @Nullable @Override - public JobInstance getLastJobInstance(String jobName) { + public @Nullable JobInstance getLastJobInstance(String jobName) { return null; } - @Nullable @Override - public JobExecution getLastJobExecution(JobInstance jobInstance) { + public @Nullable JobExecution getLastJobExecution(JobInstance jobInstance) { return null; } @@ -546,9 +541,8 @@ public List getJobInstances(String jobName, int start, int count) { return result; } - @Nullable @Override - public StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable Long stepExecutionId) { + public @Nullable StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable Long stepExecutionId) { throw new UnsupportedOperationException(); } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/TaskExecutorJobOperatorTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/TaskExecutorJobOperatorTests.java index a35e5ea63e..e43b455bcb 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/TaskExecutorJobOperatorTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/TaskExecutorJobOperatorTests.java @@ -24,6 +24,7 @@ import java.util.Properties; import java.util.Set; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -53,7 +54,6 @@ import org.springframework.batch.core.step.tasklet.TaskletStep; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.batch.support.PropertiesConverter; -import org.springframework.lang.Nullable; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; @@ -92,9 +92,9 @@ void setUp() throws Exception { jobParametersConverter = new DefaultJobParametersConverter(); job = new JobSupport("foo") { - @Nullable + @Override - public JobParametersIncrementer getJobParametersIncrementer() { + public @Nullable JobParametersIncrementer getJobParametersIncrementer() { return parameters -> jobParameters; } }; @@ -379,9 +379,9 @@ void testStopTaskletException() throws Exception { JobExecution jobExecution = new JobExecution(jobInstance, 111L, jobParameters); StoppableTasklet tasklet = new StoppableTasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/TestJobParametersIncrementer.java b/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/TestJobParametersIncrementer.java index 8119ae249f..3b41685846 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/TestJobParametersIncrementer.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/TestJobParametersIncrementer.java @@ -15,10 +15,11 @@ */ package org.springframework.batch.core.launch.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.job.parameters.JobParametersBuilder; import org.springframework.batch.core.job.parameters.JobParametersIncrementer; -import org.springframework.lang.Nullable; public class TestJobParametersIncrementer implements JobParametersIncrementer { diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/CompositeStepExecutionListenerTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/CompositeStepExecutionListenerTests.java index d8c9ce4aca..bf1fda5d73 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/CompositeStepExecutionListenerTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/CompositeStepExecutionListenerTests.java @@ -18,11 +18,11 @@ import java.util.ArrayList; import java.util.List; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.step.StepExecution; -import org.springframework.lang.Nullable; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -42,17 +42,17 @@ void testSetListeners() { JobExecution jobExecution = new JobExecution(1L); StepExecution stepExecution = new StepExecution("s1", jobExecution); listener.setListeners(new StepExecutionListener[] { new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { assertEquals(ExitStatus.STOPPED, stepExecution.getExitStatus()); list.add("fail"); return ExitStatus.FAILED; } }, new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { list.add("continue"); return ExitStatus.STOPPED; } @@ -66,9 +66,9 @@ void testSetListener() { JobExecution jobExecution = new JobExecution(1L); StepExecution stepExecution = new StepExecution("s1", jobExecution); listener.register(new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { list.add("fail"); return ExitStatus.FAILED; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/ItemListenerErrorTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/ItemListenerErrorTests.java index 231f9f22a4..1176727db2 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/ItemListenerErrorTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/ItemListenerErrorTests.java @@ -22,6 +22,7 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -47,7 +48,6 @@ import org.springframework.context.annotation.Configuration; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; import org.springframework.jdbc.support.JdbcTransactionManager; -import org.springframework.lang.Nullable; import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import org.springframework.transaction.PlatformTransactionManager; @@ -208,9 +208,8 @@ public static class FailingItemProcessor implements ItemProcessor { private int count = 0; - @Nullable @Override - public String read() throws Exception { + public @Nullable String read() throws Exception { count++; if (goingToFail) { throw new RuntimeException("failure in the reader"); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/MulticasterBatchListenerTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/MulticasterBatchListenerTests.java index e45d29eb58..6677153a05 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/MulticasterBatchListenerTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/MulticasterBatchListenerTests.java @@ -21,6 +21,7 @@ import java.util.Arrays; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.core.ExitStatus; @@ -36,7 +37,6 @@ import org.springframework.batch.core.annotation.BeforeWrite; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.item.Chunk; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -61,9 +61,9 @@ void testSetListeners() { JobExecution jobExecution = new JobExecution(1L); StepExecution stepExecution = new StepExecution("s1", jobExecution); multicast.setListeners(Arrays.asList(new StepListenerSupport() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { count++; return super.afterStep(stepExecution); } @@ -83,9 +83,9 @@ void testRegister() { JobExecution jobExecution = new JobExecution(1L); StepExecution stepExecution = new StepExecution("s1", jobExecution); multicast.register(new StepListenerSupport() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { count++; return super.afterStep(stepExecution); } @@ -628,9 +628,8 @@ public void afterRead(Integer item) { super.afterRead(item); } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { count++; if (error) { throw new RuntimeException("listener error"); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/StepListenerFactoryBeanTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/StepListenerFactoryBeanTests.java index c09240e96c..719ae2ba06 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/StepListenerFactoryBeanTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/StepListenerFactoryBeanTests.java @@ -21,6 +21,7 @@ import javax.sql.DataSource; import org.aopalliance.intercept.MethodInterceptor; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.aop.framework.ProxyFactory; @@ -46,7 +47,6 @@ import org.springframework.batch.item.Chunk; import org.springframework.beans.factory.InitializingBean; import org.springframework.core.Ordered; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -361,10 +361,9 @@ private static class MultipleAfterStep implements StepExecutionListener { int callcount = 0; - @Nullable @Override @AfterStep - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { Assert.notNull(stepExecution, "A stepExecution is required"); callcount++; return null; @@ -382,9 +381,8 @@ private static class ThreeStepExecutionListener implements StepExecutionListener int callcount = 0; - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { Assert.notNull(stepExecution, "A stepExecution is required"); callcount++; return null; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/StepListenerMethodInterceptorTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/StepListenerMethodInterceptorTests.java index 07b9477056..f09bd03e1a 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/listener/StepListenerMethodInterceptorTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/listener/StepListenerMethodInterceptorTests.java @@ -25,6 +25,7 @@ import java.util.Set; import org.aopalliance.intercept.MethodInvocation; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.support.MethodInvoker; @@ -124,22 +125,22 @@ public Method getMethod() { } @Override - public Object[] getArguments() { + public @Nullable Object[] getArguments() { return null; } @Override - public AccessibleObject getStaticPart() { + public @Nullable AccessibleObject getStaticPart() { return null; } @Override - public Object getThis() { + public @Nullable Object getThis() { return null; } @Override - public Object proceed() throws Throwable { + public @Nullable Object proceed() throws Throwable { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/partition/ExampleItemReader.java b/spring-batch-core/src/test/java/org/springframework/batch/core/partition/ExampleItemReader.java index 348d1e77e5..da112968a3 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/partition/ExampleItemReader.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/partition/ExampleItemReader.java @@ -17,11 +17,12 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemStreamException; import org.springframework.batch.item.ItemStreamReader; import org.springframework.batch.item.support.AbstractItemStreamItemReader; -import org.springframework.lang.Nullable; import org.springframework.util.ClassUtils; /** @@ -62,9 +63,8 @@ public void setMax(int max) { /** * Reads next record from input */ - @Nullable @Override - public String read() throws Exception { + public @Nullable String read() throws Exception { if (index >= input.length || index >= max) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/repository/dao/OptimisticLockingFailureTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/repository/dao/OptimisticLockingFailureTests.java index e9d562f4b6..286a59259e 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/repository/dao/OptimisticLockingFailureTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/repository/dao/OptimisticLockingFailureTests.java @@ -19,6 +19,7 @@ import java.util.EnumSet; import java.util.Set; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; @@ -37,7 +38,6 @@ import org.springframework.batch.repeat.RepeatStatus; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; -import org.springframework.lang.Nullable; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -115,9 +115,9 @@ public void write(Chunk items) throws Exception { public static class SleepingTasklet implements Tasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { Thread.sleep(2000L); return RepeatStatus.FINISHED; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/repository/dao/TablePrefixTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/repository/dao/TablePrefixTests.java index 20618c2c08..4aa21c6636 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/repository/dao/TablePrefixTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/repository/dao/TablePrefixTests.java @@ -19,6 +19,7 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.job.Job; @@ -31,7 +32,6 @@ import org.springframework.batch.repeat.RepeatStatus; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.jdbc.core.JdbcTemplate; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import org.springframework.test.jdbc.JdbcTestUtils; @@ -60,9 +60,9 @@ void testJobLaunch() throws Exception { static class TestTasklet implements Tasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return RepeatStatus.FINISHED; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBeanTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBeanTests.java index 4963d7db21..1f0306a108 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBeanTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBeanTests.java @@ -22,6 +22,8 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; +import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -373,7 +375,7 @@ public long nextLongValue() throws DataAccessException { } @Override - public String nextStringValue() throws DataAccessException { + public @Nullable String nextStringValue() throws DataAccessException { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/scope/TestJob.java b/spring-batch-core/src/test/java/org/springframework/batch/core/scope/TestJob.java index aadec6567a..45808f59c9 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/scope/TestJob.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/scope/TestJob.java @@ -15,13 +15,14 @@ */ package org.springframework.batch.core.scope; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.Job; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.job.parameters.JobParametersIncrementer; import org.springframework.batch.core.job.parameters.JobParametersValidator; import org.springframework.batch.core.scope.context.JobContext; import org.springframework.batch.core.scope.context.JobSynchronizationManager; -import org.springframework.lang.Nullable; public class TestJob implements Job { @@ -70,14 +71,13 @@ public boolean isRestartable() { return false; } - @Nullable @Override - public JobParametersIncrementer getJobParametersIncrementer() { + public @Nullable JobParametersIncrementer getJobParametersIncrementer() { return null; } @Override - public JobParametersValidator getJobParametersValidator() { + public @Nullable JobParametersValidator getJobParametersValidator() { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/JobRepositorySupport.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/JobRepositorySupport.java index a22dee0969..cc623ee862 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/JobRepositorySupport.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/JobRepositorySupport.java @@ -18,10 +18,11 @@ import java.util.Collection; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.repository.JobRepository; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -41,15 +42,13 @@ public JobExecution createJobExecution(String jobName, JobParameters jobParamete public void update(JobExecution jobExecution) { } - @Nullable @Override - public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { return null; } - @Nullable @Override - public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + public @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { return null; } @@ -76,9 +75,8 @@ public boolean isJobInstanceExists(String jobName, JobParameters jobParameters) return false; } - @Nullable @Override - public JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { + public @Nullable JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { return null; } @@ -91,7 +89,7 @@ public void addAll(Collection stepExecutions) { } @Override - public JobInstance createJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance createJobInstance(String jobName, JobParameters jobParameters) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/NonAbstractStepTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/NonAbstractStepTests.java index 672bc95e61..d4c72dd81c 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/NonAbstractStepTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/NonAbstractStepTests.java @@ -24,6 +24,7 @@ import io.micrometer.core.instrument.observation.DefaultMeterObservationHandler; import io.micrometer.core.tck.MeterRegistryAssert; import io.micrometer.observation.ObservationRegistry; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -36,7 +37,6 @@ import org.springframework.batch.core.listener.StepExecutionListener; import org.springframework.batch.core.observability.BatchStepObservation; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -110,9 +110,8 @@ private String getEvent(String event) { return name + "#" + event; } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { assertSame(execution, stepExecution); events.add(getEvent("afterStep(" + stepExecution.getExitStatus().getExitCode() + ")")); stepExecution.getExecutionContext().putString("afterStep", "afterStep"); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/RestartInPriorStepTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/RestartInPriorStepTests.java index 77cb0938d3..76c49051bc 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/RestartInPriorStepTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/RestartInPriorStepTests.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.core.step; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; @@ -29,7 +30,6 @@ import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import java.util.Map; @@ -67,9 +67,9 @@ void test() throws Exception { public static class DecidingTasklet implements Tasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { Map context = chunkContext.getStepContext().getJobExecutionContext(); if (context.get("restart") != null) { diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/RestartLoopTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/RestartLoopTests.java index feb51018e2..55f776fc86 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/RestartLoopTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/RestartLoopTests.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.core.step; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.job.Job; @@ -25,7 +26,6 @@ import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -57,9 +57,9 @@ void test() throws Exception { public static class DefaultTasklet implements Tasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return RepeatStatus.FINISHED; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/StepLocatorStepFactoryBeanTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/StepLocatorStepFactoryBeanTests.java index db1a99fe3b..39651d67a4 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/StepLocatorStepFactoryBeanTests.java +++ b/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() { diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/builder/RegisterMultiListenerTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/builder/RegisterMultiListenerTests.java index 496c1cf2f7..13dfa764ab 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/builder/RegisterMultiListenerTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/builder/RegisterMultiListenerTests.java @@ -17,6 +17,7 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Test; @@ -53,7 +54,6 @@ import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType; import org.springframework.jdbc.support.JdbcTransactionManager; -import org.springframework.lang.Nullable; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -148,9 +148,8 @@ public ItemReader reader() { private int count = 0; - @Nullable @Override - public String read() + public @Nullable String read() throws Exception, UnexpectedInputException, ParseException, NonTransientResourceException { count++; @@ -313,9 +312,8 @@ public void beforeStep(StepExecution stepExecution) { callChecker.beforeStepCalled++; } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/builder/StepBuilderTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/builder/StepBuilderTests.java index 123333e587..4aa2ebb1d5 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/builder/StepBuilderTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/builder/StepBuilderTests.java @@ -19,6 +19,7 @@ import java.util.List; import java.util.function.UnaryOperator; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -56,7 +57,6 @@ import org.springframework.jdbc.support.JdbcTransactionManager; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; -import org.springframework.lang.Nullable; import org.springframework.transaction.PlatformTransactionManager; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -321,9 +321,8 @@ public void beforeStep(StepExecution stepExecution) { beforeStepCount++; } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { afterStepCount++; return stepExecution.getExitStatus(); } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ChunkMonitorTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ChunkMonitorTests.java index 9dcf12e679..fe9daf3c41 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ChunkMonitorTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ChunkMonitorTests.java @@ -19,6 +19,7 @@ import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.item.ExecutionContext; @@ -27,7 +28,6 @@ import org.springframework.batch.item.ItemStreamSupport; import org.springframework.batch.item.ParseException; import org.springframework.batch.item.UnexpectedInputException; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -47,9 +47,9 @@ class ChunkMonitorTests { @BeforeEach void setUp() { monitor.setItemReader(new ItemReader() { - @Nullable + @Override - public String read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable String read() throws Exception, UnexpectedInputException, ParseException { return String.valueOf(count++); } }); @@ -113,9 +113,9 @@ void testOpenWithNullReader() { @Test void testOpenWithErrorInReader() { monitor.setItemReader(new ItemReader() { - @Nullable + @Override - public String read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable String read() throws Exception, UnexpectedInputException, ParseException { throw new IllegalStateException("Expected"); } }); @@ -148,9 +148,9 @@ void testUpdateVanilla() { void testUpdateWithNoStream() { monitor = new ChunkMonitor(); monitor.setItemReader(new ItemReader() { - @Nullable + @Override - public String read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable String read() throws Exception, UnexpectedInputException, ParseException { return String.valueOf(count++); } }); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ExceptionThrowingTaskletStub.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ExceptionThrowingTaskletStub.java index c28242853c..db035c4faa 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ExceptionThrowingTaskletStub.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ExceptionThrowingTaskletStub.java @@ -20,12 +20,13 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.batch.support.transaction.TransactionAwareProxyFactory; -import org.springframework.lang.Nullable; /** * @author Dan Garrette @@ -58,9 +59,8 @@ public void clear() { committed.clear(); } - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { committed.add(1); if (committed.size() >= maxTries) { return RepeatStatus.FINISHED; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantChunkProcessorTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantChunkProcessorTests.java index da90e2021b..86bf118433 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantChunkProcessorTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantChunkProcessorTests.java @@ -27,6 +27,7 @@ import java.util.List; import java.util.Set; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -43,7 +44,6 @@ import org.springframework.batch.item.support.PassThroughItemProcessor; import org.springframework.classify.BinaryExceptionClassifier; import org.springframework.dao.DataIntegrityViolationException; -import org.springframework.lang.Nullable; import org.springframework.retry.RetryException; import org.springframework.retry.policy.NeverRetryPolicy; import org.springframework.retry.policy.SimpleRetryPolicy; @@ -86,9 +86,9 @@ void testWrite() throws Exception { @Test void testTransform() throws Exception { processor.setItemProcessor(new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { return item.equals("1") ? null : item; } }); @@ -112,9 +112,9 @@ void testTransformChunkEnd() throws Exception { void testFilterCountOnSkip() throws Exception { processor.setProcessSkipPolicy(new AlwaysSkipItemSkipPolicy()); processor.setItemProcessor(new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { if (item.equals("1")) { throw new RuntimeException("Skippable"); } @@ -138,9 +138,9 @@ public String process(String item) throws Exception { void testFilterCountOnSkipInWriteWithoutRetry() throws Exception { processor.setWriteSkipPolicy(new AlwaysSkipItemSkipPolicy()); processor.setItemProcessor(new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { if (item.equals("1")) { return null; } @@ -169,9 +169,9 @@ void testFilterCountOnSkipInWriteWithRetry() throws Exception { batchRetryTemplate.setRetryPolicy(retryPolicy); processor.setWriteSkipPolicy(new AlwaysSkipItemSkipPolicy()); processor.setItemProcessor(new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { if (item.equals("1")) { return null; } @@ -273,9 +273,9 @@ void testWriteSkipOnExceptionWithTrivialChunk() throws Exception { @Test void testTransformWithExceptionAndNoRollback() throws Exception { processor.setItemProcessor(new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { if (item.equals("1")) { throw new DataIntegrityViolationException("Planned"); } @@ -487,9 +487,9 @@ void testProcessFilterAndSkippableException() throws Exception { processor.setProcessorTransactional(false); processor.setProcessSkipPolicy(new AlwaysSkipItemSkipPolicy()); processor.setItemProcessor(new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { processedItems.add(item); if (item.contains("fail")) { throw new IllegalArgumentException("Expected Skippable Exception!"); @@ -523,9 +523,9 @@ void testProcessFilterAndSkippableExceptionNoRollback() throws Exception { processor.setProcessorTransactional(false); processor.setProcessSkipPolicy(new AlwaysSkipItemSkipPolicy()); processor.setItemProcessor(new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { processedItems.add(item); if (item.contains("fail")) { throw new IllegalArgumentException("Expected Skippable Exception!"); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantStepFactoryBeanRetryTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantStepFactoryBeanRetryTests.java index 823b79e30d..d920917cde 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantStepFactoryBeanRetryTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantStepFactoryBeanRetryTests.java @@ -25,6 +25,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -53,7 +54,6 @@ import org.springframework.jdbc.support.JdbcTransactionManager; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; -import org.springframework.lang.Nullable; import org.springframework.retry.policy.MapRetryContextCache; import org.springframework.retry.policy.SimpleRetryPolicy; import org.springframework.transaction.support.TransactionSynchronizationManager; @@ -160,9 +160,9 @@ void testProcessAllItemsWhenErrorInWriterTransformationWhenReaderTransactional() }; ItemProcessor processor = new ItemProcessor<>() { - @Nullable + @Override - public Integer process(String item) throws Exception { + public @Nullable Integer process(String item) throws Exception { processed.add(item); return Integer.parseInt(item); } @@ -207,9 +207,9 @@ void testProcessAllItemsWhenErrorInWriter() throws Exception { }; ItemProcessor processor = new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { processed.add(item); return item; } @@ -250,9 +250,9 @@ void testNoItemsReprocessedWhenErrorInWriterAndProcessorNotTransactional() throw }; ItemProcessor processor = new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { processed.add(item); return item; } @@ -282,9 +282,9 @@ public String process(String item) throws Exception { @Test void testSuccessfulRetryWithReadFailure() throws Exception { ItemReader provider = new ListItemReader<>(Arrays.asList("a", "b", "c")) { - @Nullable + @Override - public String read() { + public @Nullable String read() { String item = super.read(); provided.add(item); count++; @@ -334,9 +334,8 @@ protected void doOpen() throws Exception { reader = new ListItemReader<>(Arrays.asList("a", "b", "c", "d", "e", "f")); } - @Nullable @Override - protected String doRead() throws Exception { + protected @Nullable String doRead() throws Exception { return reader.read(); } @@ -380,9 +379,9 @@ void testSkipAndRetry() throws Exception { factory.setSkipLimit(2); ItemReader provider = new ListItemReader<>(Arrays.asList("a", "b", "c", "d", "e", "f")) { - @Nullable + @Override - public String read() { + public @Nullable String read() { String item = super.read(); count++; if ("b".equals(item) || "d".equals(item)) { @@ -418,9 +417,9 @@ public void onSkipInWrite(String item, Throwable t) { } }); factory.setSkipLimit(2); ItemReader provider = new ListItemReader<>(Arrays.asList("a", "b", "c", "d", "e", "f")) { - @Nullable + @Override - public String read() { + public @Nullable String read() { String item = super.read(); logger.debug("Read Called! Item: [" + item + "]"); provided.add(item); @@ -473,9 +472,9 @@ public void onSkipInWrite(String item, Throwable t) { } }); factory.setSkipLimit(2); ItemReader provider = new ListItemReader<>(Arrays.asList("a", "b", "c", "d", "e", "f")) { - @Nullable + @Override - public String read() { + public @Nullable String read() { String item = super.read(); logger.debug("Read Called! Item: [" + item + "]"); provided.add(item); @@ -524,9 +523,9 @@ void testRetryWithNoSkip() throws Exception { factory.setRetryLimit(4); factory.setSkipLimit(0); ItemReader provider = new ListItemReader<>(Arrays.asList("b")) { - @Nullable + @Override - public String read() { + public @Nullable String read() { String item = super.read(); provided.add(item); count++; @@ -573,9 +572,9 @@ void testNonSkippableException() throws Exception { factory.setSkipLimit(1); ItemReader provider = new ListItemReader<>(Arrays.asList("b")) { - @Nullable + @Override - public String read() { + public @Nullable String read() { String item = super.read(); provided.add(item); count++; @@ -617,9 +616,9 @@ void testRetryPolicy() throws Exception { Collections., Boolean>singletonMap(Exception.class, true))); factory.setSkipLimit(0); ItemReader provider = new ListItemReader<>(Arrays.asList("b")) { - @Nullable + @Override - public String read() { + public @Nullable String read() { String item = super.read(); provided.add(item); count++; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantStepFactoryBeanTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantStepFactoryBeanTests.java index 6a017c8461..1aff6cc0f2 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantStepFactoryBeanTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantStepFactoryBeanTests.java @@ -26,6 +26,7 @@ import org.aopalliance.intercept.MethodInterceptor; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -66,7 +67,6 @@ import org.springframework.jdbc.support.JdbcTransactionManager; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; -import org.springframework.lang.Nullable; import org.springframework.test.util.ReflectionTestUtils; import org.springframework.util.StringUtils; @@ -862,9 +862,8 @@ public void open(ExecutionContext executionContext) { opened = true; } - @Nullable @Override - public String read() { + public @Nullable String read() { return null; } }; @@ -901,9 +900,8 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { public void update(ExecutionContext executionContext) throws ItemStreamException { } - @Nullable @Override - public String read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable String read() throws Exception, UnexpectedInputException, ParseException { return null; } }; @@ -923,9 +921,8 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { public void update(ExecutionContext executionContext) throws ItemStreamException { } - @Nullable @Override - public String read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable String read() throws Exception, UnexpectedInputException, ParseException { return null; } }; @@ -965,9 +962,8 @@ public void open(ExecutionContext executionContext) throws ItemStreamException { public void update(ExecutionContext executionContext) throws ItemStreamException { } - @Nullable @Override - public String read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable String read() throws Exception, UnexpectedInputException, ParseException { return null; } }; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SimpleChunkProcessorTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SimpleChunkProcessorTests.java index 1ce79fa40d..1c5163ac36 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SimpleChunkProcessorTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SimpleChunkProcessorTests.java @@ -22,6 +22,7 @@ import java.util.Arrays; import java.util.List; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.core.job.JobExecution; @@ -32,14 +33,13 @@ import org.springframework.batch.item.Chunk; import org.springframework.batch.item.ItemProcessor; import org.springframework.batch.item.ItemWriter; -import org.springframework.lang.Nullable; class SimpleChunkProcessorTests { private final SimpleChunkProcessor processor = new SimpleChunkProcessor<>(new ItemProcessor<>() { - @Nullable + @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { if (item.equals("err")) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SimpleStepFactoryBeanTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SimpleStepFactoryBeanTests.java index 4925db24d8..12f23597c7 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SimpleStepFactoryBeanTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SimpleStepFactoryBeanTests.java @@ -26,6 +26,7 @@ import java.util.Collections; import java.util.List; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; @@ -56,7 +57,6 @@ import org.springframework.jdbc.support.JdbcTransactionManager; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; -import org.springframework.lang.Nullable; /** * Tests for {@link SimpleStepFactoryBean}. @@ -432,9 +432,8 @@ class TestItemListenerWriter public void write(Chunk items) throws Exception { } - @Nullable @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { return item; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SkipProcessorStub.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SkipProcessorStub.java index d24f806d10..7e2021ded4 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SkipProcessorStub.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SkipProcessorStub.java @@ -19,8 +19,9 @@ import java.util.List; import org.springframework.batch.item.ItemProcessor; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.support.transaction.TransactionAwareProxyFactory; -import org.springframework.lang.Nullable; /** * @author Dan Garrette @@ -57,9 +58,8 @@ public void clear() { filter = false; } - @Nullable @Override - public T process(T item) throws Exception { + public @Nullable T process(T item) throws Exception { processed.add(item); committed.add(item); try { diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SkipReaderStub.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SkipReaderStub.java index cfc00ac7e7..60b949317e 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SkipReaderStub.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/SkipReaderStub.java @@ -19,9 +19,10 @@ import java.util.List; import org.springframework.batch.item.ItemReader; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.ParseException; import org.springframework.batch.item.UnexpectedInputException; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -62,9 +63,8 @@ public void clear() { read.clear(); } - @Nullable @Override - public T read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable T read() throws Exception, UnexpectedInputException, ParseException { counter++; if (counter >= items.length) { return null; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/TaskletStepExceptionTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/TaskletStepExceptionTests.java index ecef7d0f2b..6b91c1190c 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/TaskletStepExceptionTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/item/TaskletStepExceptionTests.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.core.step.item; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.core.ExitStatus; @@ -39,7 +40,6 @@ import org.springframework.batch.item.ItemStreamSupport; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.batch.support.transaction.ResourcelessTransactionManager; -import org.springframework.lang.Nullable; import org.springframework.transaction.TransactionException; import org.springframework.transaction.UnexpectedRollbackException; import org.springframework.transaction.support.DefaultTransactionStatus; @@ -108,9 +108,10 @@ void testInterrupted() throws Exception { @Test void testInterruptedWithCustomStatus() throws Exception { taskletStep.setTasklet(new Tasklet() { - @Nullable + @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { contribution.setExitStatus(new ExitStatus("FUNNY")); throw new JobInterruptedException("Planned"); } @@ -157,17 +158,17 @@ void testAfterStepFailureWhenTaskletSucceeds() throws Exception { final RuntimeException exception = new RuntimeException(); taskletStep.setStepExecutionListeners(new StepExecutionListener[] { new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { throw exception; } } }); taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { return RepeatStatus.FINISHED; } @@ -186,9 +187,9 @@ void testAfterStepFailureWhenTaskletFails() throws Exception { final RuntimeException exception = new RuntimeException(); taskletStep.setStepExecutionListeners(new StepExecutionListener[] { new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { throw exception; } } }); @@ -235,9 +236,9 @@ protected void doRollback(DefaultTransactionStatus status) throws TransactionExc taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { attributes.getStepContext().getStepExecution().getExecutionContext().putString("foo", "bar"); return RepeatStatus.FINISHED; } @@ -270,9 +271,9 @@ protected void doCommit(DefaultTransactionStatus status) throws TransactionExcep taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { attributes.getStepContext().getStepExecution().getExecutionContext().putString("foo", "bar"); return RepeatStatus.FINISHED; } @@ -297,9 +298,9 @@ void testRepositoryErrorOnExecutionContext() throws Exception { taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { return RepeatStatus.FINISHED; } @@ -318,9 +319,9 @@ void testRepositoryErrorOnExecutionContextInTransaction() throws Exception { taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { return RepeatStatus.FINISHED; } @@ -340,9 +341,9 @@ void testRepositoryErrorOnExecutionContextInTransactionRollbackFailed() throws E taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { return RepeatStatus.FINISHED; } @@ -364,9 +365,9 @@ void testRepositoryErrorOnUpdateStepExecution() throws Exception { taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { return RepeatStatus.FINISHED; } @@ -385,9 +386,9 @@ void testRepositoryErrorOnUpdateStepExecutionInTransaction() throws Exception { taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { return RepeatStatus.FINISHED; } @@ -407,9 +408,9 @@ void testRepositoryErrorOnUpdateStepExecutionInTransactionRollbackFailed() throw taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { return RepeatStatus.FINISHED; } @@ -431,9 +432,9 @@ void testRepositoryErrorOnFailure() throws Exception { taskletStep.setTasklet(new Tasklet() { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext attributes) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext attributes) + throws Exception { throw new RuntimeException("Tasklet exception"); } @@ -472,9 +473,9 @@ public void update(StepExecution arg0) { private static class ExceptionTasklet implements Tasklet { - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { throw taskletException; } @@ -516,20 +517,18 @@ public void add(StepExecution stepExecution) { } @Override - public JobExecution createJobExecution(String jobName, JobParameters jobParameters) + public @Nullable JobExecution createJobExecution(String jobName, JobParameters jobParameters) throws JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException { return null; } - @Nullable @Override - public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { return null; } - @Nullable @Override - public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + public @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { return null; } @@ -572,9 +571,8 @@ public int getUpdateCount() { return updateCount; } - @Nullable @Override - public JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { + public @Nullable JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { return null; } @@ -587,7 +585,7 @@ public void addAll(Collection stepExecutions) { } @Override - public JobInstance createJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance createJobInstance(String jobName, JobParameters jobParameters) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/skip/ReprocessExceptionTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/skip/ReprocessExceptionTests.java index 44cc848ea0..0082926a9a 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/skip/ReprocessExceptionTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/skip/ReprocessExceptionTests.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.core.step.skip; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; @@ -26,7 +27,6 @@ import org.springframework.batch.item.ItemProcessor; import org.springframework.batch.item.ItemWriter; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -55,9 +55,8 @@ public static class PersonProcessor implements ItemProcessor { private String mostRecentFirstName; - @Nullable @Override - public 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"); } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/tasklet/StepExecutorInterruptionTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/tasklet/StepExecutorInterruptionTests.java index 951e29a5a7..5a97653153 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/tasklet/StepExecutorInterruptionTests.java +++ b/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); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/step/tasklet/TaskletStepTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/step/tasklet/TaskletStepTests.java index 1eb9934642..e49289f470 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/step/tasklet/TaskletStepTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/step/tasklet/TaskletStepTests.java @@ -27,6 +27,7 @@ import java.util.List; import java.util.Map; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.core.BatchStatus; @@ -62,7 +63,6 @@ import org.springframework.jdbc.support.JdbcTransactionManager; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; -import org.springframework.lang.Nullable; import org.springframework.transaction.TransactionException; import org.springframework.transaction.interceptor.DefaultTransactionAttribute; import org.springframework.transaction.support.DefaultTransactionStatus; @@ -290,9 +290,9 @@ void testExitCodeCustomClassification() { step.setTasklet(new TestingChunkOrientedTasklet<>(itemReader, itemWriter)); step.registerStepExecutionListener(new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { return ExitStatus.FAILED.addExitDescription("FOO"); } }); @@ -399,9 +399,9 @@ void testRestartJobOnNonRestartableTasklet() throws Exception { @Test void testStreamManager() throws Exception { MockRestartableItemReader reader = new MockRestartableItemReader() { - @Nullable + @Override - public String read() { + public @Nullable String read() { return "foo"; } @@ -452,9 +452,8 @@ public void beforeStep(StepExecution stepExecution) { list.add("foo"); } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { list.add("bar"); return null; } @@ -493,9 +492,9 @@ void testAfterStep() throws Exception { final ExitStatus customStatus = new ExitStatus("COMPLETED_CUSTOM"); step.setStepExecutionListeners(new StepExecutionListener[] { new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { list.add("afterStepCalled"); return customStatus; } @@ -517,17 +516,17 @@ public ExitStatus afterStep(StepExecution stepExecution) { @Test void testDirectlyInjectedListenerOnError() throws Exception { step.registerStepExecutionListener(new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { list.add("exception"); return null; } }); step.setTasklet(new TestingChunkOrientedTasklet<>(new MockRestartableItemReader() { - @Nullable + @Override - public String read() throws RuntimeException { + public @Nullable String read() throws RuntimeException { throw new RuntimeException("FOO"); } }, itemWriter)); @@ -541,9 +540,9 @@ public String read() throws RuntimeException { @Test void testDirectlyInjectedStreamWhichIsAlsoReader() throws Exception { MockRestartableItemReader reader = new MockRestartableItemReader() { - @Nullable + @Override - public String read() { + public @Nullable String read() { return "foo"; } @@ -760,9 +759,9 @@ public void close() throws ItemStreamException { @Test void testRestartAfterFailureInFirstChunk() throws Exception { MockRestartableItemReader reader = new MockRestartableItemReader() { - @Nullable + @Override - public String read() throws RuntimeException { + public @Nullable String read() throws RuntimeException { // fail on the very first item throw new RuntimeException("CRASH!"); } @@ -805,9 +804,9 @@ void testStepToCompletion() throws Exception { @Test void testStepFailureInAfterStepCallback() throws JobInterruptedException { StepExecutionListener listener = new StepExecutionListener() { - @Nullable + @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { throw new RuntimeException("exception thrown in afterStep to signal failure"); } }; @@ -824,9 +823,10 @@ public ExitStatus afterStep(StepExecution stepExecution) { void testNoRollbackFor() throws Exception { step.setTasklet(new Tasklet() { - @Nullable + @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { throw new RuntimeException("Bar"); } }); @@ -849,9 +849,10 @@ public boolean rollbackOn(Throwable ex) { @Test void testTaskletExecuteReturnNull() throws Exception { step.setTasklet(new Tasklet() { - @Nullable + @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return null; } }); @@ -896,9 +897,8 @@ private static class MockRestartableItemReader extends AbstractItemStreamItemRea private final boolean restoreFromCalled = false; - @Nullable @Override - public String read() { + public @Nullable String read() { return "item"; } @@ -917,9 +917,8 @@ public boolean isRestoreFromCalled() { return restoreFromCalled; } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/concurrent/ConcurrentTransactionTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/concurrent/ConcurrentTransactionTests.java index 1afb9f3c70..e89e68655b 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/concurrent/ConcurrentTransactionTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/concurrent/ConcurrentTransactionTests.java @@ -21,6 +21,7 @@ import java.sql.Statement; import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -54,7 +55,6 @@ import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseFactory; import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator; import org.springframework.jdbc.support.JdbcTransactionManager; -import org.springframework.lang.Nullable; import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import org.springframework.transaction.PlatformTransactionManager; @@ -101,17 +101,17 @@ public TaskExecutor taskExecutor() { public Flow flow(JobRepository jobRepository, PlatformTransactionManager transactionManager) { return new FlowBuilder("flow") .start(new StepBuilder("flow.step1", jobRepository).tasklet(new Tasklet() { - @Nullable + @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { return RepeatStatus.FINISHED; } }, transactionManager).build()) .next(new StepBuilder("flow.step2", jobRepository).tasklet(new Tasklet() { - @Nullable + @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { return RepeatStatus.FINISHED; } @@ -122,9 +122,10 @@ public RepeatStatus execute(StepContribution contribution, ChunkContext chunkCon @Bean public Step firstStep(JobRepository jobRepository, PlatformTransactionManager transactionManager) { return new StepBuilder("firstStep", jobRepository).tasklet(new Tasklet() { - @Nullable + @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return RepeatStatus.FINISHED; } }, transactionManager).build(); @@ -133,9 +134,10 @@ public RepeatStatus execute(StepContribution contribution, ChunkContext chunkCon @Bean public Step lastStep(JobRepository jobRepository, PlatformTransactionManager transactionManager) { return new StepBuilder("lastStep", jobRepository).tasklet(new Tasklet() { - @Nullable + @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) + throws Exception { return RepeatStatus.FINISHED; } }, transactionManager).build(); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/football/internal/GameFieldSetMapper.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/football/internal/GameFieldSetMapper.java index 40de74f66d..42ee16fd53 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/football/internal/GameFieldSetMapper.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/football/internal/GameFieldSetMapper.java @@ -16,6 +16,8 @@ package org.springframework.batch.core.test.football.internal; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.test.football.domain.Game; import org.springframework.batch.item.file.mapping.FieldSetMapper; import org.springframework.batch.item.file.transform.FieldSet; @@ -23,7 +25,7 @@ public class GameFieldSetMapper implements FieldSetMapper { @Override - public Game mapFieldSet(FieldSet fs) { + public @Nullable Game mapFieldSet(FieldSet fs) { if (fs == null) { return null; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/football/internal/PlayerFieldSetMapper.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/football/internal/PlayerFieldSetMapper.java index 44ab0b6cb6..b53ea5f086 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/football/internal/PlayerFieldSetMapper.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/football/internal/PlayerFieldSetMapper.java @@ -16,6 +16,8 @@ package org.springframework.batch.core.test.football.internal; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.test.football.domain.Player; import org.springframework.batch.item.file.mapping.FieldSetMapper; import org.springframework.batch.item.file.transform.FieldSet; @@ -23,7 +25,7 @@ public class PlayerFieldSetMapper implements FieldSetMapper { @Override - public Player mapFieldSet(FieldSet fs) { + public @Nullable Player mapFieldSet(FieldSet fs) { if (fs == null) { return null; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/ldif/MyMapper.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/ldif/MyMapper.java index ef5ca61818..ea98cb21de 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/ldif/MyMapper.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/ldif/MyMapper.java @@ -15,8 +15,9 @@ */ package org.springframework.batch.core.test.ldif; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ldif.RecordMapper; -import org.springframework.lang.Nullable; import org.springframework.ldap.core.LdapAttributes; /** @@ -31,8 +32,7 @@ public class MyMapper implements RecordMapper { @Override - @Nullable - public LdapAttributes mapRecord(LdapAttributes attributes) { + public @Nullable LdapAttributes mapRecord(LdapAttributes attributes) { return attributes; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/ldif/builder/MappingLdifReaderBuilderTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/ldif/builder/MappingLdifReaderBuilderTests.java index d8942794be..855f5db82f 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/ldif/builder/MappingLdifReaderBuilderTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/ldif/builder/MappingLdifReaderBuilderTests.java @@ -16,6 +16,7 @@ package org.springframework.batch.core.test.ldif.builder; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Test; @@ -28,7 +29,6 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.Configuration; -import org.springframework.lang.Nullable; import org.springframework.ldap.core.LdapAttributes; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; @@ -201,9 +201,8 @@ public void handleRecord(LdapAttributes attributes) { public static class TestMapper implements RecordMapper { - @Nullable @Override - public LdapAttributes mapRecord(LdapAttributes attributes) { + public @Nullable LdapAttributes mapRecord(LdapAttributes attributes) { return attributes; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/namespace/config/DummyNamespaceHandler.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/namespace/config/DummyNamespaceHandler.java index ec6d4a36f2..852ac392e1 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/namespace/config/DummyNamespaceHandler.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/namespace/config/DummyNamespaceHandler.java @@ -24,6 +24,8 @@ import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.xml.NamespaceHandler; import org.springframework.beans.factory.xml.ParserContext; + +import org.jspecify.annotations.Nullable; import org.w3c.dom.Element; import org.w3c.dom.Node; @@ -37,7 +39,8 @@ public class DummyNamespaceHandler implements NamespaceHandler { public static String LABEL = new Random().toString(); @Override - public BeanDefinitionHolder decorate(Node source, BeanDefinitionHolder definition, ParserContext parserContext) { + public @Nullable BeanDefinitionHolder decorate(Node source, BeanDefinitionHolder definition, + ParserContext parserContext) { return null; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepFactoryBeanIntegrationTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepFactoryBeanIntegrationTests.java index 8aa43c8d8a..33a799fb0f 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepFactoryBeanIntegrationTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepFactoryBeanIntegrationTests.java @@ -21,6 +21,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -41,7 +42,6 @@ import org.springframework.batch.item.support.SynchronizedItemReader; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.jdbc.core.JdbcTemplate; -import org.springframework.lang.Nullable; import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import org.springframework.test.jdbc.JdbcTestUtils; @@ -202,9 +202,8 @@ public void clear() { JdbcTestUtils.deleteFromTableWhere(jdbcTemplate, "ERROR_LOG", "STEP_NAME='processed'"); } - @Nullable @Override - public String process(String item) { + public @Nullable String process(String item) { logger.debug("Processed item: " + item); jdbcTemplate.update("INSERT INTO ERROR_LOG (MESSAGE, STEP_NAME) VALUES (?, ?)", item, "processed"); return item; diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepFactoryBeanRollbackIntegrationTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepFactoryBeanRollbackIntegrationTests.java index fc57e0b3d7..7ea92ae4bf 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepFactoryBeanRollbackIntegrationTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepFactoryBeanRollbackIntegrationTests.java @@ -25,6 +25,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Timeout; @@ -44,7 +45,6 @@ import org.springframework.batch.item.support.SynchronizedItemReader; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.jdbc.core.JdbcTemplate; -import org.springframework.lang.Nullable; import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import org.springframework.test.jdbc.JdbcTestUtils; @@ -230,9 +230,8 @@ public void clear() { JdbcTestUtils.deleteFromTableWhere(jdbcTemplate, "ERROR_LOG", "STEP_NAME='processed'"); } - @Nullable @Override - public String process(String item) { + public @Nullable String process(String item) { processed.add(item); logger.debug("Processed item: " + item); jdbcTemplate.update("INSERT INTO ERROR_LOG (MESSAGE, STEP_NAME) VALUES (?, ?)", item, "processed"); diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepIntegrationTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepIntegrationTests.java index e4c8cadca9..8e227e18c8 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepIntegrationTests.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/step/FaultTolerantStepIntegrationTests.java @@ -19,6 +19,7 @@ import java.util.Arrays; import java.util.List; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Timeout; @@ -41,7 +42,6 @@ import org.springframework.batch.item.ItemWriter; import org.springframework.batch.item.support.ListItemReader; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.lang.Nullable; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; import org.springframework.transaction.PlatformTransactionManager; @@ -159,9 +159,8 @@ void testExceptionInProcessDuringChunkScan() throws Exception { ItemProcessor itemProcessor = new ItemProcessor<>() { private int cpt; - @Nullable @Override - public Integer process(Integer item) throws Exception { + public @Nullable Integer process(Integer item) throws Exception { cpt++; if (cpt == 7) { // item 2 succeeds the first time but fails during the // scan diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/timeout/SleepingItemProcessor.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/timeout/SleepingItemProcessor.java index 6551123aaa..35ae7a390b 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/timeout/SleepingItemProcessor.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/timeout/SleepingItemProcessor.java @@ -15,16 +15,16 @@ */ package org.springframework.batch.core.test.timeout; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; public class SleepingItemProcessor implements ItemProcessor { private long millisToSleep; - @Nullable @Override - public I process(I item) throws Exception { + public @Nullable I process(I item) throws Exception { Thread.sleep(millisToSleep); return item; } diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/test/timeout/SleepingTasklet.java b/spring-batch-core/src/test/java/org/springframework/batch/core/test/timeout/SleepingTasklet.java index 8ca60d90fa..e995c60e85 100644 --- a/spring-batch-core/src/test/java/org/springframework/batch/core/test/timeout/SleepingTasklet.java +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/test/timeout/SleepingTasklet.java @@ -15,19 +15,19 @@ */ package org.springframework.batch.core.test.timeout; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; public class SleepingTasklet implements Tasklet { private long millisToSleep; - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { Thread.sleep(millisToSleep); return RepeatStatus.FINISHED; } diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractCursorItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractCursorItemReader.java index d820ca4151..f218be8265 100644 --- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractCursorItemReader.java +++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/AbstractCursorItemReader.java @@ -370,7 +370,7 @@ public void setConnectionAutoCommit(boolean autoCommit) { this.connectionAutoCommit = autoCommit; } - public abstract String getSql(); + public abstract @Nullable String getSql(); /** * Check the result set is in sync with the currentRow attribute. This is important to @@ -429,6 +429,7 @@ protected void doOpen() throws Exception { Assert.isNull(rs, "ResultSet still open! Close before re-opening."); initializeConnection(); + // noinspection DataFlowIssue openCursor(con); initialized = true; } diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/async/AsyncItemProcessor.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/async/AsyncItemProcessor.java index 286ede4ea8..717f445f5c 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/async/AsyncItemProcessor.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/async/AsyncItemProcessor.java @@ -19,6 +19,8 @@ import java.util.concurrent.FutureTask; import org.springframework.batch.core.step.StepExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.listener.ItemProcessListener; import org.springframework.batch.core.scope.context.StepContext; import org.springframework.batch.core.scope.context.StepSynchronizationManager; @@ -27,7 +29,6 @@ import org.springframework.beans.factory.InitializingBean; import org.springframework.core.task.SyncTaskExecutor; import org.springframework.core.task.TaskExecutor; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -88,8 +89,7 @@ public void setTaskExecutor(TaskExecutor taskExecutor) { * @see ItemProcessor#process(Object) */ @Override - @Nullable - public Future process(final I item) throws Exception { + public @Nullable Future process(I item) throws Exception { final StepExecution stepExecution = getStepExecution(); FutureTask task = new FutureTask<>(() -> { if (stepExecution != null) { diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/async/package-info.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/async/package-info.java index 7285a61bef..af9ae7bbe6 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/async/package-info.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/async/package-info.java @@ -4,8 +4,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.integration.async; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/ChunkMessageChannelItemWriter.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/ChunkMessageChannelItemWriter.java index 1e6c15a7d0..ca7711cced 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/ChunkMessageChannelItemWriter.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/ChunkMessageChannelItemWriter.java @@ -25,6 +25,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.BatchStatus; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepContribution; @@ -36,7 +38,6 @@ import org.springframework.batch.item.ItemStreamException; import org.springframework.batch.item.ItemWriter; import org.springframework.integration.core.MessagingTemplate; -import org.springframework.lang.Nullable; import org.springframework.messaging.Message; import org.springframework.messaging.PollableChannel; import org.springframework.messaging.support.GenericMessage; @@ -119,9 +120,8 @@ public void beforeStep(StepExecution stepExecution) { localState.setStepExecution(stepExecution); } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { if (!(stepExecution.getStatus() == BatchStatus.COMPLETED)) { return ExitStatus.EXECUTING; } diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/ChunkResponse.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/ChunkResponse.java index 088599d5d7..bab9ba6053 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/ChunkResponse.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/ChunkResponse.java @@ -19,7 +19,8 @@ import java.io.Serializable; import org.springframework.batch.core.step.StepContribution; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; /** * Encapsulates a response to processing a chunk of items, summarising the result as a diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/package-info.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/package-info.java index e375ea5649..71b552b10a 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/package-info.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/chunk/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.integration.chunk; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/annotation/package-info.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/annotation/package-info.java index 40a894455a..2f520080d4 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/annotation/package-info.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/annotation/package-info.java @@ -18,8 +18,9 @@ * APIs for the configuration of Spring Integration components through annotations. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.integration.config.annotation; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/RemoteChunkingManagerParser.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/RemoteChunkingManagerParser.java index cd7b6a894b..e527111d28 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/RemoteChunkingManagerParser.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/RemoteChunkingManagerParser.java @@ -24,6 +24,8 @@ import org.springframework.beans.factory.xml.AbstractBeanDefinitionParser; import org.springframework.beans.factory.xml.ParserContext; import org.springframework.util.Assert; + +import org.jspecify.annotations.Nullable; import org.w3c.dom.Element; /** @@ -54,7 +56,7 @@ public class RemoteChunkingManagerParser extends AbstractBeanDefinitionParser { private static final String CHUNK_HANDLER_BEAN_NAME_PREFIX = "remoteChunkHandlerFactoryBean_"; @Override - public AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) { + public @Nullable AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) { String id = element.getAttribute(ID_ATTRIBUTE); Assert.hasText(id, "The id attribute must be specified"); diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/package-info.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/package-info.java index aaf3e6a87e..15c8edc22e 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/package-info.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/package-info.java @@ -18,8 +18,9 @@ * APIs for the configuration of Spring Integration components through XML. * * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.integration.config.xml; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/launch/package-info.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/launch/package-info.java index 0c5d640f42..8ebf51a897 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/launch/package-info.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/launch/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.integration.launch; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/package-info.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/package-info.java index 060f80d47c..cef4798bd6 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/package-info.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/package-info.java @@ -1,7 +1,7 @@ /** * Provides integration with Spring Integration. */ -@NonNullApi +@NullMarked package org.springframework.batch.integration; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/MessageChannelPartitionHandler.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/MessageChannelPartitionHandler.java index 05ae32d719..8127fcb257 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/MessageChannelPartitionHandler.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/MessageChannelPartitionHandler.java @@ -228,7 +228,7 @@ protected Set doHandle(StepExecution managerStepExecution, } } - private Set pollReplies(final StepExecution managerStepExecution, final Set split) + private Set pollReplies(StepExecution managerStepExecution, final Set split) throws Exception { Set partitionStepExecutionIds = split.stream().map(StepExecution::getId).collect(Collectors.toSet()); diff --git a/spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/package-info.java b/spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/package-info.java index e8b25768cb..a5f36fe737 100644 --- a/spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/package-info.java +++ b/spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/package-info.java @@ -3,8 +3,9 @@ * * @author Michael Minella * @author Mahmoud Ben Hassine + * @author Stefano Cordio */ -@NonNullApi +@NullMarked package org.springframework.batch.integration.partition; -import org.springframework.lang.NonNullApi; +import org.jspecify.annotations.NullMarked; diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/JobRepositorySupport.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/JobRepositorySupport.java index faea74454a..eb376fd103 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/JobRepositorySupport.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/JobRepositorySupport.java @@ -18,6 +18,8 @@ import java.util.Collection; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.parameters.JobParameters; import org.springframework.batch.core.step.StepExecution; @@ -25,7 +27,6 @@ import org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException; import org.springframework.batch.core.repository.JobRepository; import org.springframework.batch.core.repository.JobRestartException; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -41,13 +42,12 @@ public JobExecution createJobExecution(String jobName, JobParameters jobParamete } @Override - public JobInstance getJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance getJobInstance(String jobName, JobParameters jobParameters) { return null; } @Override - @Nullable - public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { + public @Nullable StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) { return null; } @@ -83,8 +83,7 @@ public boolean isJobInstanceExists(String jobName, JobParameters jobParameters) } @Override - @Nullable - public JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { + public @Nullable JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) { return null; } @@ -98,7 +97,7 @@ public void addAll(Collection stepExecutions) { } @Override - public JobInstance createJobInstance(String jobName, JobParameters jobParameters) { + public @Nullable JobInstance createJobInstance(String jobName, JobParameters jobParameters) { return null; } diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/chunk/RemoteChunkingManagerStepBuilderTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/chunk/RemoteChunkingManagerStepBuilderTests.java index 704b262215..8d74965246 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/chunk/RemoteChunkingManagerStepBuilderTests.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/chunk/RemoteChunkingManagerStepBuilderTests.java @@ -21,6 +21,7 @@ import javax.sql.DataSource; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository; @@ -54,7 +55,6 @@ import org.springframework.integration.core.MessagingTemplate; import org.springframework.jdbc.support.JdbcTransactionManager; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; -import org.springframework.lang.Nullable; import org.springframework.messaging.PollableChannel; import org.springframework.retry.RetryListener; import org.springframework.retry.backoff.NoBackOffPolicy; @@ -257,9 +257,8 @@ void testSetters() throws Exception { final List items = Arrays.asList("a", "b", "c", "d", "d", "e", "f", "g", "h", "i"); - @Nullable @Override - public String read() throws Exception { + public @Nullable String read() throws Exception { if (count == 6) { count++; throw new IOException("6th item"); diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/chunk/TestItemReader.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/chunk/TestItemReader.java index 2f9555aa5b..9d4b8fb567 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/chunk/TestItemReader.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/chunk/TestItemReader.java @@ -20,10 +20,11 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ParseException; import org.springframework.batch.item.UnexpectedInputException; -import org.springframework.lang.Nullable; import org.springframework.stereotype.Component; @Component @@ -56,8 +57,7 @@ public void setItems(List items) { } @Override - @Nullable - public T read() throws Exception, UnexpectedInputException, ParseException { + public @Nullable T read() throws Exception, UnexpectedInputException, ParseException { if (count >= items.size()) { return null; diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/config/xml/RemoteChunkingParserTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/config/xml/RemoteChunkingParserTests.java index b2c894b284..f38894e714 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/config/xml/RemoteChunkingParserTests.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/config/xml/RemoteChunkingParserTests.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.integration.config.xml; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.core.step.item.ChunkProcessor; @@ -33,7 +34,6 @@ import org.springframework.context.support.ClassPathXmlApplicationContext; import org.springframework.integration.config.ServiceActivatorFactoryBean; import org.springframework.integration.test.util.TestUtils; -import org.springframework.lang.Nullable; import org.springframework.messaging.MessageChannel; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -258,9 +258,8 @@ public void write(Chunk items) throws Exception { private static class Processor implements ItemProcessor { - @Nullable @Override - public String process(String item) throws Exception { + public @Nullable String process(String item) throws Exception { return item; } diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/item/MessagingGatewayIntegrationTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/item/MessagingGatewayIntegrationTests.java index 49a044523f..e007507170 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/item/MessagingGatewayIntegrationTests.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/item/MessagingGatewayIntegrationTests.java @@ -15,6 +15,7 @@ */ package org.springframework.batch.integration.item; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.batch.item.Chunk; @@ -88,7 +89,7 @@ static class Activator { private int count; @ServiceActivator - public String transform(String input) { + public @Nullable String transform(String input) { if (input.equals("filter")) { return null; } diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/ExampleItemReader.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/ExampleItemReader.java index 855c604841..691594f2f2 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/ExampleItemReader.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/ExampleItemReader.java @@ -17,11 +17,12 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ItemStream; import org.springframework.batch.item.ItemStreamException; -import org.springframework.lang.Nullable; /** * {@link ItemReader} with hard-coded input data. @@ -40,8 +41,7 @@ public class ExampleItemReader implements ItemReader, ItemStream { * Reads next record from input */ @Override - @Nullable - public String read() throws Exception { + public @Nullable String read() throws Exception { if (index >= input.length) { return null; } diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RepeatTransactionalPollingIntegrationTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RepeatTransactionalPollingIntegrationTests.java index 3ac04bda22..861afda77b 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RepeatTransactionalPollingIntegrationTests.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RepeatTransactionalPollingIntegrationTests.java @@ -23,6 +23,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.support.transaction.TransactionAwareProxyFactory; @@ -71,7 +72,7 @@ public String process(String message) { return result; } - public String input() { + public @Nullable String input() { logger.debug("Polling: " + count); if (list.isEmpty()) { return null; diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RetryRepeatTransactionalPollingIntegrationTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RetryRepeatTransactionalPollingIntegrationTests.java index 15db6d2636..1ea088da04 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RetryRepeatTransactionalPollingIntegrationTests.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RetryRepeatTransactionalPollingIntegrationTests.java @@ -23,6 +23,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.support.transaction.TransactionAwareProxyFactory; @@ -65,7 +66,7 @@ void clearLists() { count = 0; } - public String input() { + public @Nullable String input() { logger.debug("Polling: " + count); if (list.isEmpty()) { return null; diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RetryTransactionalPollingIntegrationTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RetryTransactionalPollingIntegrationTests.java index 0f308727cf..385f6683a7 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RetryTransactionalPollingIntegrationTests.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/RetryTransactionalPollingIntegrationTests.java @@ -24,6 +24,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.support.transaction.TransactionAwareProxyFactory; @@ -64,7 +65,7 @@ void clearLists() { count.set(0); } - public String input() { + public @Nullable String input() { logger.debug("Polling: " + count); if (list.isEmpty()) { return null; diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/SimpleRecoverer.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/SimpleRecoverer.java index bc11d73998..68dc8d1127 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/SimpleRecoverer.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/SimpleRecoverer.java @@ -20,6 +20,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.retry.interceptor.MethodInvocationRecoverer; /** @@ -42,7 +44,7 @@ public List getRecovered() { } @Override - public String recover(Object[] data, Throwable cause) { + public @Nullable String recover(Object[] data, Throwable cause) { if (data == null) { return null; } diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/TransactionalPollingIntegrationTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/TransactionalPollingIntegrationTests.java index 5fe57bb65d..bfe8c50d59 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/TransactionalPollingIntegrationTests.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/retry/TransactionalPollingIntegrationTests.java @@ -23,6 +23,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.batch.support.transaction.TransactionAwareProxyFactory; @@ -73,7 +74,7 @@ public String process(String message) { return result; } - public String input() { + public @Nullable String input() { logger.debug("Polling: " + count + " of " + list.size()); if (list.isEmpty()) { return null; diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/step/TestTasklet.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/step/TestTasklet.java index d2205ba65a..8d98eb14c0 100644 --- a/spring-batch-integration/src/test/java/org/springframework/batch/integration/step/TestTasklet.java +++ b/spring-batch-integration/src/test/java/org/springframework/batch/integration/step/TestTasklet.java @@ -15,11 +15,12 @@ */ package org.springframework.batch.integration.step; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; -import org.springframework.lang.Nullable; /** * @author Dave Syer @@ -34,8 +35,7 @@ public void setFail(boolean fail) { } @Override - @Nullable - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { if (fail) { throw new IllegalStateException("Planned Tasklet failure"); } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/amqp/MessageProcessor.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/amqp/MessageProcessor.java index f2e21141a8..07aa3f7845 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/amqp/MessageProcessor.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/amqp/MessageProcessor.java @@ -16,10 +16,11 @@ package org.springframework.batch.samples.amqp; import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; import java.util.Date; +import org.jspecify.annotations.Nullable; + /** *

* Simple {@link ItemProcessor} implementation to append a "processed on" {@link Date} to @@ -28,9 +29,8 @@ */ public class MessageProcessor implements ItemProcessor { - @Nullable @Override - public String process(String message) throws Exception { + public @Nullable String process(String message) throws Exception { return "Message: \"" + message + "\" processed on: " + new Date(); } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/ErrorLogTasklet.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/ErrorLogTasklet.java index fc30224baa..5cb3fd1d83 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/ErrorLogTasklet.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/ErrorLogTasklet.java @@ -18,6 +18,8 @@ import javax.sql.DataSource; import org.springframework.batch.core.ExitStatus; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.StepContribution; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; @@ -26,7 +28,6 @@ import org.springframework.batch.repeat.RepeatStatus; import org.springframework.jdbc.core.JdbcOperations; import org.springframework.jdbc.core.JdbcTemplate; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -44,9 +45,8 @@ public class ErrorLogTasklet implements Tasklet, StepExecutionListener { private String stepName; - @Nullable @Override - public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { + public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { Assert.notNull(this.stepName, "Step name not set. Either this class was not registered as a listener " + "or the key 'stepName' was not found in the Job's ExecutionContext."); this.jdbcTemplate.update("insert into ERROR_LOG values (?, ?, '" + getSkipCount() + " records were skipped!')", @@ -81,9 +81,8 @@ public void beforeStep(StepExecution stepExecution) { stepExecution.getJobExecution().getExecutionContext().remove("stepName"); } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { return null; } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/SkipCheckingDecider.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/SkipCheckingDecider.java index 94ae806a19..21c1016ef4 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/SkipCheckingDecider.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/SkipCheckingDecider.java @@ -15,12 +15,13 @@ */ package org.springframework.batch.samples.common; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.job.flow.FlowExecutionStatus; import org.springframework.batch.core.job.flow.JobExecutionDecider; -import org.springframework.lang.Nullable; public class SkipCheckingDecider implements JobExecutionDecider { diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/SkipCheckingListener.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/SkipCheckingListener.java index 221f231758..f7a39d3bd5 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/SkipCheckingListener.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/SkipCheckingListener.java @@ -17,6 +17,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.annotation.AfterStep; @@ -36,7 +38,7 @@ public class SkipCheckingListener { private static int processSkips; @AfterStep - public ExitStatus checkForSkips(StepExecution stepExecution) { + public @Nullable ExitStatus checkForSkips(StepExecution stepExecution) { if (!stepExecution.getExitStatus().getExitCode().equals(ExitStatus.FAILED.getExitCode()) && stepExecution.getSkipCount() > 0) { return new ExitStatus("COMPLETED WITH SKIPS"); diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemProcessor.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemProcessor.java index 95542a3ccd..004cc223cf 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemProcessor.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemProcessor.java @@ -18,11 +18,12 @@ import javax.sql.DataSource; import org.springframework.batch.item.ItemProcessor; + +import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.InitializingBean; import org.springframework.dao.OptimisticLockingFailureException; import org.springframework.jdbc.core.JdbcOperations; import org.springframework.jdbc.core.JdbcTemplate; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -56,9 +57,8 @@ public void afterPropertiesSet() throws Exception { * Use the technical identifier to mark the input row as processed and return * unwrapped item. */ - @Nullable @Override - public T process(ProcessIndicatorItemWrapper wrapper) throws Exception { + public @Nullable T process(ProcessIndicatorItemWrapper wrapper) throws Exception { int count = jdbcTemplate.update("UPDATE BATCH_STAGING SET PROCESSED=? WHERE ID=? AND PROCESSED=?", StagingItemWriter.DONE, wrapper.getId(), StagingItemWriter.NEW); diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemReader.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemReader.java index 9b64f77d71..f809cb30ed 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemReader.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemReader.java @@ -27,6 +27,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepExecution; @@ -37,7 +38,6 @@ import org.springframework.beans.factory.InitializingBean; import org.springframework.jdbc.core.JdbcOperations; import org.springframework.jdbc.core.JdbcTemplate; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -95,9 +95,8 @@ private List retrieveKeys() { } - @Nullable @Override - public ProcessIndicatorItemWrapper read() { + public @Nullable ProcessIndicatorItemWrapper read() { if (!initialized) { throw new ReaderNotOpenException("Reader must be open before it can be used."); } @@ -133,9 +132,8 @@ private static Object deserialize(InputStream inputStream) { } } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { return null; } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemWriter.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemWriter.java index 6d9974dfe5..f1af92c4f1 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemWriter.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/common/StagingItemWriter.java @@ -21,6 +21,8 @@ import java.util.ListIterator; import org.springframework.batch.core.ExitStatus; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; import org.springframework.batch.item.Chunk; @@ -28,7 +30,6 @@ import org.springframework.jdbc.core.BatchPreparedStatementSetter; import org.springframework.jdbc.core.support.JdbcDaoSupport; import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; import org.springframework.util.SerializationUtils; @@ -72,7 +73,7 @@ public void setIncrementer(DataFieldMaxValueIncrementer incrementer) { * @see ItemWriter#write(Chunk) */ @Override - public void write(final Chunk chunk) { + public void write(Chunk chunk) { final ListIterator itemIterator = chunk.getItems().listIterator(); getJdbcTemplate().batchUpdate("INSERT into BATCH_STAGING (ID, JOB_ID, VALUE, PROCESSED) values (?,?,?,?)", @@ -95,9 +96,8 @@ public void setValues(PreparedStatement ps, int i) throws SQLException { }); } - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { return null; } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/person/PersonService.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/person/PersonService.java index 014d3b3bc5..437a13ef8e 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/person/PersonService.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/person/PersonService.java @@ -21,6 +21,8 @@ import org.springframework.batch.samples.file.patternmatching.Address; +import org.jspecify.annotations.Nullable; + /** * Custom class that contains logic that would normally be be contained in * {@link org.springframework.batch.item.ItemReader} and @@ -38,7 +40,7 @@ public class PersonService { private int processedCounter = 0; - public Person getData() { + public @Nullable Person getData() { if (generatedCounter >= GENERATION_LIMIT) { return null; } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CompositeCustomerUpdateLineTokenizer.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CompositeCustomerUpdateLineTokenizer.java index 525cab87f4..5237589002 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CompositeCustomerUpdateLineTokenizer.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CompositeCustomerUpdateLineTokenizer.java @@ -16,11 +16,12 @@ package org.springframework.batch.samples.domain.trade; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; import org.springframework.batch.item.file.transform.FieldSet; import org.springframework.batch.item.file.transform.LineTokenizer; -import org.springframework.lang.Nullable; /** * Composite {@link LineTokenizer} that delegates the tokenization of a line to one of two @@ -41,7 +42,7 @@ public class CompositeCustomerUpdateLineTokenizer implements StepExecutionListen private StepExecution stepExecution; @Override - public FieldSet tokenize(@Nullable String line) { + public @Nullable FieldSet tokenize(@Nullable String line) { if (line.charAt(0) == 'F') { // line starts with F, so the footer tokenizer should tokenize it. diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerOperation.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerOperation.java index 7ef594c7d5..d136386837 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerOperation.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerOperation.java @@ -19,6 +19,8 @@ import java.util.HashMap; import java.util.Map; +import org.jspecify.annotations.Nullable; + /** * Enum representing on of 3 possible actions on a customer update: Add, update, or delete * @@ -45,7 +47,7 @@ public enum CustomerOperation { } } - public static CustomerOperation fromCode(char code) { + public static @Nullable CustomerOperation fromCode(char code) { if (CODE_MAP.containsKey(code)) { return CODE_MAP.get(code); } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerUpdateFieldSetMapper.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerUpdateFieldSetMapper.java index 3544262cc7..8d80707ee4 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerUpdateFieldSetMapper.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerUpdateFieldSetMapper.java @@ -19,6 +19,8 @@ import java.math.BigDecimal; import org.springframework.batch.item.file.mapping.FieldSetMapper; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.item.file.transform.FieldSet; /** @@ -30,7 +32,7 @@ public class CustomerUpdateFieldSetMapper implements FieldSetMapper { @Override - public CustomerUpdate mapFieldSet(FieldSet fs) { + public @Nullable CustomerUpdate mapFieldSet(FieldSet fs) { if (fs == null) { return null; diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerUpdateProcessor.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerUpdateProcessor.java index 34921d5f17..5caafad6c2 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerUpdateProcessor.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/CustomerUpdateProcessor.java @@ -19,7 +19,8 @@ import static org.springframework.batch.samples.domain.trade.CustomerOperation.*; import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; /** * @author Lucas Ward @@ -31,9 +32,8 @@ public class CustomerUpdateProcessor implements ItemProcessor { private int counter = 0; - @Nullable @Override - public Trade read() throws Exception { + public @Nullable Trade read() throws Exception { if (counter < limit) { counter++; return new Trade("isin" + counter, counter, new BigDecimal(counter), "customer" + counter); diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/internal/JdbcCustomerDao.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/internal/JdbcCustomerDao.java index 8bcdd43dbb..36e1c87a24 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/internal/JdbcCustomerDao.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/internal/JdbcCustomerDao.java @@ -20,6 +20,8 @@ import java.util.List; import org.springframework.batch.samples.domain.trade.CustomerCredit; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.samples.domain.trade.CustomerDao; import org.springframework.jdbc.core.support.JdbcDaoSupport; import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer; @@ -44,7 +46,7 @@ public void setIncrementer(DataFieldMaxValueIncrementer incrementer) { } @Override - public CustomerCredit getCustomerByName(String name) { + public @Nullable CustomerCredit getCustomerByName(String name) { List customers = getJdbcTemplate().query(GET_CUSTOMER_BY_NAME, (rs, rowNum) -> { CustomerCredit customer = new CustomerCredit(); diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/internal/TradeProcessor.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/internal/TradeProcessor.java index 55412b9a87..492c67ad6b 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/internal/TradeProcessor.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/domain/trade/internal/TradeProcessor.java @@ -16,10 +16,11 @@ package org.springframework.batch.samples.domain.trade.internal; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemProcessor; import org.springframework.batch.item.validator.ValidationException; import org.springframework.batch.samples.domain.trade.Trade; -import org.springframework.lang.Nullable; /** * Processes the Trade - throwing validation errors if necessary. @@ -40,9 +41,8 @@ public void setValidationFailure(int failure) { this.failure = failure; } - @Nullable @Override - public Trade process(Trade item) throws Exception { + public @Nullable Trade process(Trade item) throws Exception { if ((failedItem == null && index++ == failure) || (failedItem != null && failedItem.equals(item))) { failedItem = item; throw new ValidationException("Some bad data for " + failedItem); diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/multiline/MultiLineTradeItemReader.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/multiline/MultiLineTradeItemReader.java index 1ee553bb3e..ae6ff37bbd 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/multiline/MultiLineTradeItemReader.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/multiline/MultiLineTradeItemReader.java @@ -16,13 +16,14 @@ package org.springframework.batch.samples.file.multiline; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ExecutionContext; import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.ItemStream; import org.springframework.batch.item.ItemStreamException; import org.springframework.batch.item.file.FlatFileItemReader; import org.springframework.batch.item.file.transform.FieldSet; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -37,9 +38,8 @@ public class MultiLineTradeItemReader implements ItemReader, ItemStream { /** * @see org.springframework.batch.item.ItemReader#read() */ - @Nullable @Override - public Trade read() throws Exception { + public @Nullable Trade read() throws Exception { Trade t = null; for (FieldSet line; (line = this.delegate.read()) != null;) { diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/multilineaggregate/AggregateItemReader.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/multilineaggregate/AggregateItemReader.java index e0daf546d8..f2f8037582 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/multilineaggregate/AggregateItemReader.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/multilineaggregate/AggregateItemReader.java @@ -21,8 +21,9 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemReader; -import org.springframework.lang.Nullable; /** * An {@link ItemReader} that delivers a list as its item, storing up objects from the @@ -53,9 +54,8 @@ public class AggregateItemReader implements ItemReader> { * * @see org.springframework.batch.item.ItemReader#read() */ - @Nullable @Override - public List read() throws Exception { + public @Nullable List read() throws Exception { ResultHolder holder = new ResultHolder(); while (process(itemReader.read(), holder)) { diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/patternmatching/internal/OrderItemReader.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/patternmatching/internal/OrderItemReader.java index c9d7f6936e..b51d42834e 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/patternmatching/internal/OrderItemReader.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/patternmatching/internal/OrderItemReader.java @@ -20,6 +20,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.ItemReader; import org.springframework.batch.item.file.mapping.FieldSetMapper; import org.springframework.batch.item.file.transform.FieldSet; @@ -29,7 +31,6 @@ import org.springframework.batch.samples.file.patternmatching.LineItem; import org.springframework.batch.samples.file.patternmatching.Order; import org.springframework.batch.samples.file.patternmatching.ShippingInfo; -import org.springframework.lang.Nullable; /** * @author peter.zozom @@ -61,9 +62,8 @@ public class OrderItemReader implements ItemReader { /** * @see org.springframework.batch.item.ItemReader#read() */ - @Nullable @Override - public Order read() throws Exception { + public @Nullable Order read() throws Exception { recordFinished = false; while (!recordFinished) { diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/patternmatching/internal/xml/Order.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/patternmatching/internal/xml/Order.java index 9721803527..7d60aa5c59 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/patternmatching/internal/xml/Order.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/file/patternmatching/internal/xml/Order.java @@ -19,6 +19,8 @@ import java.util.Date; import java.util.List; +import org.jspecify.annotations.Nullable; + /** * An XML order. *

@@ -42,7 +44,7 @@ public void setCustomer(Customer customer) { this.customer = customer; } - public Date getDate() { + public @Nullable Date getDate() { return date != null ? new Date(date.getTime()) : null; } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/football/internal/GameFieldSetMapper.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/football/internal/GameFieldSetMapper.java index 0ae7cd2c08..2bedd20c7b 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/football/internal/GameFieldSetMapper.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/football/internal/GameFieldSetMapper.java @@ -16,6 +16,8 @@ package org.springframework.batch.samples.football.internal; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.file.mapping.FieldSetMapper; import org.springframework.batch.item.file.transform.FieldSet; import org.springframework.batch.samples.football.Game; @@ -23,7 +25,7 @@ public class GameFieldSetMapper implements FieldSetMapper { @Override - public Game mapFieldSet(FieldSet fs) { + public @Nullable Game mapFieldSet(FieldSet fs) { if (fs == null) { return null; diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/football/internal/PlayerFieldSetMapper.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/football/internal/PlayerFieldSetMapper.java index 910588f895..9a82aa6f0e 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/football/internal/PlayerFieldSetMapper.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/football/internal/PlayerFieldSetMapper.java @@ -16,6 +16,8 @@ package org.springframework.batch.samples.football.internal; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.item.file.mapping.FieldSetMapper; import org.springframework.batch.item.file.transform.FieldSet; import org.springframework.batch.samples.football.Player; @@ -23,7 +25,7 @@ public class PlayerFieldSetMapper implements FieldSetMapper { @Override - public Player mapFieldSet(FieldSet fs) { + public @Nullable Player mapFieldSet(FieldSet fs) { if (fs == null) { return null; diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/launch/DefaultJobLoader.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/launch/DefaultJobLoader.java index 07ee3a6f2a..42887d547b 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/launch/DefaultJobLoader.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/launch/DefaultJobLoader.java @@ -20,6 +20,8 @@ import java.util.Map; import org.springframework.batch.core.job.Job; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.configuration.JobRegistry; import org.springframework.batch.core.launch.NoSuchJobException; import org.springframework.beans.BeanWrapperImpl; @@ -77,7 +79,7 @@ public void loadResource(String path) { } @Override - public Object getJobConfiguration(String name) { + public @Nullable Object getJobConfiguration(String name) { try { return registry.getJob(name); } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/loop/GeneratingTradeResettingListener.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/loop/GeneratingTradeResettingListener.java index e26ab46e69..c092d62409 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/loop/GeneratingTradeResettingListener.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/loop/GeneratingTradeResettingListener.java @@ -15,12 +15,13 @@ */ package org.springframework.batch.samples.loop; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.listener.StepExecutionListener; import org.springframework.batch.samples.domain.trade.internal.GeneratingTradeItemReader; import org.springframework.beans.factory.InitializingBean; -import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** @@ -34,9 +35,8 @@ public class GeneratingTradeResettingListener implements StepExecutionListener, private GeneratingTradeItemReader reader; - @Nullable @Override - public ExitStatus afterStep(StepExecution stepExecution) { + public @Nullable ExitStatus afterStep(StepExecution stepExecution) { this.reader.resetCounter(); return null; } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/loop/LimitDecider.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/loop/LimitDecider.java index 51cd2e7533..7bcf2c048d 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/loop/LimitDecider.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/loop/LimitDecider.java @@ -15,11 +15,12 @@ */ package org.springframework.batch.samples.loop; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.core.job.flow.FlowExecutionStatus; import org.springframework.batch.core.job.flow.JobExecutionDecider; -import org.springframework.lang.Nullable; /** * This decider will return "CONTINUE" until the limit it reached, at which point it will diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/mail/UserMailItemProcessor.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/mail/UserMailItemProcessor.java index 5eef350d19..3b30a15ae3 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/mail/UserMailItemProcessor.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/mail/UserMailItemProcessor.java @@ -18,7 +18,8 @@ import java.util.Date; import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; + +import org.jspecify.annotations.Nullable; import org.springframework.mail.SimpleMailMessage; /** @@ -31,9 +32,8 @@ public class UserMailItemProcessor implements ItemProcessor { - @Nullable @Override - public Object read() throws Exception { + public @Nullable Object read() throws Exception { return new Object(); } diff --git a/spring-batch-samples/src/main/java/org/springframework/batch/samples/support/ExceptionThrowingItemReaderProxy.java b/spring-batch-samples/src/main/java/org/springframework/batch/samples/support/ExceptionThrowingItemReaderProxy.java index 8c16e3cb21..0d02f0b09d 100644 --- a/spring-batch-samples/src/main/java/org/springframework/batch/samples/support/ExceptionThrowingItemReaderProxy.java +++ b/spring-batch-samples/src/main/java/org/springframework/batch/samples/support/ExceptionThrowingItemReaderProxy.java @@ -16,9 +16,10 @@ package org.springframework.batch.samples.support; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.UnexpectedJobExecutionException; import org.springframework.batch.item.ItemReader; -import org.springframework.lang.Nullable; /** * Hacked {@link ItemReader} that throws exception on a given record number (useful for @@ -44,9 +45,8 @@ public void setThrowExceptionOnRecordNumber(int throwExceptionOnRecordNumber) { this.throwExceptionOnRecordNumber = throwExceptionOnRecordNumber; } - @Nullable @Override - public T read() throws Exception { + public @Nullable T read() throws Exception { counter++; if (counter == throwExceptionOnRecordNumber) { diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/ExecutionContextTestUtils.java b/spring-batch-test/src/main/java/org/springframework/batch/test/ExecutionContextTestUtils.java index f3bbdbbf53..699e092115 100644 --- a/spring-batch-test/src/main/java/org/springframework/batch/test/ExecutionContextTestUtils.java +++ b/spring-batch-test/src/main/java/org/springframework/batch/test/ExecutionContextTestUtils.java @@ -20,9 +20,10 @@ import java.util.List; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.step.StepExecution; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; /** * Convenience class for accessing {@link ExecutionContext} values from job and step @@ -40,13 +41,11 @@ private ExecutionContextTestUtils() { } @SuppressWarnings("unchecked") - @Nullable - public static T getValueFromJob(JobExecution jobExecution, String key) { + public static @Nullable T getValueFromJob(JobExecution jobExecution, String key) { return (T) jobExecution.getExecutionContext().get(key); } - @Nullable - public static T getValueFromStepInJob(JobExecution jobExecution, String stepName, String key) { + public static @Nullable T getValueFromStepInJob(JobExecution jobExecution, String stepName, String key) { StepExecution stepExecution = null; List stepNames = new ArrayList<>(); for (StepExecution candidate : jobExecution.getStepExecutions()) { @@ -66,8 +65,7 @@ public static T getValueFromStepInJob(JobExecution jobExecution, String step } @SuppressWarnings("unchecked") - @Nullable - public static T getValueFromStep(StepExecution stepExecution, String key) { + public static @Nullable T getValueFromStep(StepExecution stepExecution, String key) { return (T) stepExecution.getExecutionContext().get(key); } diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/JobLauncherTestUtils.java b/spring-batch-test/src/main/java/org/springframework/batch/test/JobLauncherTestUtils.java index 1acb5ad071..d28e0c444a 100644 --- a/spring-batch-test/src/main/java/org/springframework/batch/test/JobLauncherTestUtils.java +++ b/spring-batch-test/src/main/java/org/springframework/batch/test/JobLauncherTestUtils.java @@ -22,6 +22,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.Job; import org.springframework.batch.core.job.JobExecution; @@ -37,7 +38,6 @@ import org.springframework.batch.core.step.StepLocator; import org.springframework.batch.item.ExecutionContext; import org.springframework.context.ApplicationContext; -import org.springframework.lang.Nullable; /** *

diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/JobRepositoryTestUtils.java b/spring-batch-test/src/main/java/org/springframework/batch/test/JobRepositoryTestUtils.java index d4cee99af9..d6581945d2 100644 --- a/spring-batch-test/src/main/java/org/springframework/batch/test/JobRepositoryTestUtils.java +++ b/spring-batch-test/src/main/java/org/springframework/batch/test/JobRepositoryTestUtils.java @@ -21,6 +21,8 @@ import java.util.List; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.job.JobInstance; import org.springframework.batch.core.job.parameters.JobParameter; import org.springframework.batch.core.job.parameters.JobParameters; @@ -31,7 +33,6 @@ import org.springframework.batch.core.repository.JobRepository; import org.springframework.batch.core.repository.JobRestartException; import org.springframework.dao.OptimisticLockingFailureException; -import org.springframework.lang.Nullable; /** * Convenience class for creating and removing {@link JobExecution} instances from a diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/JobScopeTestExecutionListener.java b/spring-batch-test/src/main/java/org/springframework/batch/test/JobScopeTestExecutionListener.java index d51ad56079..0c1613fa39 100644 --- a/spring-batch-test/src/main/java/org/springframework/batch/test/JobScopeTestExecutionListener.java +++ b/spring-batch-test/src/main/java/org/springframework/batch/test/JobScopeTestExecutionListener.java @@ -18,6 +18,8 @@ import java.lang.reflect.Method; import org.springframework.batch.core.job.JobExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.scope.context.JobContext; import org.springframework.batch.core.scope.context.JobSynchronizationManager; import org.springframework.batch.item.adapter.HippyMethodInvoker; @@ -151,7 +153,7 @@ public ExtractorMethodCallback(Class preferredType, String preferredName) { this.preferredName = preferredName; } - public String getName() { + public @Nullable String getName() { return result == null ? null : result.getName(); } diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/StepRunner.java b/spring-batch-test/src/main/java/org/springframework/batch/test/StepRunner.java index 673f30d684..4c296cd20c 100755 --- a/spring-batch-test/src/main/java/org/springframework/batch/test/StepRunner.java +++ b/spring-batch-test/src/main/java/org/springframework/batch/test/StepRunner.java @@ -24,6 +24,8 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.jspecify.annotations.Nullable; + import org.springframework.batch.core.job.Job; import org.springframework.batch.core.job.JobExecution; import org.springframework.batch.core.listener.JobExecutionListener; @@ -39,7 +41,6 @@ import org.springframework.batch.core.repository.JobRepository; import org.springframework.batch.core.repository.JobRestartException; import org.springframework.batch.item.ExecutionContext; -import org.springframework.lang.Nullable; /** * Utility class for executing steps. This is useful in end to end testing in order to diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/StepScopeTestExecutionListener.java b/spring-batch-test/src/main/java/org/springframework/batch/test/StepScopeTestExecutionListener.java index 8d6a6eea44..60c22cfacf 100644 --- a/spring-batch-test/src/main/java/org/springframework/batch/test/StepScopeTestExecutionListener.java +++ b/spring-batch-test/src/main/java/org/springframework/batch/test/StepScopeTestExecutionListener.java @@ -18,6 +18,8 @@ import java.lang.reflect.Method; import org.springframework.batch.core.step.StepExecution; + +import org.jspecify.annotations.Nullable; import org.springframework.batch.core.scope.context.StepContext; import org.springframework.batch.core.scope.context.StepSynchronizationManager; import org.springframework.batch.item.adapter.HippyMethodInvoker; @@ -31,7 +33,7 @@ * injection into unit tests. A {@link StepContext} will be created for the duration of a * test method and made available to any dependencies that are injected. The default * behaviour is just to create a {@link StepExecution} with fixed properties. - * Alternatively it can be provided by the test case as a factory methods returning the + * Alternatively, it can be provided by the test case as a factory methods returning the * correct type. Example: * * 

@@ -63,6 +65,7 @@
  * @author Dave Syer
  * @author Chris Schaefer
  * @author Mahmoud Ben Hassine
+ * @author Stefano Cordio
  */
 public class StepScopeTestExecutionListener implements TestExecutionListener {
 
@@ -146,15 +149,14 @@ private static final class ExtractorMethodCallback implements MethodCallback {
 
 		private final Class preferredType;
 
-		private Method result;
+		private @Nullable Method result;
 
 		public ExtractorMethodCallback(Class preferredType, String preferredName) {
-			super();
 			this.preferredType = preferredType;
 			this.preferredName = preferredName;
 		}
 
-		public String getName() {
+		public @Nullable String getName() {
 			return result == null ? null : result.getName();
 		}
 
diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/context/BatchTestContextCustomizerFactory.java b/spring-batch-test/src/main/java/org/springframework/batch/test/context/BatchTestContextCustomizerFactory.java
index 3c4888d7a1..477b0e4325 100644
--- a/spring-batch-test/src/main/java/org/springframework/batch/test/context/BatchTestContextCustomizerFactory.java
+++ b/spring-batch-test/src/main/java/org/springframework/batch/test/context/BatchTestContextCustomizerFactory.java
@@ -17,8 +17,9 @@
 
 import java.util.List;
 
-import org.springframework.lang.Nullable;
 import org.springframework.test.context.ContextConfigurationAttributes;
+
+import org.jspecify.annotations.Nullable;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
 import org.springframework.test.context.TestContextAnnotationUtils;
diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/context/package-info.java b/spring-batch-test/src/main/java/org/springframework/batch/test/context/package-info.java
index 32d298c926..37ec519a34 100644
--- a/spring-batch-test/src/main/java/org/springframework/batch/test/context/package-info.java
+++ b/spring-batch-test/src/main/java/org/springframework/batch/test/context/package-info.java
@@ -18,8 +18,9 @@
  * APIs for the configuration of Spring Batch test support.
  *
  * @author Mahmoud Ben Hassine
+ * @author Stefano Cordio
  */
-@NonNullApi
+@NullMarked
 package org.springframework.batch.test.context;
 
-import org.springframework.lang.NonNullApi;
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/package-info.java b/spring-batch-test/src/main/java/org/springframework/batch/test/package-info.java
index 747af4e482..6c479e3a5d 100644
--- a/spring-batch-test/src/main/java/org/springframework/batch/test/package-info.java
+++ b/spring-batch-test/src/main/java/org/springframework/batch/test/package-info.java
@@ -18,8 +18,9 @@
  * Utility classes for batch job/step testing.
  *
  * @author Mahmoud Ben Hassine
+ * @author Stefano Cordio
  */
-@NonNullApi
+@NullMarked
 package org.springframework.batch.test;
 
-import org.springframework.lang.NonNullApi;
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-test/src/test/java/org/springframework/batch/test/JobLauncherTestUtilsTests.java b/spring-batch-test/src/test/java/org/springframework/batch/test/JobLauncherTestUtilsTests.java
index 60ed6feeb3..ce86cdaf54 100644
--- a/spring-batch-test/src/test/java/org/springframework/batch/test/JobLauncherTestUtilsTests.java
+++ b/spring-batch-test/src/test/java/org/springframework/batch/test/JobLauncherTestUtilsTests.java
@@ -15,6 +15,7 @@
  */
 package org.springframework.batch.test;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.batch.core.ExitStatus;
@@ -38,7 +39,6 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
 import org.springframework.jdbc.support.JdbcTransactionManager;
-import org.springframework.lang.Nullable;
 
 import java.util.HashSet;
 import java.util.Set;
@@ -85,9 +85,10 @@ static class TestJobConfiguration {
 		@Bean
 		public Step step(JobRepository jobRepository) {
 			return new StepBuilder("step1", jobRepository).tasklet(new Tasklet() {
-				@Nullable
+
 				@Override
-				public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
+				public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext)
+						throws Exception {
 					return null;
 				}
 			}, transactionManager(dataSource())).build();
diff --git a/spring-batch-test/src/test/java/org/springframework/batch/test/StepScopeAnnotatedListenerIntegrationTests.java b/spring-batch-test/src/test/java/org/springframework/batch/test/StepScopeAnnotatedListenerIntegrationTests.java
index 57b2315fb9..62958c8d91 100644
--- a/spring-batch-test/src/test/java/org/springframework/batch/test/StepScopeAnnotatedListenerIntegrationTests.java
+++ b/spring-batch-test/src/test/java/org/springframework/batch/test/StepScopeAnnotatedListenerIntegrationTests.java
@@ -20,6 +20,7 @@
 
 import javax.sql.DataSource;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.batch.core.ExitStatus;
@@ -45,7 +46,6 @@
 import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
 import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
 import org.springframework.jdbc.support.JdbcTransactionManager;
-import org.springframework.lang.Nullable;
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 import org.springframework.transaction.PlatformTransactionManager;
 
@@ -83,9 +83,8 @@ public ExitStatus exploitState(StepExecution stepExecution) {
 			return stepExecution.getExitStatus();
 		}
 
-		@Nullable
 		@Override
-		public String read() throws Exception {
+		public @Nullable String read() throws Exception {
 			this.list.add("some stateful reading information");
 			if (list.size() < 10) {
 				return "value " + list.size();
@@ -146,9 +145,8 @@ public StatefulItemReader reader() {
 		public ItemProcessor processor() {
 			return new ItemProcessor<>() {
 
-				@Nullable
 				@Override
-				public String process(String item) throws Exception {
+				public @Nullable String process(String item) throws Exception {
 					return item;
 				}
 			};
diff --git a/spring-batch-test/src/test/java/org/springframework/batch/test/sample/LoggingTasklet.java b/spring-batch-test/src/test/java/org/springframework/batch/test/sample/LoggingTasklet.java
index dbe8e117b3..db38b57b00 100644
--- a/spring-batch-test/src/test/java/org/springframework/batch/test/sample/LoggingTasklet.java
+++ b/spring-batch-test/src/test/java/org/springframework/batch/test/sample/LoggingTasklet.java
@@ -17,11 +17,12 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.batch.core.step.StepContribution;
 import org.springframework.batch.core.scope.context.ChunkContext;
 import org.springframework.batch.core.step.tasklet.Tasklet;
 import org.springframework.batch.repeat.RepeatStatus;
-import org.springframework.lang.Nullable;
 
 public class LoggingTasklet implements Tasklet {
 
@@ -33,9 +34,8 @@ public LoggingTasklet(int id) {
 		this.id = id;
 	}
 
-	@Nullable
 	@Override
-	public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
+	public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
 		logger.info("tasklet executing: id=" + id);
 		return RepeatStatus.FINISHED;
 	}
diff --git a/spring-batch-test/src/test/java/org/springframework/batch/test/sample/SampleTasklet.java b/spring-batch-test/src/test/java/org/springframework/batch/test/sample/SampleTasklet.java
index 595212b7de..c80d1c5e99 100755
--- a/spring-batch-test/src/test/java/org/springframework/batch/test/sample/SampleTasklet.java
+++ b/spring-batch-test/src/test/java/org/springframework/batch/test/sample/SampleTasklet.java
@@ -15,6 +15,8 @@
  */
 package org.springframework.batch.test.sample;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.batch.core.job.JobExecution;
 import org.springframework.batch.core.step.StepContribution;
 import org.springframework.batch.core.step.StepExecution;
@@ -25,7 +27,6 @@
 import org.springframework.batch.repeat.RepeatStatus;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.jdbc.core.JdbcTemplate;
-import org.springframework.lang.Nullable;
 
 public class SampleTasklet implements Tasklet {
 
@@ -42,9 +43,8 @@ public SampleTasklet(int id) {
 		this.id = id;
 	}
 
-	@Nullable
 	@Override
-	public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
+	public @Nullable RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
 		this.jdbcTemplate.update("insert into TESTS(ID, NAME) values (?, 'SampleTasklet" + id + "')", id);
 
 		if (jobExecution != null) {