From f84c8d6ea124f41cc8077fafde012fdc1bed6b4b Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Wed, 10 Jul 2024 08:33:06 -0400 Subject: [PATCH] Emphasize "should" a la rfc2119 --- .../java/org/apache/commons/collections4/Transformer.java | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/collections4/Transformer.java b/src/main/java/org/apache/commons/collections4/Transformer.java index 221b95729b..52bb97c10b 100644 --- a/src/main/java/org/apache/commons/collections4/Transformer.java +++ b/src/main/java/org/apache/commons/collections4/Transformer.java @@ -23,7 +23,7 @@ * object into another. *

* A {@code Transformer} converts the input object to the output object. - * The input object should be left unchanged. + * The input object SHOULD be left unchanged. * Transformers are typically used for type conversions, or extracting data * from an object. *

@@ -49,7 +49,10 @@ default R apply(final T t) { } /** - * Transforms the input object (leaving it unchanged) into some output object. + * Transforms the input object into some output object. + *

+ * The input object SHOULD be left unchanged. + *

* * @param input the object to be transformed, should be left unchanged * @return a transformed object