From e87ab6f4ee49d6f8ec60e4ebe8b38c512f7c3c2f Mon Sep 17 00:00:00 2001
From: Sam Brannen <sbrannen@pivotal.io>
Date: Tue, 31 Mar 2020 18:47:06 +0200
Subject: [PATCH] Update Javadoc for AbstractListenerWriteProcessor.write()

Co-authored-by: Rossen Stoyanchev <rstoyanchev@pivotal.io>
---
 .../http/server/reactive/AbstractListenerWriteProcessor.java   | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java b/spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java
index 00b59ace27..db32a5e66e 100644
--- a/spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java
+++ b/spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java
@@ -213,6 +213,9 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
 	 * @param data the item to write
 	 * @return whether the current data item was written and another one
 	 * requested ({@code true}), or otherwise if more writes are required.
+	 * @return {@code true} if the current data item was written completely and
+	 * a new item requested, or {@code false} if it was written partially and
+	 * we'll need more write callbacks before it is fully written
 	 */
 	protected abstract boolean write(T data) throws IOException;