All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eu.zajc.ef.predicate.ShortPredicate Maven / Gradle / Ivy

Go to download

Specializations and support utilities for functional interfaces that are missing from the standard library

The newest version!
// SPDX-License-Identifier: Apache-2.0
/*
 * extended-functions
 * Copyright 2021-2024 Marko Zajc
 *
 * 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 org.eu.zajc.ef.predicate;

import java.util.Objects;
import java.util.function.Predicate;

import javax.annotation.Nonnull;

import org.eu.zajc.ef.bipredicate.ObjShortPredicate;
import org.eu.zajc.ef.tripredicate.ObjObjShortPredicate;

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

* This is a functional interface whose functional method is {@link #test(short)}. * * @see Predicate * @see ObjShortPredicate * @see ObjObjShortPredicate * * @author Marko Zajc */ public interface ShortPredicate { /** * Evaluates this predicate on the given argument. * * @param p * the input argument * * @return {@code true} if the input argument matches the predicate, otherwise * {@code false} */ boolean test(short p); /** * Returns a composed predicate that represents a short-circuiting logical AND of * this predicate and another. When evaluating the composed predicate, if this * predicate is {@code false}, then the {@code other} predicate is not evaluated. * *

* Any exceptions thrown during evaluation of either predicate are relayed to the * caller; if evaluation of this predicate throws an exception, the {@code other} * predicate will not be evaluated. * * @param other * a predicate that will be logically-ANDed with this predicate * * @return a composed predicate that represents the short-circuiting logical AND of * this predicate and the {@code other} predicate * * @throws NullPointerException * if other is null */ @Nonnull default ShortPredicate and(@Nonnull ShortPredicate other) { Objects.requireNonNull(other); return value -> test(value) && other.test(value); } /** * Returns a predicate that represents the logical negation of this predicate. * * @return a predicate that represents the logical negation of this predicate */ @Nonnull default ShortPredicate negate() { return value -> !test(value); } /** * Returns a composed predicate that represents a short-circuiting logical OR of this * predicate and another. When evaluating the composed predicate, if this predicate * is {@code true}, then the {@code other} predicate is not evaluated. * *

* Any exceptions thrown during evaluation of either predicate are relayed to the * caller; if evaluation of this predicate throws an exception, the {@code other} * predicate will not be evaluated. * * @param other * a predicate that will be logically-ORed with this predicate * * @return a composed predicate that represents the short-circuiting logical OR of * this predicate and the {@code other} predicate * * @throws NullPointerException * if other is null */ @Nonnull default ShortPredicate or(@Nonnull ShortPredicate other) { Objects.requireNonNull(other); return value -> test(value) || other.test(value); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy