com.helger.commons.functional.IThrowingConsumer Maven / Gradle / Ivy
Show all versions of ph-commons Show documentation
/*
* Copyright (C) 2014-2024 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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 com.helger.commons.functional;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Represents an operation that accepts a single input argument and returns no
* result but may throw an Exception. Unlike most other functional interfaces,
* {@code IThrowingConsumer} is expected to operate via side-effects.
*
* This is a functional interface whose functional method is
* {@link #accept(Object)}.
*
* @param
* the type of the input to the operation
* @param
* exception type
* @since 8.3.1
*/
@FunctionalInterface
public interface IThrowingConsumer
{
/**
* Performs this operation on the given argument.
*
* @param t
* the input argument
* @throws EXTYPE
* In case it is needed
*/
void accept (T t) throws EXTYPE;
/**
* Returns a composed {@code Consumer} 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. May be
* null
.
* @return a composed {@code Consumer} that performs in sequence this
* operation followed by the {@code after} operation
*/
@Nonnull
default IThrowingConsumer andThen (@Nullable final IThrowingConsumer super T, ? extends EXTYPE> after)
{
if (after == null)
return this;
return t -> {
accept (t);
after.accept (t);
};
}
}