net.yetamine.lang.functional.BiPredicates Maven / Gradle / Ivy
Show all versions of net.yetamine.lang Show documentation
/*
* 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;
import java.util.Objects;
import java.util.function.BiPredicate;
/**
* A utility class providing several {@link BiPredicate} implementations.
*/
public final class BiPredicates {
/**
* Prevents creating instances of this class.
*/
private BiPredicates() {
throw new AssertionError();
}
/**
* Makes an instance from the given predicate.
*
*
* This method is a convenient factory method for fluent making a predicate:
*
*
* BiPredicates.from(MyUtilities::someTest).negate()
*
*
* @param
* the type of the first parameter
* @param
* the type of the second parameter
* @param predicate
* the predicate to return. It must not be {@code null}.
*
* @return the predicate
*/
@SuppressWarnings("unchecked")
public static BiPredicate from(BiPredicate predicate) {
return (BiPredicate) predicate;
}
/**
* Returns a predicate that yields always {@code false}.
*
* @param
* the type of the first parameter
* @param
* the type of the second parameter
*
* @return the predicate
*/
public static BiPredicate alwaysFalse() {
return (t, u) -> false;
}
/**
* Returns a predicate that yields always {@code true}.
*
* @param
* the type of the first parameter
* @param
* the type of the second parameter
*
* @return the predicate
*/
public static BiPredicate alwaysTrue() {
return (t, u) -> true;
}
/**
* Returns a predicate that computes a conjunction of all given predicates;
* the computation uses short-circuit evaluation.
*
*
* This method does not make any copy of the input, therefore the caller may
* provide a dynamic underlying sequence, but on the other hand, the caller
* is responsible for thread safety of the sequence, so that another thread
* may iterate through the sequence, having a consistent snapshot.
*
*
* This method may be useful in the cases of a dynamic chain or when simply
* the sequence is long and chaining the predicates causes too deep call
* nesting.
*
* @param
* the type of the first parameter
* @param
* the type of the second parameter
* @param sequence
* the sequence of the predicates to apply. It must not be
* {@code null} and it must not provide {@code null} elements.
*
* @return a predicate that computes a conjunction of all given predicates
*/
public static BiPredicate allOf(Iterable> sequence) {
Objects.requireNonNull(sequence);
return (t, u) -> {
for (BiPredicate predicate : sequence) {
if (!predicate.test(t, u)) {
return false;
}
}
return true;
};
}
/**
* Returns a predicate that yields {@code true} only if none of all given
* predicates returns {@code true}; the computation uses short-circuit
* evaluation.
*
*
* This method does not make any copy of the input, therefore the caller may
* provide a dynamic underlying sequence, but on the other hand, the caller
* is responsible for thread safety of the sequence, so that another thread
* may iterate through the sequence, having a consistent snapshot.
*
*
* This method may be useful in the cases of a dynamic chain or when simply
* the sequence is long and chaining the predicates causes too deep call
* nesting.
*
* @param
* the type of the first parameter
* @param
* the type of the second parameter
* @param sequence
* the sequence of the predicates to apply. It must not be
* {@code null} and it must not provide {@code null} elements.
*
* @return a predicate that yields {@code true} only if none of all given
* predicates returns {@code true}
*/
public static BiPredicate noneOf(Iterable> sequence) {
Objects.requireNonNull(sequence);
return (t, u) -> {
for (BiPredicate predicate : sequence) {
if (predicate.test(t, u)) {
return false;
}
}
return true;
};
}
/**
* Returns a predicate that computes a dijunction of all given predicates;
* the computation uses short-circuit evaluation.
*
*
* This method does not make any copy of the input, therefore the caller may
* provide a dynamic underlying sequence, but on the other hand, the caller
* is responsible for thread safety of the sequence, so that another thread
* may iterate through the sequence, having a consistent snapshot.
*
*
* This method may be useful in the cases of a dynamic chain or when simply
* the sequence is long and chaining the predicates causes too deep call
* nesting.
*
* @param
* the type of the first parameter
* @param
* the type of the second parameter
* @param sequence
* the sequence of the predicates to apply. It must not be
* {@code null} and it must not provide {@code null} elements.
*
* @return a predicate that computes a disjunction of all given predicates
*/
public static BiPredicate anyOf(Iterable> sequence) {
Objects.requireNonNull(sequence);
return (t, u) -> {
for (BiPredicate predicate : sequence) {
if (predicate.test(t, u)) {
return true;
}
}
return false;
};
}
}