Apache/commons-collections
1
0
Fork 0
mirror of https://github.com/apache/commons-collections.git synced 2025-02-28 05:49:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Emphasize "should" a la rfc2119

Browse Source
This commit is contained in:
Gary Gregory 2024-07-10 08:33:06 -04:00
parent c5037c97bd
commit f84c8d6ea1
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/main/java/org/apache/commons/collections4/Transformer.java
View File

@ -23,7 +23,7 @@ import java.util.function.Function;
* object into another. * object into another.
* <p> * <p>
* A {@code Transformer} converts the input object to the output object. * 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 * Transformers are typically used for type conversions, or extracting data
* from an object. * from an object.
* </p> * </p>
@ -49,7 +49,10 @@ public interface Transformer<T, R> extends Function<T, R> {
} }
/** /**
* Transforms the input object (leaving it unchanged) into some output object. * Transforms the input object into some output object.
* <p>
* The input object SHOULD be left unchanged.
* </p>
* *
* @param input the object to be transformed, should be left unchanged * @param input the object to be transformed, should be left unchanged
* @return a transformed object * @return a transformed object