From 837a0360bebb95dce8b27c147f3e39a5fb9a3db2 Mon Sep 17 00:00:00 2001
From: Michael Jumper <mjumper@apache.org>
Date: Wed, 27 Apr 2022 22:01:01 +0000
Subject: [PATCH] GUACAMOLE-641: Clarify that null will also be returned if the
 List actually contains null.

---
 .../vault/ksm/secret/KsmRecordService.java         | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/extensions/guacamole-vault/modules/guacamole-vault-ksm/src/main/java/org/apache/guacamole/vault/ksm/secret/KsmRecordService.java b/extensions/guacamole-vault/modules/guacamole-vault-ksm/src/main/java/org/apache/guacamole/vault/ksm/secret/KsmRecordService.java
index 1bb3311fa..d67b5816a 100644
--- a/extensions/guacamole-vault/modules/guacamole-vault-ksm/src/main/java/org/apache/guacamole/vault/ksm/secret/KsmRecordService.java
+++ b/extensions/guacamole-vault/modules/guacamole-vault-ksm/src/main/java/org/apache/guacamole/vault/ksm/secret/KsmRecordService.java
@@ -91,7 +91,8 @@ public class KsmRecordService {
 
     /**
      * Returns the single value stored in the given list. If the list is empty
-     * or contains multiple values, null is returned.
+     * or contains multiple values, null is returned. Note that null will also
+     * be returned if the single value stored in the list is itself null.
      *
      * @param <T>
      *     The type of object stored in the list.
@@ -115,7 +116,8 @@ public class KsmRecordService {
     /**
      * Returns the single value stored in the given list of strings. If the
      * list is empty, contains multiple values, or contains only a single empty
-     * string, null is returned.
+     * string, null is returned. Note that null will also be returned if the
+     * single value stored in the list is itself null.
      *
      * @param values
      *     The list to retrieve a single value from.
@@ -138,7 +140,9 @@ public class KsmRecordService {
     /**
      * Returns the single value stored in the given list, additionally
      * performing a mapping transformation on the single value. If the list is
-     * empty or contains multiple values, null is returned.
+     * empty or contains multiple values, null is returned. Note that null will
+     * also be returned if the mapping transformation returns null for the
+     * single value stored in the list.
      * 
      * @param <T>
      *     The type of object stored in the list.
@@ -171,7 +175,9 @@ public class KsmRecordService {
      * Returns the single value stored in the given list of strings,
      * additionally performing a mapping transformation on the single value. If
      * the list is empty, contains multiple values, or contains only a single
-     * empty string, null is returned.
+     * empty string, null is returned. Note that null will also be returned if
+     * the mapping transformation returns null for the single value stored in
+     * the list.
      *
      * @param <T>
      *     The type of object stored in the list.