GUACAMOLE-641: Clarify that null will also be returned if the List actually contains null.

This commit is contained in:
Michael Jumper
2022-04-27 22:01:01 +00:00
parent 741cf481d6
commit 837a0360be

View File

@@ -91,7 +91,8 @@ public class KsmRecordService {
/** /**
* Returns the single value stored in the given list. If the list is empty * 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> * @param <T>
* The type of object stored in the list. * 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 * 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 * 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 * @param values
* The list to retrieve a single value from. * 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 * Returns the single value stored in the given list, additionally
* performing a mapping transformation on the single value. If the list is * 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> * @param <T>
* The type of object stored in the list. * 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, * Returns the single value stored in the given list of strings,
* additionally performing a mapping transformation on the single value. If * additionally performing a mapping transformation on the single value. If
* the list is empty, contains multiple values, or contains only a single * 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> * @param <T>
* The type of object stored in the list. * The type of object stored in the list.