manifold.ext.rt.api.IndexedConsumer Maven / Gradle / Ivy
/*
* Copyright (c) 2020 - Manifold Systems LLC
*
* 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 manifold.ext.rt.api;
import java.util.Objects;
import java.util.function.Consumer;
/**
* Indexed version of Consumer
* @see Consumer
*/
@FunctionalInterface
public interface IndexedConsumer
{
/**
* Performs this operation on the given argument with the given index.
*
* @param index the index of [t]
* @param t the input argument
*/
void accept( int index, T t );
/**
* 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
*
* @return a composed {@code Consumer} that performs in sequence this
* operation followed by the {@code after} operation
*
* @throws NullPointerException if {@code after} is null
*/
default IndexedConsumer andThen( IndexedConsumer after )
{
Objects.requireNonNull( after );
return ( int index, T t ) ->
{
accept( index, t );
after.accept( index, t );
};
}
}