net.yetamine.lang.functional.BooleanFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of net.yetamine.lang Show documentation

Small extensions for the core Java language libraries.

The newest version!

/*
 * Copyright 2016 Yetamine
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.yetamine.lang.functional;

/**
 * Represents a function that accepts a Boolean argument and produces a result.
 * This is the {@code boolean}-consuming primitive specialization for
 * {@link java.util.function.Function}.
 *
 * @param 
 *            the type of the result of the function
 */
@FunctionalInterface
public interface BooleanFunction {

    /**
     * Applies this function to the given argument.
     *
     * @param value
     *            the function argument
     *
     * @return the function result
     */
    R apply(boolean value);
}