Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc

This commit is contained in:
Gary Gregory 2024-04-25 08:40:06 -04:00
parent 0e1314c6b8
commit 7c99d624aa
1 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/main/java/org/apache/commons/lang3/stream/LangCollectors.java
View File

@ -162,28 +162,27 @@ public final class LangCollectors {
}
/**
* Returns a {@code Collector} that concatenates the input elements, separated by the specified delimiter, with the
* specified prefix and suffix, in encounter order.
* Returns a {@code Collector} that concatenates the input elements, separated by the specified delimiter, with the specified prefix and suffix, in
* encounter order.
* <p>
* This is a variation of {@link Collectors#joining(CharSequence, CharSequence, CharSequence)} that works with any
* element class, not just {@code CharSequence}.
* This is a variation of {@link Collectors#joining(CharSequence, CharSequence, CharSequence)} that works with any element class, not just
* {@code CharSequence}.
* </p>
* <p>
* For example:
* </p>
*
* <pre>
* <pre>{@code
* Stream.of(Long.valueOf(1), null, Long.valueOf(3))
* .collect(LangCollectors.joining("-", "[", "]", o -&gt; Objects.toString(o, "NUL")))
* .collect(LangCollectors.joining("-", "[", "]", o -> Objects.toString(o, "NUL")))
* returns "[1-NUL-3]"
* </pre>
* }</pre>
*
* @param delimiter the delimiter to be used between each element
* @param prefix the sequence of characters to be used at the beginning of the joined result
* @param suffix the sequence of characters to be used at the end of the joined result
* @param toString A function that takes an Object and returns a non-null String.
* @return A {@code Collector} which concatenates CharSequence elements, separated by the specified delimiter, in
* encounter order
* @param prefix the sequence of characters to be used at the beginning of the joined result
* @param suffix the sequence of characters to be used at the end of the joined result
* @param toString A function that takes an Object and returns a non-null String.
* @return A {@code Collector} which concatenates CharSequence elements, separated by the specified delimiter, in encounter order
*/
public static Collector<Object, ?, String> joining(final CharSequence delimiter, final CharSequence prefix, final CharSequence suffix,
final Function<Object, String> toString) {