DoubleFunction.java revision 607050af5a16c46ae53ff4d2c3f47b4ef694b559 
1/*
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package java.util.function;
26
27/**
28 * Represents a function that accepts a double-valued argument and produces a
29 * result.  This is the {@code double}-consuming primitive specialization for
30 * {@link Function}.
31 *
32 * <p>This is a <a href="package-summary.html">functional interface</a>
33 * whose functional method is {@link #apply(double)}.
34 *
35 * @param <R> the type of the result of the function
36 *
37 * @see Function
38 * @since 1.8
39 * @hide 1.8
40 */
41@FunctionalInterface
42public interface DoubleFunction<R> {
43
44    /**
45     * Applies this function to the given argument.
46     *
47     * @param value the function argument
48     * @return the function result
49     */
50    R apply(double value);
51}
52