Java tutorial
/* * Copyright (c) 2016 Gridtec. All rights reserved. * * 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 at.gridtec.lambda4j.predicate.tri; import at.gridtec.lambda4j.Lambda; import at.gridtec.lambda4j.consumer.BooleanConsumer; import at.gridtec.lambda4j.consumer.tri.TriCharConsumer; import at.gridtec.lambda4j.function.BooleanFunction; import at.gridtec.lambda4j.function.conversion.BooleanToByteFunction; import at.gridtec.lambda4j.function.conversion.BooleanToCharFunction; import at.gridtec.lambda4j.function.conversion.BooleanToDoubleFunction; import at.gridtec.lambda4j.function.conversion.BooleanToFloatFunction; import at.gridtec.lambda4j.function.conversion.BooleanToIntFunction; import at.gridtec.lambda4j.function.conversion.BooleanToLongFunction; import at.gridtec.lambda4j.function.conversion.BooleanToShortFunction; import at.gridtec.lambda4j.function.conversion.ByteToCharFunction; import at.gridtec.lambda4j.function.conversion.DoubleToCharFunction; import at.gridtec.lambda4j.function.conversion.FloatToCharFunction; import at.gridtec.lambda4j.function.conversion.IntToCharFunction; import at.gridtec.lambda4j.function.conversion.LongToCharFunction; import at.gridtec.lambda4j.function.conversion.ShortToCharFunction; import at.gridtec.lambda4j.function.to.ToCharFunction; import at.gridtec.lambda4j.function.tri.TriCharFunction; import at.gridtec.lambda4j.function.tri.conversion.TriCharToByteFunction; import at.gridtec.lambda4j.function.tri.conversion.TriCharToDoubleFunction; import at.gridtec.lambda4j.function.tri.conversion.TriCharToFloatFunction; import at.gridtec.lambda4j.function.tri.conversion.TriCharToIntFunction; import at.gridtec.lambda4j.function.tri.conversion.TriCharToLongFunction; import at.gridtec.lambda4j.function.tri.conversion.TriCharToShortFunction; import at.gridtec.lambda4j.operator.ternary.BooleanTernaryOperator; import at.gridtec.lambda4j.operator.ternary.CharTernaryOperator; import at.gridtec.lambda4j.operator.unary.BooleanUnaryOperator; import at.gridtec.lambda4j.operator.unary.CharUnaryOperator; import at.gridtec.lambda4j.predicate.CharPredicate; import at.gridtec.lambda4j.predicate.bi.BiCharPredicate; import org.apache.commons.lang3.tuple.Triple; import javax.annotation.Nonnegative; import javax.annotation.Nonnull; import javax.annotation.Nullable; import java.util.Map; import java.util.Objects; import java.util.concurrent.ConcurrentHashMap; /** * Represents an predicate (boolean-valued function) of three {@code char}-valued input arguments. * This is a primitive specialization of {@link TriPredicate}. * <p> * This is a {@link FunctionalInterface} whose functional method is {@link #test(char, char, char)}. * * @see TriPredicate */ @SuppressWarnings("unused") @FunctionalInterface public interface TriCharPredicate extends Lambda { /** * Constructs a {@link TriCharPredicate} based on a lambda expression or a method reference. Thereby the given * lambda expression or method reference is returned on an as-is basis to implicitly transform it to the desired * type. With this method, it is possible to ensure that correct type is used from lambda expression or method * reference. * * @param expression A lambda expression or (typically) a method reference, e.g. {@code this::method} * @return A {@code TriCharPredicate} from given lambda expression or method reference. * @implNote This implementation allows the given argument to be {@code null}, but only if {@code null} given, * {@code null} will be returned. * @see <a href="https://docs.oracle.com/javase/tutorial/java/javaOO/lambdaexpressions.html#syntax">Lambda * Expression</a> * @see <a href="https://docs.oracle.com/javase/tutorial/java/javaOO/methodreferences.html">Method Reference</a> */ static TriCharPredicate of(@Nullable final TriCharPredicate expression) { return expression; } /** * Calls the given {@link TriCharPredicate} with the given arguments and returns its result. * * @param predicate The predicate to be called * @param value1 The first argument to the predicate * @param value2 The second argument to the predicate * @param value3 The third argument to the predicate * @return The result from the given {@code TriCharPredicate}. * @throws NullPointerException If given argument is {@code null} */ static boolean call(@Nonnull final TriCharPredicate predicate, char value1, char value2, char value3) { Objects.requireNonNull(predicate); return predicate.test(value1, value2, value3); } /** * Creates a {@link TriCharPredicate} which uses the {@code first} parameter of this one as argument for the given * {@link CharPredicate}. * * @param predicate The predicate which accepts the {@code first} parameter of this one * @return Creates a {@code TriCharPredicate} which uses the {@code first} parameter of this one as argument for the * given {@code CharPredicate}. * @throws NullPointerException If given argument is {@code null} */ @Nonnull static TriCharPredicate onlyFirst(@Nonnull final CharPredicate predicate) { Objects.requireNonNull(predicate); return (value1, value2, value3) -> predicate.test(value1); } /** * Creates a {@link TriCharPredicate} which uses the {@code second} parameter of this one as argument for the given * {@link CharPredicate}. * * @param predicate The predicate which accepts the {@code second} parameter of this one * @return Creates a {@code TriCharPredicate} which uses the {@code second} parameter of this one as argument for * the given {@code CharPredicate}. * @throws NullPointerException If given argument is {@code null} */ @Nonnull static TriCharPredicate onlySecond(@Nonnull final CharPredicate predicate) { Objects.requireNonNull(predicate); return (value1, value2, value3) -> predicate.test(value2); } /** * Creates a {@link TriCharPredicate} which uses the {@code third} parameter of this one as argument for the given * {@link CharPredicate}. * * @param predicate The predicate which accepts the {@code third} parameter of this one * @return Creates a {@code TriCharPredicate} which uses the {@code third} parameter of this one as argument for the * given {@code CharPredicate}. * @throws NullPointerException If given argument is {@code null} */ @Nonnull static TriCharPredicate onlyThird(@Nonnull final CharPredicate predicate) { Objects.requireNonNull(predicate); return (value1, value2, value3) -> predicate.test(value3); } /** * Creates a {@link TriCharPredicate} which always returns a given value. * * @param ret The return value for the constant * @return A {@code TriCharPredicate} which always returns a given value. */ @Nonnull static TriCharPredicate constant(boolean ret) { return (value1, value2, value3) -> ret; } /** * Returns a {@link TriCharPredicate} that always returns {@code true}. * * @return A {@link TriCharPredicate} that always returns {@code true}. * @see #alwaysFalse() */ @Nonnull static TriCharPredicate alwaysTrue() { return (value1, value2, value3) -> true; } /** * Returns a {@link TriCharPredicate} that always returns {@code false}. * * @return A {@link TriCharPredicate} that always returns {@code false}. * @see #alwaysTrue() */ @Nonnull static TriCharPredicate alwaysFalse() { return (value1, value2, value3) -> false; } /** * Returns a {@link TriCharPredicate} that tests if the given arguments are <b>equal</b> to the ones of this * predicate. * * @param target1 The first reference with which to compare for equality, which may be {@code null} * @param target2 The second reference with which to compare for equality, which may be {@code null} * @param target3 The third reference with which to compare for equality, which may be {@code null} * @return A {@code TriCharPredicate} that tests if the given arguments are <b>equal</b> to the ones of this * predicate. * @implNote This implementation checks equality according to {@link Objects#equals(Object)} operation for {@link * Object} references and {@code value == target} operation for primitive values. */ @Nonnull static TriCharPredicate isEqual(char target1, char target2, char target3) { return (value1, value2, value3) -> (value1 == target1) && (value2 == target2) && (value3 == target3); } /** * Applies this predicate to the given arguments. * * @param value1 The first argument to the predicate * @param value2 The second argument to the predicate * @param value3 The third argument to the predicate * @return The return value from the predicate, which is its result. */ boolean test(char value1, char value2, char value3); /** * Applies this predicate partially to some arguments of this one, producing a {@link BiCharPredicate} as result. * * @param value1 The first argument to this predicate used to partially apply this function * @return A {@code BiCharPredicate} that represents this predicate partially applied the some arguments. */ @Nonnull default BiCharPredicate ptest(char value1) { return (value2, value3) -> this.test(value1, value2, value3); } /** * Applies this predicate partially to some arguments of this one, producing a {@link CharPredicate} as result. * * @param value1 The first argument to this predicate used to partially apply this function * @param value2 The second argument to this predicate used to partially apply this function * @return A {@code CharPredicate} that represents this predicate partially applied the some arguments. */ @Nonnull default CharPredicate ptest(char value1, char value2) { return (value3) -> this.test(value1, value2, value3); } /** * Returns the number of arguments for this predicate. * * @return The number of arguments for this predicate. * @implSpec The default implementation always returns {@code 3}. */ @Nonnegative default int arity() { return 3; } /** * Returns a composed {@link TriPredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. * If evaluation of either operation throws an exception, it is relayed to the caller of the composed operation. * * @param <A> The type of the argument to the first given function, and of composed predicate * @param <B> The type of the argument to the second given function, and of composed predicate * @param <C> The type of the argument to the third given function, and of composed predicate * @param before1 The first function to apply before this predicate is applied * @param before2 The second function to apply before this predicate is applied * @param before3 The third function to apply before this predicate is applied * @return A composed {@code TriPredicate} that first applies the {@code before} functions to its input, and then * applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is able to handle every type. */ @Nonnull default <A, B, C> TriPredicate<A, B, C> compose(@Nonnull final ToCharFunction<? super A> before1, @Nonnull final ToCharFunction<? super B> before2, @Nonnull final ToCharFunction<? super C> before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (a, b, c) -> test(before1.applyAsChar(a), before2.applyAsChar(b), before3.applyAsChar(c)); } /** * Returns a composed {@link BooleanTernaryOperator} that first applies the {@code before} functions to its input, * and then applies this predicate to the result. If evaluation of either operation throws an exception, it is * relayed to the caller of the composed operation. This method is just convenience, to provide the ability to * execute an operation which accepts {@code boolean} input, before this primitive predicate is executed. * * @param before1 The first function to apply before this predicate is applied * @param before2 The second function to apply before this predicate is applied * @param before3 The third function to apply before this predicate is applied * @return A composed {@code BooleanTernaryOperator} that first applies the {@code before} functions to its input, * and then applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to handle primitive values. In this case this is {@code * boolean}. */ @Nonnull default BooleanTernaryOperator composeFromBoolean(@Nonnull final BooleanToCharFunction before1, @Nonnull final BooleanToCharFunction before2, @Nonnull final BooleanToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> test(before1.applyAsChar(value1), before2.applyAsChar(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriBytePredicate} that first applies the {@code before} functions to * its input, and then applies this predicate to the result. * If evaluation of either operation throws an exception, it is relayed to the caller of the composed operation. * This method is just convenience, to provide the ability to execute an operation which accepts {@code byte} input, * before this primitive predicate is executed. * * @param before1 The first function to apply before this predicate is applied * @param before2 The second function to apply before this predicate is applied * @param before3 The third function to apply before this predicate is applied * @return A composed {@code TriBytePredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to handle primitive values. In this case this is {@code * byte}. */ @Nonnull default TriBytePredicate composeFromByte(@Nonnull final ByteToCharFunction before1, @Nonnull final ByteToCharFunction before2, @Nonnull final ByteToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> test(before1.applyAsChar(value1), before2.applyAsChar(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriCharPredicate} that first applies the {@code before} operators to * its input, and then applies this predicate to the result. * If evaluation of either operation throws an exception, it is relayed to the caller of the composed operation. * This method is just convenience, to provide the ability to execute an operation which accepts {@code char} input, * before this primitive predicate is executed. * * @param before1 The first operator to apply before this predicate is applied * @param before2 The second operator to apply before this predicate is applied * @param before3 The third operator to apply before this predicate is applied * @return A composed {@code TriCharPredicate} that first applies the {@code before} operators to its input, and * then applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to handle primitive values. In this case this is {@code * char}. */ @Nonnull default TriCharPredicate composeFromChar(@Nonnull final CharUnaryOperator before1, @Nonnull final CharUnaryOperator before2, @Nonnull final CharUnaryOperator before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> test(before1.applyAsChar(value1), before2.applyAsChar(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriDoublePredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. If evaluation of either operation throws an exception, it is relayed * to the caller of the composed operation. This method is just convenience, to provide the ability to execute an * operation which accepts {@code double} input, before this primitive predicate is executed. * * @param before1 The first function to apply before this predicate is applied * @param before2 The second function to apply before this predicate is applied * @param before3 The third function to apply before this predicate is applied * @return A composed {@code TriDoublePredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to handle primitive values. In this case this is {@code * double}. */ @Nonnull default TriDoublePredicate composeFromDouble(@Nonnull final DoubleToCharFunction before1, @Nonnull final DoubleToCharFunction before2, @Nonnull final DoubleToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> test(before1.applyAsChar(value1), before2.applyAsChar(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriFloatPredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. If evaluation of either operation throws an exception, it is relayed * to the caller of the composed operation. This method is just convenience, to provide the ability to execute an * operation which accepts {@code float} input, before this primitive predicate is executed. * * @param before1 The first function to apply before this predicate is applied * @param before2 The second function to apply before this predicate is applied * @param before3 The third function to apply before this predicate is applied * @return A composed {@code TriFloatPredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to handle primitive values. In this case this is {@code * float}. */ @Nonnull default TriFloatPredicate composeFromFloat(@Nonnull final FloatToCharFunction before1, @Nonnull final FloatToCharFunction before2, @Nonnull final FloatToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> test(before1.applyAsChar(value1), before2.applyAsChar(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriIntPredicate} that first applies the {@code before} functions to * its input, and then applies this predicate to the result. * If evaluation of either operation throws an exception, it is relayed to the caller of the composed operation. * This method is just convenience, to provide the ability to execute an operation which accepts {@code int} input, * before this primitive predicate is executed. * * @param before1 The first function to apply before this predicate is applied * @param before2 The second function to apply before this predicate is applied * @param before3 The third function to apply before this predicate is applied * @return A composed {@code TriIntPredicate} that first applies the {@code before} functions to its input, and then * applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to handle primitive values. In this case this is {@code * int}. */ @Nonnull default TriIntPredicate composeFromInt(@Nonnull final IntToCharFunction before1, @Nonnull final IntToCharFunction before2, @Nonnull final IntToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> test(before1.applyAsChar(value1), before2.applyAsChar(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriLongPredicate} that first applies the {@code before} functions to * its input, and then applies this predicate to the result. * If evaluation of either operation throws an exception, it is relayed to the caller of the composed operation. * This method is just convenience, to provide the ability to execute an operation which accepts {@code long} input, * before this primitive predicate is executed. * * @param before1 The first function to apply before this predicate is applied * @param before2 The second function to apply before this predicate is applied * @param before3 The third function to apply before this predicate is applied * @return A composed {@code TriLongPredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to handle primitive values. In this case this is {@code * long}. */ @Nonnull default TriLongPredicate composeFromLong(@Nonnull final LongToCharFunction before1, @Nonnull final LongToCharFunction before2, @Nonnull final LongToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> test(before1.applyAsChar(value1), before2.applyAsChar(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriShortPredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. If evaluation of either operation throws an exception, it is relayed * to the caller of the composed operation. This method is just convenience, to provide the ability to execute an * operation which accepts {@code short} input, before this primitive predicate is executed. * * @param before1 The first function to apply before this predicate is applied * @param before2 The second function to apply before this predicate is applied * @param before3 The third function to apply before this predicate is applied * @return A composed {@code TriShortPredicate} that first applies the {@code before} functions to its input, and * then applies this predicate to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to handle primitive values. In this case this is {@code * short}. */ @Nonnull default TriShortPredicate composeFromShort(@Nonnull final ShortToCharFunction before1, @Nonnull final ShortToCharFunction before2, @Nonnull final ShortToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> test(before1.applyAsChar(value1), before2.applyAsChar(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriCharFunction} that first applies this predicate to its input, and then applies the * {@code after} function to the result. * If evaluation of either operation throws an exception, it is relayed to the caller of the composed operation. * * @param <S> The type of return value from the {@code after} function, and of the composed function * @param after The function to apply after this predicate is applied * @return A composed {@code TriCharFunction} that first applies this predicate to its input, and then applies the * {@code after} function to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is able to return every type. */ @Nonnull default <S> TriCharFunction<S> andThen(@Nonnull final BooleanFunction<? extends S> after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.apply(test(value1, value2, value3)); } /** * Returns a composed {@link TriCharPredicate} that first applies this predicate to its input, and then applies the * {@code after} operator to the result. If evaluation of either operation throws an exception, it is relayed to the * caller of the composed operation. This method is just convenience, to provide the ability to transform this * primitive predicate to an operation returning {@code boolean}. * * @param after The operator to apply after this predicate is applied * @return A composed {@code TriCharPredicate} that first applies this predicate to its input, and then applies the * {@code after} operator to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to return primitive values. In this case this is {@code * boolean}. */ @Nonnull default TriCharPredicate andThenToBoolean(@Nonnull final BooleanUnaryOperator after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.applyAsBoolean(test(value1, value2, value3)); } /** * Returns a composed {@link TriCharToByteFunction} that first applies this predicate to its input, and then applies * the {@code after} function to the result. If evaluation of either operation throws an exception, it is relayed to * the caller of the composed operation. This method is just convenience, to provide the ability to transform this * primitive predicate to an operation returning {@code byte}. * * @param after The function to apply after this predicate is applied * @return A composed {@code TriCharToByteFunction} that first applies this predicate to its input, and then applies * the {@code after} function to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to return primitive values. In this case this is {@code * byte}. */ @Nonnull default TriCharToByteFunction andThenToByte(@Nonnull final BooleanToByteFunction after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.applyAsByte(test(value1, value2, value3)); } /** * Returns a composed {@link CharTernaryOperator} that first applies this predicate to its input, and then applies * the {@code after} function to the result. If evaluation of either operation throws an exception, it is relayed to * the caller of the composed operation. This method is just convenience, to provide the ability to transform this * primitive predicate to an operation returning {@code char}. * * @param after The function to apply after this predicate is applied * @return A composed {@code CharTernaryOperator} that first applies this predicate to its input, and then applies * the {@code after} function to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to return primitive values. In this case this is {@code * char}. */ @Nonnull default CharTernaryOperator andThenToChar(@Nonnull final BooleanToCharFunction after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.applyAsChar(test(value1, value2, value3)); } /** * Returns a composed {@link TriCharToDoubleFunction} that first applies this predicate to its input, and then * applies the {@code after} function to the result. If evaluation of either operation throws an exception, it is * relayed to the caller of the composed operation. This method is just convenience, to provide the ability to * transform this primitive predicate to an operation returning {@code double}. * * @param after The function to apply after this predicate is applied * @return A composed {@code TriCharToDoubleFunction} that first applies this predicate to its input, and then * applies the {@code after} function to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to return primitive values. In this case this is {@code * double}. */ @Nonnull default TriCharToDoubleFunction andThenToDouble(@Nonnull final BooleanToDoubleFunction after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.applyAsDouble(test(value1, value2, value3)); } /** * Returns a composed {@link TriCharToFloatFunction} that first applies this predicate to its input, and then * applies the {@code after} function to the result. If evaluation of either operation throws an exception, it is * relayed to the caller of the composed operation. This method is just convenience, to provide the ability to * transform this primitive predicate to an operation returning {@code float}. * * @param after The function to apply after this predicate is applied * @return A composed {@code TriCharToFloatFunction} that first applies this predicate to its input, and then * applies the {@code after} function to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to return primitive values. In this case this is {@code * float}. */ @Nonnull default TriCharToFloatFunction andThenToFloat(@Nonnull final BooleanToFloatFunction after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.applyAsFloat(test(value1, value2, value3)); } /** * Returns a composed {@link TriCharToIntFunction} that first applies this predicate to its input, and then applies * the {@code after} function to the result. If evaluation of either operation throws an exception, it is relayed to * the caller of the composed operation. This method is just convenience, to provide the ability to transform this * primitive predicate to an operation returning {@code int}. * * @param after The function to apply after this predicate is applied * @return A composed {@code TriCharToIntFunction} that first applies this predicate to its input, and then applies * the {@code after} function to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to return primitive values. In this case this is {@code * int}. */ @Nonnull default TriCharToIntFunction andThenToInt(@Nonnull final BooleanToIntFunction after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.applyAsInt(test(value1, value2, value3)); } /** * Returns a composed {@link TriCharToLongFunction} that first applies this predicate to its input, and then applies * the {@code after} function to the result. If evaluation of either operation throws an exception, it is relayed to * the caller of the composed operation. This method is just convenience, to provide the ability to transform this * primitive predicate to an operation returning {@code long}. * * @param after The function to apply after this predicate is applied * @return A composed {@code TriCharToLongFunction} that first applies this predicate to its input, and then applies * the {@code after} function to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to return primitive values. In this case this is {@code * long}. */ @Nonnull default TriCharToLongFunction andThenToLong(@Nonnull final BooleanToLongFunction after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.applyAsLong(test(value1, value2, value3)); } /** * Returns a composed {@link TriCharToShortFunction} that first applies this predicate to its input, and then * applies the {@code after} function to the result. If evaluation of either operation throws an exception, it is * relayed to the caller of the composed operation. This method is just convenience, to provide the ability to * transform this primitive predicate to an operation returning {@code short}. * * @param after The function to apply after this predicate is applied * @return A composed {@code TriCharToShortFunction} that first applies this predicate to its input, and then * applies the {@code after} function to the result. * @throws NullPointerException If given argument is {@code null} * @implSpec The input argument of this method is a able to return primitive values. In this case this is {@code * short}. */ @Nonnull default TriCharToShortFunction andThenToShort(@Nonnull final BooleanToShortFunction after) { Objects.requireNonNull(after); return (value1, value2, value3) -> after.applyAsShort(test(value1, value2, value3)); } /** * Returns a composed {@link TriCharConsumer} that fist applies this predicate to its input, and then consumes the * result using the given {@link BooleanConsumer}. If evaluation of either operation throws an exception, it is * relayed to the caller of the composed operation. * * @param consumer The operation which consumes the result from this operation * @return A composed {@code TriCharConsumer} that first applies this predicate to its input, and then consumes the * result using the given {@code BooleanConsumer}. * @throws NullPointerException If given argument is {@code null} */ @Nonnull default TriCharConsumer consume(@Nonnull final BooleanConsumer consumer) { Objects.requireNonNull(consumer); return (value1, value2, value3) -> consumer.accept(test(value1, value2, value3)); } /** * Returns a {@link TriCharPredicate} that represents the logical negation of this one. * * @return A {@code TriCharPredicate} that represents the logical negation of this one. */ @Nonnull default TriCharPredicate negate() { return (value1, value2, value3) -> !test(value1, value2, value3); } /** * Returns a composed {@link TriCharPredicate} 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. * <p> * Any exceptions thrown during evaluation of either predicate is relayed to the caller; if evaluation of this * {@code TriCharPredicate} throws an exception, the {@code other} predicate will not be evaluated. * * @param other A {@code TriCharPredicate} that will be logically-ANDed with this one * @return A composed {@code TriCharPredicate} that represents the short-circuiting logical AND of this predicate * and the {@code other} predicate. * @throws NullPointerException If given argument is {@code null} * @see #or(TriCharPredicate) * @see #xor(TriCharPredicate) */ @Nonnull default TriCharPredicate and(@Nonnull final TriCharPredicate other) { Objects.requireNonNull(other); return (value1, value2, value3) -> test(value1, value2, value3) && other.test(value1, value2, value3); } /** * Returns a composed {@link TriCharPredicate} 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. * <p> * Any exceptions thrown during evaluation of either predicate is relayed to the caller; if evaluation of this * {@code TriCharPredicate} throws an exception, the {@code other} predicate will not be evaluated. * * @param other A {@code TriCharPredicate} that will be logically-ORed with this one * @return A composed {@code TriCharPredicate} that represents the short-circuiting logical OR of this predicate and * the {@code other} predicate. * @throws NullPointerException If given argument is {@code null} * @see #and(TriCharPredicate) * @see #xor(TriCharPredicate) */ @Nonnull default TriCharPredicate or(@Nonnull final TriCharPredicate other) { Objects.requireNonNull(other); return (value1, value2, value3) -> test(value1, value2, value3) || other.test(value1, value2, value3); } /** * Returns a composed {@link TriCharPredicate} that represents a short-circuiting logical XOR of this predicate and * another. Any exceptions thrown during evaluation of either predicate is relayed to the caller; if evaluation of * this {@code TriCharPredicate} throws an exception, the {@code other} predicate will not be evaluated. * * @param other A {@code TriCharPredicate} that will be logically-XORed with this one * @return A composed {@code TriCharPredicate} that represents the short-circuiting logical XOR of this predicate * and the {@code other} predicate. * @throws NullPointerException If given argument is {@code null} * @see #and(TriCharPredicate) * @see #or(TriCharPredicate) */ @Nonnull default TriCharPredicate xor(@Nonnull final TriCharPredicate other) { Objects.requireNonNull(other); return (value1, value2, value3) -> test(value1, value2, value3) ^ other.test(value1, value2, value3); } /** * Returns a memoized (caching) version of this {@link TriCharPredicate}. Whenever it is called, the mapping between * the input parameters and the return value is preserved in a cache, making subsequent calls returning the memoized * value instead of computing the return value again. * <p> * Unless the predicate and therefore the used cache will be garbage-collected, it will keep all memoized values * forever. * * @return A memoized (caching) version of this {@code TriCharPredicate}. * @implSpec This implementation does not allow the input parameters or return value to be {@code null} for the * resulting memoized predicate, as the cache used internally does not permit {@code null} keys or values. * @implNote The returned memoized predicate can be safely used concurrently from multiple threads which makes it * thread-safe. */ @Nonnull default TriCharPredicate memoized() { if (isMemoized()) { return this; } else { final Map<Triple<Character, Character, Character>, Boolean> cache = new ConcurrentHashMap<>(); final Object lock = new Object(); return (TriCharPredicate & Memoized) (value1, value2, value3) -> { final boolean returnValue; synchronized (lock) { returnValue = cache.computeIfAbsent(Triple.of(value1, value2, value3), key -> test(key.getLeft(), key.getMiddle(), key.getRight())); } return returnValue; }; } } /** * Returns a composed {@link TriPredicate} which represents this {@link TriCharPredicate}. Thereby the primitive * input argument for this predicate is autoboxed. This method provides the possibility to use this * {@code TriCharPredicate} with methods provided by the {@code JDK}. * * @return A composed {@code TriPredicate} which represents this {@code TriCharPredicate}. */ @Nonnull default TriPredicate<Character, Character, Character> boxed() { return this::test; } }