jdk/src/java.base/share/classes/java/util/function/DoubleSupplier.java
author zmajo
Fri, 03 Jul 2015 07:23:45 +0200 (2015-07-03)
changeset 31671 362e0c0acece
parent 25859 3317bb8137f4
permissions -rw-r--r--
8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics Summary: Annotate possibly intrinsified methods with @HotSpotIntrinsicCandidate. Add checks omitted by intrinsics to the library code. Add CheckIntrinsics flags to check consistency of intrinsics. Reviewed-by: jrose, kvn, thartmann, vlivanov, abuckley, darcy, ascarpino, briangoetz, alanb, aph, dnsimon
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
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    27
/**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    28
 * Represents a supplier of {@code double}-valued results.  This is the
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    29
 * {@code double}-producing primitive specialization of {@link Supplier}.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    30
 *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    31
 * <p>There is no requirement that a distinct result be returned each
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    32
 * time the supplier is invoked.
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 #getAsDouble()}.
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 Supplier
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 DoubleSupplier {
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
     * Gets a result.
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
     * @return a result
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    47
     */
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    48
    double getAsDouble();
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    49
}