From f37fae670b454699092abd0494a29706af6a271f Mon Sep 17 00:00:00 2001 From: Matthew Ouyang Date: Thu, 16 Jan 2020 20:07:35 -0500 Subject: [PATCH] Add documentation for how an ItemProcessor.process can never receive a null item. --- .../java/org/springframework/batch/item/ItemProcessor.java | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) 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 9eeabebfdb..4a47edc52a 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,6 +16,7 @@ package org.springframework.batch.item; +import org.springframework.lang.NonNull; import org.springframework.lang.Nullable; /** @@ -36,12 +37,13 @@ public interface ItemProcessor { * processing. If the returned result is null, it is assumed that processing of the item * should not continue. * - * @param item to be processed + * @param item to be processed. A {@code null} will never reach this method because the only possible sources + * are ItemReader (which indicates no more items) and ItemProcessor (which indicates a filtered item). * @return potentially modified or new item for continued processing, {@code null} if processing of the * provided item should not continue. * * @throws Exception thrown if exception occurs during processing. */ @Nullable - O process(I item) throws Exception; + O process(@NonNull I item) throws Exception; }