ToIntFunction.java revision 2278037aa1653a32014df55f325879b4fe75fc27 
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 produces an int-valued result.  This is the
29 * {@code int}-producing primitive specialization for {@link Function}.
30 *
31 * <p>This is a <a href="package-summary.html">functional interface</a>
32 * whose functional method is {@link #applyAsInt(Object)}.
33 *
34 * @param <T> the type of the input to the function
35 *
36 * @see Function
37 * @since 1.8
38 */
39@FunctionalInterface
40public interface ToIntFunction<T> {
41
42    /**
43     * Applies this function to the given argument.
44     *
45     * @param value the function argument
46     * @return the function result
47     */
48    int applyAsInt(T value);
49}
50