Mercurial > hg > shenandoah-preopenjdk-archive > openjdk8 > jdk
changeset 7291:a79e2683eae3
8014383: StringJoiner example in class description not in sync with streams API
Reviewed-by: alanb
author | psandoz |
---|---|
date | Mon, 03 Jun 2013 17:37:51 +0200 |
parents | 3d4d7ed93731 |
children | 62d3c82b4509 |
files | src/share/classes/java/util/StringJoiner.java |
diffstat | 1 files changed, 18 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/src/share/classes/java/util/StringJoiner.java Mon Jun 03 10:44:10 2013 -0400 +++ b/src/share/classes/java/util/StringJoiner.java Mon Jun 03 17:37:51 2013 +0200 @@ -29,14 +29,6 @@ * by a delimiter and optionally starting with a supplied prefix * and ending with a supplied suffix. * <p> - * For example, the String {@code "[George:Sally:Fred]"} may - * be constructed as follows: - * <pre> {@code - * StringJoiner sj = new StringJoiner(":", "[", "]"); - * sj.add("George").add("Sally").add("Fred"); - * String desiredString = sj.toString(); - * }</pre> - * <p> * Prior to adding something to the {@code StringJoiner}, its * {@code sj.toString()} method will, by default, return {@code prefix + suffix}. * However, if the {@code setEmptyValue} method is called, the {@code emptyValue} @@ -45,17 +37,28 @@ * <code>"{}"</code>, where the {@code prefix} is <code>"{"</code>, the * {@code suffix} is <code>"}"</code> and nothing has been added to the * {@code StringJoiner}. - * <p> - * A {@code StringJoiner} may be employed to create formatted output from a - * collection using lambda expressions as shown in the following example. + * + * @apiNote + * <p>The String {@code "[George:Sally:Fred]"} may be constructed as follows: * * <pre> {@code - * List<Person> people = ... - * String commaSeparatedNames = - * people.map(p -> p.getName()).into(new StringJoiner(", ")).toString(); + * StringJoiner sj = new StringJoiner(":", "[", "]"); + * sj.add("George").add("Sally").add("Fred"); + * String desiredString = sj.toString(); + * }</pre> + * <p> + * A {@code StringJoiner} may be employed to create formatted output from a + * {@link java.util.stream.Stream} using + * {@link java.util.stream.Collectors#toStringJoiner}. For example: + * + * <pre> {@code + * List<Integer> numbers = Arrays.asList(1, 2, 3, 4); + * String commaSeparatedNumbers = numbers.stream() + * .map(i -> i.toString()) + * .collect(Collectors.toStringJoiner(", ")).toString(); * }</pre> * - * @author Jim Gish + * @see java.util.stream.Collectors#toStringJoiner * @since 1.8 */ public final class StringJoiner {