io.github.suppierk.java.util.function.ThrowablePredicate Maven / Gradle / Ivy
Show all versions of java-throwable-utils Show documentation
/*
* MIT License
*
* Copyright (c) 2020 Roman Khlebnov
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package io.github.suppierk.java.util.function;
import io.github.suppierk.java.util.ExceptionSuppressor;
import java.util.Objects;
import java.util.function.Predicate;
/**
* Represents a predicate (boolean-valued function) of one argument.
*
* Permits checked exceptions unlike {@link Predicate}
*
*
This is a functional interface whose functional method is
* {@link #test(Object)}.
*
* @param the type of the input to the predicate
*/
@FunctionalInterface
@SuppressWarnings("squid:S112")
public interface ThrowablePredicate extends Predicate {
/**
* Evaluates this predicate on the given argument.
*
* @param t the input argument
* @return {@code true} if the input argument matches the predicate, otherwise {@code false}
* @throws Throwable occurred during processing
*/
boolean testUnsafe(T t) throws Throwable;
/**
* Evaluates this predicate on the given argument.
*
* @param t the input argument
* @return {@code true} if the input argument matches the predicate, otherwise {@code false}
*/
@Override
default boolean test(T t) {
try {
return testUnsafe(t);
} catch (Throwable throwable) {
return ExceptionSuppressor.asUnchecked(throwable);
}
}
/**
* Returns a predicate that tests if two arguments are equal according to {@link
* Objects#equals(Object, Object)}.
*
* @param the type of arguments to the predicate
* @param targetRef the object reference with which to compare for equality, which may be {@code
* null}
* @return a predicate that tests if two arguments are equal according to {@link
* Objects#equals(Object, Object)}
*/
static ThrowablePredicate isEqual(Object targetRef) {
return (null == targetRef) ? Objects::isNull : targetRef::equals;
}
}