From 16f4d0c0140d3b1d063e963ed1e17df088c1b4b2 Mon Sep 17 00:00:00 2001
From: Martin Lippert <martin.lippert@broadcom.com>
Date: Wed, 9 Oct 2024 12:47:30 +0200
Subject: [PATCH] GH-1380: return null instead of empty list when there are no
 document hightlights found to avoid confusion on the client side

---
 .../languageserver/util/SimpleTextDocumentService.java       | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/headless-services/commons/commons-language-server/src/main/java/org/springframework/ide/vscode/commons/languageserver/util/SimpleTextDocumentService.java b/headless-services/commons/commons-language-server/src/main/java/org/springframework/ide/vscode/commons/languageserver/util/SimpleTextDocumentService.java
index 60c2dfae2..02e265d37 100644
--- a/headless-services/commons/commons-language-server/src/main/java/org/springframework/ide/vscode/commons/languageserver/util/SimpleTextDocumentService.java
+++ b/headless-services/commons/commons-language-server/src/main/java/org/springframework/ide/vscode/commons/languageserver/util/SimpleTextDocumentService.java
@@ -654,12 +654,13 @@ public class SimpleTextDocumentService implements TextDocumentService, DocumentE
 		DocumentHighlightHandler handler = this.documentHighlightHandler;
 		if (handler != null) {
 			return CompletableFutures.computeAsync(messageWorkerThreadPool, cancelToken -> {
-				return handler.handle(cancelToken, highlightParams);
+				List<? extends DocumentHighlight> result = handler.handle(cancelToken, highlightParams);
+				return result != null && result.size() > 0 ? result : null;
 
 			});
 		}
 		else {
-			return CompletableFuture.completedFuture(Collections.emptyList());
+			return CompletableFuture.completedFuture(null);
 		}
 	}