jdk/src/share/classes/java/util/function/IntUnaryOperator.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:
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: 14670
diff changeset
     2
 * Copyright (c) 2012, 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
/**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    30
 * Represents an operation on a single {@code int}-valued operand that produces
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    31
 * an {@code int}-valued result.  This is the primitive type specialization of
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    32
 * {@link UnaryOperator} for {@code int}.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    33
 *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    34
 * <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
    35
 * whose functional method is {@link #applyAsInt(int)}.
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    36
 *
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    37
 * @see UnaryOperator
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    38
 * @since 1.8
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    39
 */
15647
314007859004 8005623: Retrofit FunctionalInterface annotations to core platform interfaces
darcy
parents: 14670
diff changeset
    40
@FunctionalInterface
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    41
public interface IntUnaryOperator {
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    42
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    43
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    44
     * Applies this operator to the given operand.
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    45
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    46
     * @param operand the operand
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    47
     * @return the operator result
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    48
     */
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    49
    int applyAsInt(int operand);
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    50
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    51
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    52
     * Returns a composed operator that first applies the {@code before}
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    53
     * operator to its input, and then applies this operator to the result.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    54
     * If evaluation of either operator throws an exception, it is relayed to
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    55
     * the caller of the composed operator.
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    56
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    57
     * @param before the operator to apply before this operator is applied
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    58
     * @return a composed operator that first applies the {@code before}
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    59
     * operator and then applies this operator
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    60
     * @throws NullPointerException if before is null
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    61
     *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    62
     * @see #andThen(IntUnaryOperator)
17695
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 IntUnaryOperator compose(IntUnaryOperator before) {
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    65
        Objects.requireNonNull(before);
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    66
        return (int v) -> applyAsInt(before.applyAsInt(v));
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    67
    }
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    68
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    69
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    70
     * Returns a composed operator that first applies this operator to
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    71
     * its input, and then applies the {@code after} operator to the result.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    72
     * If evaluation of either operator throws an exception, it is relayed to
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    73
     * the caller of the composed operator.
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    74
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    75
     * @param after the operator to apply after this operator is applied
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    76
     * @return a composed operator that first applies this operator and then
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    77
     * applies the {@code after} operator
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    78
     * @throws NullPointerException if after is null
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    79
     *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    80
     * @see #compose(IntUnaryOperator)
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    81
     */
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    82
    default IntUnaryOperator andThen(IntUnaryOperator after) {
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    83
        Objects.requireNonNull(after);
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    84
        return (int t) -> after.applyAsInt(applyAsInt(t));
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    85
    }
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    86
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    87
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    88
     * Returns a unary operator that always returns its input argument.
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    89
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    90
     * @return a unary operator that always returns its input argument
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    91
     */
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    92
    static IntUnaryOperator identity() {
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    93
        return t -> t;
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    94
    }
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    95
}