jdk/src/share/classes/java/util/function/BiConsumer.java
author psandoz
Tue, 13 Aug 2013 11:16:37 +0200
changeset 19424 c4524285927f
parent 19040 7b25fde2a4ed
permissions -rw-r--r--
8022797: Clarify spliterator characteristics for collections containing no elements Reviewed-by: alanb, mduigou
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     1
/*
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     2
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     4
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    10
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    15
 * accompanied this code).
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    16
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    20
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    23
 * questions.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    24
 */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    25
package java.util.function;
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    26
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    27
import java.util.Objects;
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    28
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    29
/**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    30
 * Represents an operation that accepts two input arguments and returns no
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    31
 * result.  This is the two-arity specialization of {@link Consumer}.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    32
 * Unlike most other functional interfaces, {@code BiConsumer} is expected
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    33
 * to operate via side-effects.
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    34
 *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    35
 * <p>This is a <a href="package-summary.html">functional interface</a>
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    36
 * whose functional method is {@link #accept(Object, Object)}.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    37
 *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    38
 * @param <T> the type of the first argument to the operation
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    39
 * @param <U> the type of the second argument to the operation
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    40
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    41
 * @see Consumer
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    42
 * @since 1.8
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    43
 */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    44
@FunctionalInterface
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    45
public interface BiConsumer<T, U> {
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    46
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    47
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    48
     * Performs this operation on the given arguments.
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    49
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    50
     * @param t the first input argument
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    51
     * @param u the second input argument
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    52
     */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    53
    void accept(T t, U u);
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    54
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    55
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    56
     * Returns a composed {@code BiConsumer} that performs, in sequence, this
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    57
     * operation followed by the {@code after} operation. If performing either
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    58
     * operation throws an exception, it is relayed to the caller of the
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    59
     * composed operation.  If performing this operation throws an exception,
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    60
     * the {@code after} operation will not be performed.
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    61
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    62
     * @param after the operation to perform after this operation
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    63
     * @return a composed {@code BiConsumer} that performs in sequence this
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    64
     * operation followed by the {@code after} operation
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    65
     * @throws NullPointerException if {@code after} is null
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    66
     */
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    67
    default BiConsumer<T, U> andThen(BiConsumer<? super T, ? super U> after) {
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    68
        Objects.requireNonNull(after);
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    69
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    70
        return (l, r) -> {
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    71
            accept(l, r);
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    72
            after.accept(l, r);
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    73
        };
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    74
    }
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    75
}