test/jdk/java/util/stream/test/org/openjdk/tests/java/util/stream/CollectorExample.java
author jboes
Thu, 03 Oct 2019 18:59:56 +0100
changeset 58459 e25b317d0350
permissions -rw-r--r--
8231161: Wrong return type in code sample in Collector API documentation Summary: Correct declaration of container from R to A and add compilation test Reviewed-by: smarks, lancea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58459
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     1
/*
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     2
 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     4
 *
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     7
 * published by the Free Software Foundation.
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     8
 *
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    13
 * accompanied this code).
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    14
 *
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    18
 *
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    21
 * questions.
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    22
 */
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    23
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    24
package org.openjdk.tests.java.util.stream;
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    25
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    26
/*
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    27
 * THE CONTENTS OF THIS FILE HAVE TO BE IN SYNC WITH THE EXAMPLES USED
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    28
 * IN THE JAVADOC.
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    29
 *
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    30
 * @test
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    31
 * @bug 8231161
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    32
 * @compile CollectorExample.java
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    33
 * @summary Compilation test only. Compile code snippets from
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    34
 * java.util.stream.Collector class-level API documentation
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    35
 */
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    36
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    37
import java.util.*;
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    38
import java.util.function.BiConsumer;
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    39
import java.util.function.BinaryOperator;
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    40
import java.util.function.Function;
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    41
import java.util.function.Supplier;
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    42
import java.util.stream.Collector;
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    43
import java.util.stream.Collectors;
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    44
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    45
public class CollectorExample {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    46
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    47
    // Empty helper classes
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    48
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    49
    class Widget {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    50
    }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    51
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    52
    class Employee {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    53
        public int getSalary() {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    54
            return 0;    // money isn't everything
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    55
        }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    56
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    57
        public Department getDepartment() {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    58
            return new Department();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    59
        }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    60
    }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    61
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    62
    class Department {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    63
    }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    64
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    65
    <T, A, R> void testSnippet1(Collector<T, A, R> collector, T t1, T t2) {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    66
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    67
        Supplier<A> supplier = collector.supplier();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    68
        BiConsumer<A, T> accumulator = collector.accumulator();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    69
        BinaryOperator<A> combiner = collector.combiner();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    70
        Function<A, R> finisher = collector.finisher();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    71
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    72
        // Example start
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    73
        A a1 = supplier.get();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    74
        accumulator.accept(a1, t1);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    75
        accumulator.accept(a1, t2);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    76
        R r1 = finisher.apply(a1);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    77
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    78
        A a2 = supplier.get();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    79
        accumulator.accept(a2, t1);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    80
        A a3 = supplier.get();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    81
        accumulator.accept(a3, t2);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    82
        R r2 = finisher.apply(combiner.apply(a2, a3));
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    83
    }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    84
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    85
    void testSnippet2() {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    86
        Collector<Widget, ?, TreeSet<Widget>> intoSet =
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    87
                Collector.of(TreeSet::new, TreeSet::add,
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    88
                        (left, right) -> { left.addAll(right); return left; });
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    89
    }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    90
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    91
    <T, A, R> void testSnippet3(Collector<T, A, R> collector, Collection<T> data) {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    92
        A container = collector.supplier().get();
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    93
        for (T t : data)
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    94
            collector.accumulator().accept(container, t);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    95
        collector.finisher().apply(container);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    96
    }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    97
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    98
    void testSnippet4and5() {
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
    99
        Collector<Employee, ?, Integer> summingSalaries
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
   100
                = Collectors.summingInt(Employee::getSalary);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
   101
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
   102
        Collector<Employee, ?, Map<Department, Integer>> summingSalariesByDept
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
   103
                = Collectors.groupingBy(Employee::getDepartment, summingSalaries);
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
   104
    }
e25b317d0350 8231161: Wrong return type in code sample in Collector API documentation
jboes
parents:
diff changeset
   105
}