LongConsumerWithException.java
/**
* Powerunit - A JDK1.8 test framework
* Copyright (C) 2014 Mathieu Boretti.
*
* This file is part of Powerunit
*
* Powerunit is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Powerunit is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Powerunit. If not, see <http://www.gnu.org/licenses/>.
*/
package ch.powerunit.extensions.exceptions;
import static ch.powerunit.extensions.exceptions.Constants.verifyExceptionMapper;
import static ch.powerunit.extensions.exceptions.Constants.verifyOperation;
import static java.util.Objects.requireNonNull;
import java.util.concurrent.CompletionStage;
import java.util.function.Function;
import java.util.function.LongConsumer;
import java.util.function.LongFunction;
import java.util.function.Supplier;
/**
* Represents an operation that accepts a single {@code long}-valued argument,
* may throw exception and returns no result. This is the primitive type
* specialization of {@link ConsumerWithException} for {@code long}. Unlike most
* other functional interfaces, {@code LongConsumerWithException} is expected to
* operate via side-effects.
* <h3>General contract</h3>
* <ul>
* <li><b>{@link #accept(long) void accept(long value) throws
* E}</b> - The functional method.</li>
* <li><b>uncheck</b> - Return a {@code LongConsumer}</li>
* <li><b>lift</b> - Return a {@code LongConsumer}</li>
* <li><b>ignore</b> - Return a {@code LongConsumer}</li>
* </ul>
*
* @see LongConsumer
* @param <E>
* the type of the potential exception of the operation
*/
@FunctionalInterface
public interface LongConsumerWithException<E extends Exception> extends
NoReturnExceptionHandlerSupport<LongConsumer, LongFunction<CompletionStage<Void>>, LongConsumerWithException<E>> {
/**
* Performs this operation on the given argument.
*
* @param value
* the input argument
* @throws E
* any exception
* @see LongConsumer#accept(long)
*/
void accept(long value) throws E;
/**
* Converts this {@code LongConsumerWithException} to a {@code LongConsumer}
* that convert exception to {@code RuntimeException}.
*
* @return the unchecked operation
* @see #unchecked(LongConsumerWithException)
* @see #unchecked(LongConsumerWithException, Function)
*/
@Override
default LongConsumer uncheck() {
return t -> NoReturnExceptionHandlerSupport.unchecked(() -> accept(t), throwingHandler());
}
/**
* Converts this {@code LongConsumerWithException} to a <i>lifted</i>
* {@code LongConsumer} ignoring exception.
*
* @return the operation that ignore error
* @see #ignored(LongConsumerWithException)
*/
@Override
default LongConsumer ignore() {
return t -> NoReturnExceptionHandlerSupport.unchecked(() -> accept(t), notThrowingHandler());
}
/**
* Converts this {@code LongConsumerWithException} to a <i>staged</i>
* {@code LongFunction} that return a {@code CompletionStage}.
*
* @return the staged operation.
* @since 1.1.0
*/
@Override
default LongFunction<CompletionStage<Void>> stage() {
return t -> NoReturnExceptionHandlerSupport.staged(() -> accept(t));
}
/**
* Returns a composed {@code LongConsumerWithException} 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 LongConsumer} that performs in sequence this
* operation followed by the {@code after} operation
* @throws NullPointerException
* if {@code after} is null
*
*
* @see LongConsumer#andThen(LongConsumer)
*/
default LongConsumerWithException<E> andThen(LongConsumerWithException<? extends E> after) {
requireNonNull(after);
return t -> {
accept(t);
after.accept(t);
};
}
/**
* Returns an operation that always throw exception.
*
* @param exceptionBuilder
* the supplier to create the exception
* @param <E>
* the type of the exception
* @return an operation that always throw exception
*/
static <E extends Exception> LongConsumerWithException<E> failing(Supplier<E> exceptionBuilder) {
return t -> {
throw exceptionBuilder.get();
};
}
/**
* Converts a {@code LongConsumerWithException} to a {@code LongConsumer} that
* convert exception to {@code RuntimeException}.
*
* @param operation
* to be unchecked
* @param <E>
* the type of the potential exception
* @return the unchecked operation
* @see #uncheck()
* @see #unchecked(LongConsumerWithException, Function)
* @throws NullPointerException
* if operation is null
*/
static <E extends Exception> LongConsumer unchecked(LongConsumerWithException<E> operation) {
return verifyOperation(operation).uncheck();
}
/**
* Converts a {@code LongConsumerWithException} to a {@code LongConsumer} that
* convert exception to {@code RuntimeException} by using the provided mapping
* function.
*
* @param operation
* the be unchecked
* @param exceptionMapper
* a function to convert the exception to the runtime exception.
* @param <E>
* the type of the potential exception
* @return the unchecked operation
* @see #uncheck()
* @see #unchecked(LongConsumerWithException)
* @throws NullPointerException
* if operation or exceptionMapper is null
*/
static <E extends Exception> LongConsumer unchecked(LongConsumerWithException<E> operation,
Function<Exception, RuntimeException> exceptionMapper) {
verifyOperation(operation);
verifyExceptionMapper(exceptionMapper);
return new LongConsumerWithException<E>() {
@Override
public void accept(long value) throws E {
operation.accept(value);
}
@Override
public Function<Exception, RuntimeException> exceptionMapper() {
return exceptionMapper;
}
}.uncheck();
}
/**
* Converts a {@code LongConsumerWithException} to a lifted {@code LongConsumer}
* ignoring exception.
*
* @param operation
* to be lifted
* @param <E>
* the type of the potential exception
* @return the lifted operation
* @see #lift()
* @throws NullPointerException
* if operation is null
*/
static <E extends Exception> LongConsumer lifted(LongConsumerWithException<E> operation) {
return verifyOperation(operation).lift();
}
/**
* Converts a {@code LongConsumerWithException} to a lifted {@code LongConsumer}
* ignoring exception.
*
* @param operation
* to be lifted
* @param <E>
* the type of the potential exception
* @return the lifted operation
* @see #ignore()
* @throws NullPointerException
* if operation is null
*/
static <E extends Exception> LongConsumer ignored(LongConsumerWithException<E> operation) {
return verifyOperation(operation).ignore();
}
/**
* Converts a {@code LongConsumerWithException} to a staged {@code LongFunction}
* .
*
* @param operation
* to be staged
* @param <E>
* the type of the potential exception
* @return the staged operation
* @throws NullPointerException
* if operation is null
* @since 1.1.0
*/
static <E extends Exception> LongFunction<CompletionStage<Void>> staged(LongConsumerWithException<E> operation) {
return verifyOperation(operation).stage();
}
/**
* Converts a {@code LongConsumerWithException} to a
* {@code ConsumerWithException}.
*
* @param operation
* to be converted
* @param <E>
* the type of the potential exception
* @return the consumer
* @throws NullPointerException
* if operation is null
*/
static <E extends Exception> ConsumerWithException<Long, E> asConsumer(LongConsumerWithException<E> operation) {
return verifyOperation(operation)::accept;
}
}