net.openhft.koloboke.function.ShortPredicate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of koloboke-api-jdk8 Show documentation

Carefully designed and efficient extension of the Java Collections Framework with primitive specializations and more, built for Java 8 (API)

The newest version!

/*
 * Copyright 2014 the original author or authors.
 *
 * 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.openhft.koloboke.function;


/**
 * 
 * Represents a predicate (boolean-valued function) of one {@code short}-valued
 * argument. This is the {@code short}-consuming primitive type specialization of
 * {@link Predicate}.
 *
 * @see Predicate
 * 
 */
@FunctionalInterface

public interface ShortPredicate {

    /**
     * Evaluates this predicate on the given argument.
     *
     * @param value the input argument
     * @return {@code true} if the input argument matches the predicate,
     * otherwise {@code false}
     */
    boolean test(short value);
}