Add example to collectingAndThen() with partitioningBy()

google · Sep 28, 2024 · 2457130 · 2457130
1 parent 18dc6e6
commit 2457130
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/mug/src/main/java/com/google/mu/util/stream/BiCollectors.java b/mug/src/main/java/com/google/mu/util/stream/BiCollectors.java
@@ -552,6 +552,12 @@ public static <K, V, T, R> BiCollector<K, V, R> collectingAndThen(
    * Returns a {@link BiCollector} that maps the result of {@code collector} using the {@code
    * finisher} BiFunction. Useful when combined with BiCollectors like {@link #partitioningBy}.
    *
+   * <p>For example: <pre>{@code
+   * collectingAndThen(
+   *     partitioningBy((time, request) -> isAllowed(time, request), toMap(), counting()),
+   *     (allowedRequests, disallowed) -> ...)
+   * }</pre>
+   *
    * @since 8.1
    */
   public static <K, V, A, B, R> BiCollector<K, V, R> collectingAndThen(

diff --git a/mug/src/main/java/com/google/mu/util/stream/MoreCollectors.java b/mug/src/main/java/com/google/mu/util/stream/MoreCollectors.java
@@ -201,6 +201,10 @@ M build() {
    * Returns a {@link Collector} that maps the result of {@code upstream} collector using the {@code
    * finisher} BiFunction. Useful when combined with collectors like {@link #partitioningBy}.
    *
+   * <p>For example: <pre>{@code
+   * collectingAndThen(partitioningBy(Person::isGood), (good, evil) -> ...)
+   * }</pre>
+   *
    * @since 8.1
    */
   public static <T, A, B, R> Collector<T, ?, R> collectingAndThen(