jdk/src/share/classes/java/util/function/IntConsumer.java
author mduigou
Fri, 17 May 2013 10:36:04 -0700
changeset 17695 032254f2467b
parent 16011 890a7ed97f6c
child 19040 7b25fde2a4ed
permissions -rw-r--r--
8004015: Additional static and instance utils for functional interfaces. 8011010: Spec j.u.f.Predicate doesn't specify NPEs thrown by the SE8's Reference Implementation Reviewed-by: briangoetz, dholmes, chegar
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     1
/*
15647
314007859004 8005623: Retrofit FunctionalInterface annotations to core platform interfaces
darcy
parents: 14856
diff changeset
     2
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     4
 *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    10
 *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    15
 * accompanied this code).
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    16
 *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    20
 *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    23
 * questions.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    24
 */
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    25
package java.util.function;
964ac9f1463c 8001634: Initial set of functional interface types
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
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    29
/**
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    30
 * An operation which accepts a single integer argument and returns no result.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    31
 * This is the primitive type specialization of {@link Consumer} for {@code int}.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    32
 * Unlike most other functional interfaces, {@code IntConsumer} is expected to
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    33
 * operate via side-effects.
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    34
 *
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    35
 * @see Consumer
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    36
 * @since 1.8
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    37
 */
15647
314007859004 8005623: Retrofit FunctionalInterface annotations to core platform interfaces
darcy
parents: 14856
diff changeset
    38
@FunctionalInterface
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    39
public interface IntConsumer {
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    40
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    41
    /**
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    42
     * Accept an input value.
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    43
     *
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    44
     * @param value the input value
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    45
     */
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    46
    void accept(int value);
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    47
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    48
    /**
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    49
     * Returns an {@code IntConsumer} which performs, in sequence, the operation
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    50
     * represented by this object followed by the operation represented by
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    51
     * another {@code IntConsumer}.
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    52
     *
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    53
     * <p>Any exceptions thrown by either {@code accept} method are relayed
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    54
     * to the caller; if performing this operation throws an exception, the
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    55
     * other operation will not be performed.
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    56
     *
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    57
     * @param other an IntConsumer which will be chained after this
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    58
     * IntConsumer
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    59
     * @return an IntConsumer which performs in sequence the {@code accept} method
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    60
     * of this IntConsumer and the {@code accept} method of the specified IntConsumer
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    61
     * operation
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    62
     * @throws NullPointerException if other is null
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    63
     */
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    64
    default IntConsumer chain(IntConsumer other) {
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    65
        Objects.requireNonNull(other);
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    66
        return (int t) -> { accept(t); other.accept(t); };
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    67
    }
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    68
}