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

/*
 * 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.Try;

/**
 * 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 java.util.function.IntPredicate, Try.IntPredicate {

    static final IntPredicate ALWAYS_TRUE = new IntPredicate() {
        @Override
        public boolean test(int value) {
            return true;
        }
    };

    static final IntPredicate ALWAYS_FALSE = new IntPredicate() {
        @Override
        public boolean test(int value) {
            return false;
        }
    };

    static final IntPredicate IS_ZERO = new IntPredicate() {
        @Override
        public boolean test(int value) {
            return value == 0;
        }
    };

    static final IntPredicate NOT_ZERO = new IntPredicate() {
        @Override
        public boolean test(int value) {
            return value != 0;
        }
    };

    static final IntPredicate IS_POSITIVE = new IntPredicate() {
        @Override
        public boolean test(int value) {
            return value > 0;
        }
    };

    static final IntPredicate NOT_POSITIVE = new IntPredicate() {
        @Override
        public boolean test(int value) {
            return value <= 0;
        }
    };

    static final IntPredicate IS_NEGATIVE = new IntPredicate() {
        @Override
        public boolean test(int value) {
            return value < 0;
        }
    };

    static final IntPredicate NOT_NEGATIVE = new IntPredicate() {
        @Override
        public boolean test(int value) {
            return value >= 0;
        }
    };

    @Override
    boolean test(int value);

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

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

    @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;
    }

    static IntPredicate equal(int targetInt) {
        return value -> value == targetInt;
    }

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

    static IntPredicate greaterThan(int targetInt) {
        return value -> value > targetInt;
    }

    static IntPredicate greaterEqual(int targetInt) {
        return value -> value >= targetInt;
    }

    static IntPredicate lessThan(int targetInt) {
        return value -> value < targetInt;
    }

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

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