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.consumer.tri.obj; import at.gridtec.lambda4j.Lambda; import at.gridtec.lambda4j.consumer.CharConsumer; import at.gridtec.lambda4j.consumer.Consumer2; import at.gridtec.lambda4j.consumer.bi.BiConsumer2; import at.gridtec.lambda4j.consumer.bi.obj.ObjCharConsumer; import at.gridtec.lambda4j.consumer.tri.TriBooleanConsumer; import at.gridtec.lambda4j.consumer.tri.TriByteConsumer; import at.gridtec.lambda4j.consumer.tri.TriCharConsumer; import at.gridtec.lambda4j.consumer.tri.TriConsumer; import at.gridtec.lambda4j.consumer.tri.TriDoubleConsumer; import at.gridtec.lambda4j.consumer.tri.TriFloatConsumer; import at.gridtec.lambda4j.consumer.tri.TriIntConsumer; import at.gridtec.lambda4j.consumer.tri.TriLongConsumer; import at.gridtec.lambda4j.consumer.tri.TriShortConsumer; import at.gridtec.lambda4j.function.BooleanFunction; import at.gridtec.lambda4j.function.ByteFunction; import at.gridtec.lambda4j.function.CharFunction; import at.gridtec.lambda4j.function.FloatFunction; import at.gridtec.lambda4j.function.ShortFunction; import at.gridtec.lambda4j.function.conversion.BooleanToCharFunction; 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.operator.unary.CharUnaryOperator; import org.apache.commons.lang3.tuple.Pair; import javax.annotation.Nonnegative; import javax.annotation.Nonnull; import javax.annotation.Nullable; import java.util.Objects; import java.util.function.Consumer; import java.util.function.DoubleFunction; import java.util.function.Function; import java.util.function.IntFunction; import java.util.function.LongFunction; /** * Represents an operation that accepts two object-valued and one {@code char}-valued input argument and returns no * result. This is a (reference, reference, char) specialization of {@link TriConsumer}. Unlike most other functional * interfaces, {@code BiObjCharConsumer} is expected to operate via side-effects. * <p> * This is a {@link FunctionalInterface} whose functional method is {@link #accept(Object, Object, char)}. * * @param <T> The type of the first argument to the consumer * @param <U> The type of the second argument to the consumer * @see TriConsumer */ @SuppressWarnings("unused") @FunctionalInterface public interface BiObjCharConsumer<T, U> extends Lambda { /** * Constructs a {@link BiObjCharConsumer} 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 <T> The type of the first argument to the consumer * @param <U> The type of the second argument to the consumer * @param expression A lambda expression or (typically) a method reference, e.g. {@code this::method} * @return A {@code BiObjCharConsumer} 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 <T, U> BiObjCharConsumer<T, U> of(@Nullable final BiObjCharConsumer<T, U> expression) { return expression; } /** * Calls the given {@link BiObjCharConsumer} with the given arguments and returns its result. * * @param <T> The type of the first argument to the consumer * @param <U> The type of the second argument to the consumer * @param consumer The consumer to be called * @param t The first argument to the consumer * @param u The second argument to the consumer * @param value The third argument to the consumer * @throws NullPointerException If given argument is {@code null} */ static <T, U> void call(@Nonnull final BiObjCharConsumer<? super T, ? super U> consumer, T t, U u, char value) { Objects.requireNonNull(consumer); consumer.accept(t, u, value); } /** * Creates a {@link BiObjCharConsumer} which uses the {@code first} parameter of this one as argument for the given * {@link Consumer}. * * @param <T> The type of the first argument to the consumer * @param <U> The type of the second argument to the consumer * @param consumer The consumer which accepts the {@code first} parameter of this one * @return Creates a {@code BiObjCharConsumer} which uses the {@code first} parameter of this one as argument for * the given {@code Consumer}. * @throws NullPointerException If given argument is {@code null} */ @Nonnull static <T, U> BiObjCharConsumer<T, U> onlyFirst(@Nonnull final Consumer<? super T> consumer) { Objects.requireNonNull(consumer); return (t, u, value) -> consumer.accept(t); } /** * Creates a {@link BiObjCharConsumer} which uses the {@code second} parameter of this one as argument for the given * {@link Consumer}. * * @param <T> The type of the first argument to the consumer * @param <U> The type of the second argument to the consumer * @param consumer The consumer which accepts the {@code second} parameter of this one * @return Creates a {@code BiObjCharConsumer} which uses the {@code second} parameter of this one as argument for * the given {@code Consumer}. * @throws NullPointerException If given argument is {@code null} */ @Nonnull static <T, U> BiObjCharConsumer<T, U> onlySecond(@Nonnull final Consumer<? super U> consumer) { Objects.requireNonNull(consumer); return (t, u, value) -> consumer.accept(u); } /** * Creates a {@link BiObjCharConsumer} which uses the {@code third} parameter of this one as argument for the given * {@link CharConsumer}. * * @param <T> The type of the first argument to the consumer * @param <U> The type of the second argument to the consumer * @param consumer The consumer which accepts the {@code third} parameter of this one * @return Creates a {@code BiObjCharConsumer} which uses the {@code third} parameter of this one as argument for * the given {@code CharConsumer}. * @throws NullPointerException If given argument is {@code null} */ @Nonnull static <T, U> BiObjCharConsumer<T, U> onlyThird(@Nonnull final CharConsumer consumer) { Objects.requireNonNull(consumer); return (t, u, value) -> consumer.accept(value); } /** * Applies this consumer to the given arguments. * * @param t The first argument to the consumer * @param u The second argument to the consumer * @param value The third argument to the consumer */ void accept(T t, U u, char value); /** * Applies this consumer to the given tuple. * * @param tuple The tuple to be applied to the consumer * @param value The primitive value to be applied to the consumer * @throws NullPointerException If given argument is {@code null} * @see org.apache.commons.lang3.tuple.Pair */ default void accept(@Nonnull Pair<T, U> tuple, char value) { Objects.requireNonNull(tuple); accept(tuple.getLeft(), tuple.getRight(), value); } /** * Applies this consumer partially to some arguments of this one, producing a {@link ObjCharConsumer} as result. * * @param t The first argument to this consumer used to partially apply this function * @return A {@code ObjCharConsumer} that represents this consumer partially applied the some arguments. */ @Nonnull default ObjCharConsumer<U> paccept(T t) { return (u, value) -> this.accept(t, u, value); } /** * Applies this consumer partially to some arguments of this one, producing a {@link CharConsumer} as result. * * @param t The first argument to this consumer used to partially apply this function * @param u The second argument to this consumer used to partially apply this function * @return A {@code CharConsumer} that represents this consumer partially applied the some arguments. */ @Nonnull default CharConsumer paccept(T t, U u) { return (value) -> this.accept(t, u, value); } /** * Applies this consumer partially to some arguments of this one, producing a {@link BiConsumer2} as result. * * @param value The third argument to this consumer used to partially apply this function * @return A {@code BiConsumer2} that represents this consumer partially applied the some arguments. */ @Nonnull default BiConsumer2<T, U> paccept(char value) { return (t, u) -> this.accept(t, u, value); } /** * Applies this consumer partially to some arguments of this one, producing a {@link Consumer2} as result. * * @param t The first argument to this consumer used to partially apply this function * @param value The third argument to this consumer used to partially apply this function * @return A {@code Consumer2} that represents this consumer partially applied the some arguments. */ @Nonnull default Consumer2<U> paccept(T t, char value) { return (u) -> this.accept(t, u, value); } /** * Returns the number of arguments for this consumer. * * @return The number of arguments for this consumer. * @implSpec The default implementation always returns {@code 3}. */ @Nonnegative default int arity() { return 3; } /** * Returns a composed {@link TriConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 consumer * @param <B> The type of the argument to the second given function, and of composed consumer * @param <C> The type of the argument to the third given function, and of composed consumer * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third function to apply before this consumer is applied * @return A composed {@code TriConsumer} that first applies the {@code before} functions to its input, and then * applies this consumer 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> TriConsumer<A, B, C> compose(@Nonnull final Function<? super A, ? extends T> before1, @Nonnull final Function<? super B, ? extends U> before2, @Nonnull final ToCharFunction<? super C> before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (a, b, c) -> accept(before1.apply(a), before2.apply(b), before3.applyAsChar(c)); } /** * Returns a composed {@link TriBooleanConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 consumer is executed. * * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third function to apply before this consumer is applied * @return A composed {@code TriBooleanConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 TriBooleanConsumer composeFromBoolean(@Nonnull final BooleanFunction<? extends T> before1, @Nonnull final BooleanFunction<? extends U> before2, @Nonnull final BooleanToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> accept(before1.apply(value1), before2.apply(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriByteConsumer} that first applies the {@code before} functions to * its input, and then applies this consumer 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 consumer is executed. * * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third function to apply before this consumer is applied * @return A composed {@code TriByteConsumer} that first applies the {@code before} functions to its input, and then * applies this consumer 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 TriByteConsumer composeFromByte(@Nonnull final ByteFunction<? extends T> before1, @Nonnull final ByteFunction<? extends U> before2, @Nonnull final ByteToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> accept(before1.apply(value1), before2.apply(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriCharConsumer} that first applies the {@code before} functions to * its input, and then applies this consumer 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 consumer is executed. * * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third operator to apply before this consumer is applied * @return A composed {@code TriCharConsumer} that first applies the {@code before} functions to its input, and then * applies this consumer 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 TriCharConsumer composeFromChar(@Nonnull final CharFunction<? extends T> before1, @Nonnull final CharFunction<? extends U> before2, @Nonnull final CharUnaryOperator before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> accept(before1.apply(value1), before2.apply(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriDoubleConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 consumer is executed. * * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third function to apply before this consumer is applied * @return A composed {@code TriDoubleConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 TriDoubleConsumer composeFromDouble(@Nonnull final DoubleFunction<? extends T> before1, @Nonnull final DoubleFunction<? extends U> before2, @Nonnull final DoubleToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> accept(before1.apply(value1), before2.apply(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriFloatConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 consumer is executed. * * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third function to apply before this consumer is applied * @return A composed {@code TriFloatConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 TriFloatConsumer composeFromFloat(@Nonnull final FloatFunction<? extends T> before1, @Nonnull final FloatFunction<? extends U> before2, @Nonnull final FloatToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> accept(before1.apply(value1), before2.apply(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriIntConsumer} that first applies the {@code before} functions to * its input, and then applies this consumer 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 consumer is executed. * * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third function to apply before this consumer is applied * @return A composed {@code TriIntConsumer} that first applies the {@code before} functions to its input, and then * applies this consumer 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 TriIntConsumer composeFromInt(@Nonnull final IntFunction<? extends T> before1, @Nonnull final IntFunction<? extends U> before2, @Nonnull final IntToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> accept(before1.apply(value1), before2.apply(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriLongConsumer} that first applies the {@code before} functions to * its input, and then applies this consumer 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 consumer is executed. * * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third function to apply before this consumer is applied * @return A composed {@code TriLongConsumer} that first applies the {@code before} functions to its input, and then * applies this consumer 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 TriLongConsumer composeFromLong(@Nonnull final LongFunction<? extends T> before1, @Nonnull final LongFunction<? extends U> before2, @Nonnull final LongToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> accept(before1.apply(value1), before2.apply(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link TriShortConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 consumer is executed. * * @param before1 The first function to apply before this consumer is applied * @param before2 The second function to apply before this consumer is applied * @param before3 The third function to apply before this consumer is applied * @return A composed {@code TriShortConsumer} that first applies the {@code before} functions to its input, and * then applies this consumer 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 TriShortConsumer composeFromShort(@Nonnull final ShortFunction<? extends T> before1, @Nonnull final ShortFunction<? extends U> before2, @Nonnull final ShortToCharFunction before3) { Objects.requireNonNull(before1); Objects.requireNonNull(before2); Objects.requireNonNull(before3); return (value1, value2, value3) -> accept(before1.apply(value1), before2.apply(value2), before3.applyAsChar(value3)); } /** * Returns a composed {@link BiObjCharConsumer} that performs, in sequence, this consumer followed by the {@code * after} consumer. If evaluation of either operation throws an exception, it is relayed to the caller of the * composed operation. If performing this consumer throws an exception, the {@code after} consumer will not be * performed. * * @param after The consumer to apply after this consumer is applied * @return A composed {@link BiObjCharConsumer} that performs, in sequence, this consumer followed by the {@code * after} consumer. * @throws NullPointerException If given argument is {@code null} */ @Nonnull default BiObjCharConsumer<T, U> andThen(@Nonnull final BiObjCharConsumer<? super T, ? super U> after) { Objects.requireNonNull(after); return (t, u, value) -> { accept(t, u, value); after.accept(t, u, value); }; } /** * Returns a tupled version of this consumer. * * @return A tupled version of this consumer. */ @Nonnull default ObjCharConsumer<Pair<T, U>> tupled() { return this::accept; } /** * Returns a composed {@link TriConsumer} which represents this {@link BiObjCharConsumer}. Thereby the primitive * input argument for this consumer is autoboxed. This method provides the possibility to use this * {@code BiObjCharConsumer} with methods provided by the {@code JDK}. * * @return A composed {@code TriConsumer} which represents this {@code BiObjCharConsumer}. */ @Nonnull default TriConsumer<T, U, Character> boxed() { return this::accept; } }