GH-10083: Add nullability to Core splitter package

Related to: #10083

Author: cppwfs

spring-integration-core/src/main/java/org/springframework/integration/splitter/AbstractMessageProcessingSplitter.java

@@ -18,6 +18,8 @@
 
 import java.util.Collection;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.context.Lifecycle;
 import org.springframework.integration.handler.MessageProcessor;
 import org.springframework.integration.support.management.ManageableLifecycle;
@@ -48,7 +50,7 @@ protected void doInit() {
 	}
 
 	@Override
-	protected final Object splitMessage(Message<?> message) {
+	protected final @Nullable Object splitMessage(Message<?> message) {
 		return this.processor.processMessage(message);
 	}
 

spring-integration-core/src/main/java/org/springframework/integration/splitter/AbstractMessageSplitter.java

@@ -27,6 +27,7 @@
 import java.util.stream.Stream;
 
 import com.fasterxml.jackson.core.TreeNode;
+import org.jspecify.annotations.Nullable;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
@@ -54,15 +55,16 @@
  * @author Gary Russell
  * @author Ngoc Nhan
  * @author Jooyoung Pyoung
+ * @author Glenn Renfro
  */
 public abstract class AbstractMessageSplitter extends AbstractReplyProducingMessageHandler
 		implements DiscardingMessageHandler {
 
 	private boolean applySequence = true;
 
-	private MessageChannel discardChannel;
+	private @Nullable MessageChannel discardChannel;
 
-	private String discardChannelName;
+	private @Nullable String discardChannelName;
 
 	/**
 	 * Set the applySequence flag to the specified value. Defaults to true.
@@ -99,7 +101,7 @@ public void setDiscardChannelName(String discardChannelName) {
 	}
 
 	@Override
-	public MessageChannel getDiscardChannel() {
+	public @Nullable MessageChannel getDiscardChannel() {
 		if (this.discardChannel == null) {
 			String channelName = this.discardChannelName;
 			if (channelName != null) {
@@ -122,7 +124,7 @@ protected void doInit() {
 	}
 
 	@Override
-	protected final Object handleRequestMessage(Message<?> message) {
+	protected final @Nullable Object handleRequestMessage(Message<?> message) {
 		Object result = splitMessage(message);
 		// return null if 'null'
 		if (result == null) {
@@ -181,7 +183,7 @@ else if (result instanceof Publisher<?> publisher) {
 	}
 
 	@SuppressWarnings("unchecked")
-	private Iterator<?> prepareIteratorResult(Message<?> message, Object result) {
+	private @Nullable Iterator<?> prepareIteratorResult(Message<?> message, Object result) {
 		int sequenceSize = 1;
 		Iterator<?> iterator = Collections.singleton(result).iterator();
 
@@ -272,7 +274,7 @@ protected int obtainSizeIfPossible(Iterator<?> iterator) {
 	}
 
 	private AbstractIntegrationMessageBuilder<?> createBuilder(Object item, Map<String, Object> headers,
-			Object correlationId, int sequenceNumber, int sequenceSize) {
+			@Nullable Object correlationId, int sequenceNumber, int sequenceSize) {
 
 		AbstractIntegrationMessageBuilder<?> builder = messageBuilderForReply(item);
 		builder.setHeader(MessageHistory.HEADER_NAME, headers.get(MessageHistory.HEADER_NAME))
@@ -348,7 +350,7 @@ public String getComponentType() {
 	 * @param message The message.
 	 * @return The result of splitting the message.
 	 */
-	protected abstract Object splitMessage(Message<?> message);
+	protected abstract @Nullable Object splitMessage(Message<?> message);
 
 	@Deprecated(since = "7.0", forRemoval = true)
 	private static final class JacksonNodeHelper {

spring-integration-core/src/main/java/org/springframework/integration/splitter/DefaultMessageSplitter.java

@@ -20,6 +20,8 @@
 import java.util.List;
 import java.util.StringTokenizer;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.messaging.Message;
 
 /**
@@ -29,10 +31,11 @@
  * those delimiters.
  *
  * @author Mark Fisher
+ * @author Glenn Renfro
  */
 public class DefaultMessageSplitter extends AbstractMessageSplitter {
 
-	private volatile String delimiters;
+	private volatile @Nullable String delimiters;
 
 	/**
 	 * Set delimiters to use for tokenizing String values. The default is
@@ -41,16 +44,16 @@ public class DefaultMessageSplitter extends AbstractMessageSplitter {
 	 *
 	 * @param delimiters The delimiters.
 	 */
-	public void setDelimiters(String delimiters) {
+	public void setDelimiters(@Nullable String delimiters) {
 		this.delimiters = delimiters;
 	}
 
 	@Override
 	protected final Object splitMessage(Message<?> message) {
 		Object payload = message.getPayload();
-		if (payload instanceof String && this.delimiters != null) {
+		if (payload instanceof String payloadVal && this.delimiters != null) {
 			List<String> tokens = new ArrayList<String>();
-			StringTokenizer tokenizer = new StringTokenizer((String) payload, this.delimiters);
+			StringTokenizer tokenizer = new StringTokenizer(payloadVal, this.delimiters);
 			while (tokenizer.hasMoreElements()) {
 				tokens.add(tokenizer.nextToken());
 			}

spring-integration-core/src/main/java/org/springframework/integration/splitter/package-info.java

@@ -1,4 +1,5 @@
 /**
  * Provides classes supporting the splitter pattern.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.splitter;