diff options
Diffstat (limited to 'src/main/java/org/apache/commons/lang3/function/TriConsumer.java')
-rw-r--r-- | src/main/java/org/apache/commons/lang3/function/TriConsumer.java | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/lang3/function/TriConsumer.java b/src/main/java/org/apache/commons/lang3/function/TriConsumer.java new file mode 100644 index 000000000..d0ba9b466 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/function/TriConsumer.java @@ -0,0 +1,71 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.commons.lang3.function; + +import java.util.Objects; +import java.util.function.Consumer; + +/** + * Represents an operation that accepts three input arguments and returns no result. This is the three-arity + * specialization of {@link Consumer}. Unlike most other functional interfaces, {@link TriConsumer} is expected to + * operate via side-effects. + * + * <p> + * This is a {@link FunctionalInterface} whose functional method is {@link #accept(Object, Object, Object)}. + * </p> + * <p> + * Provenance: Apache Log4j 2.7 + * </p> + * + * @param <T> type of the first argument + * @param <U> type of the second argument + * @param <V> type of the third argument + * @since 3.13.0 + */ +@FunctionalInterface +public interface TriConsumer<T, U, V> { + + /** + * Performs the operation given the specified arguments. + * + * @param k the first input argument + * @param v the second input argument + * @param s the third input argument + */ + void accept(T k, U v, V s); + + /** + * Returns a composed {@link TriConsumer} that performs, in sequence, this operation followed by the {@code after} + * operation. If performing either operation throws an exception, it is relayed to the caller of the composed + * operation. If performing this operation throws an exception, the {@code after} operation will not be performed. + * + * @param after the operation to perform after this operation. + * @return a composed {@link TriConsumer} that performs in sequence this operation followed by the {@code after} + * operation. + * @throws NullPointerException if {@code after} is null. + */ + default TriConsumer<T, U, V> andThen(final TriConsumer<? super T, ? super U, ? super V> after) { + Objects.requireNonNull(after); + + return (t, u, v) -> { + accept(t, u, v); + after.accept(t, u, v); + }; + } + +} |