com.landawn.abacus.util.function.IntPredicate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation
A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.
There is a newer version: 5.2.4
/*
 * Copyright (C) 2016 HaiYang Li
 *
 * 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 com.landawn.abacus.util.function;

import com.landawn.abacus.util.N;
import com.landawn.abacus.util.Throwables;

/**
 * Refer to JDK API documentation at: https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html
 * @since 0.8
 *
 * @author Haiyang Li
 */
public interface IntPredicate extends Throwables.IntPredicate, java.util.function.IntPredicate { //NOSONAR

    IntPredicate ALWAYS_TRUE = value -> true;

    IntPredicate ALWAYS_FALSE = value -> false;

    IntPredicate IS_ZERO = value -> value == 0;

    IntPredicate NOT_ZERO = value -> value != 0;

    IntPredicate IS_POSITIVE = value -> value > 0;

    IntPredicate NOT_POSITIVE = value -> value <= 0;

    IntPredicate IS_NEGATIVE = value -> value < 0;

    IntPredicate NOT_NEGATIVE = value -> value >= 0;

    /**
     * 
     *
     * @param value 
     * @return 
     */
    @Override
    boolean test(int value);

    /**
     * 
     *
     * @return 
     */
    @Override
    default IntPredicate negate() {
        return value -> !test(value);
    }

    /**
     * 
     *
     * @param other 
     * @return 
     */
    @Override
    default IntPredicate and(java.util.function.IntPredicate other) {
        N.checkArgNotNull(other);
        return value -> test(value) && other.test(value);
    }

    /**
     * 
     *
     * @param other 
     * @return 
     */
    @Override
    default IntPredicate or(java.util.function.IntPredicate other) {
        N.checkArgNotNull(other);
        return value -> test(value) || other.test(value);
    }

    /**
     * Returns the specified instance.
     *
     * @param predicate 
     * @return 
     */
    static IntPredicate of(final IntPredicate predicate) {
        N.checkArgNotNull(predicate);

        return predicate;
    }

    /**
     * 
     *
     * @param targetInt 
     * @return 
     */
    static IntPredicate equal(int targetInt) { //NOSONAR
        return value -> value == targetInt;
    }

    /**
     * 
     *
     * @param targetInt 
     * @return 
     */
    static IntPredicate notEqual(int targetInt) {
        return value -> value != targetInt;
    }

    /**
     * 
     *
     * @param targetInt 
     * @return 
     */
    static IntPredicate greaterThan(int targetInt) {
        return value -> value > targetInt;
    }

    /**
     * 
     *
     * @param targetInt 
     * @return 
     */
    static IntPredicate greaterEqual(int targetInt) {
        return value -> value >= targetInt;
    }

    /**
     * 
     *
     * @param targetInt 
     * @return 
     */
    static IntPredicate lessThan(int targetInt) {
        return value -> value < targetInt;
    }

    /**
     * 
     *
     * @param targetInt 
     * @return 
     */
    static IntPredicate lessEqual(int targetInt) {
        return value -> value <= targetInt;
    }

    /**
     * 
     *
     * @param minValue 
     * @param maxValue 
     * @return 
     */
    static IntPredicate between(int minValue, int maxValue) {
        return value -> value > minValue && value < maxValue;
    }
}