/*
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package java.util.function;

/**
 * Apply a function to the input object yielding an appropriate {@code int}
 * value; this is the {@code int}-bearing specialization for {@link Function}.
 *
 * <p>When used as a {@code Function} the default {@code apply} implementation
 * provided by this interface neither accepts null parameters nor does it return
 * null results.
 *
 * @param <T> the type of input objects to the function
 *
 * @since 1.8
 */
public interface IntFunction<T> extends Function<T,Integer> {

    /**
     * {@inheritDoc}
     *
     * @param t {@inheritDoc}, must be non-null
     * @return {@inheritDoc}, always non-null
     */
    @Override
    public default Integer apply(T t) {
        return applyAsInt(t);
    }

    /**
     * Apply a function to the input object yielding an appropriate {@code int}
     * value.
     *
     * @param t the input object
     * @return the function result value
     */
    public int applyAsInt(T t);
}