Module com.github.robtimus.function.throwing
Package com.github.robtimus.function.throwing

Interface ThrowingDoubleConsumer<X extends Throwable>

  • Type Parameters:
    X - The type of checked exception that can be thrown.
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    @FunctionalInterface
public interface ThrowingDoubleConsumer<X extends Throwable>
    Represents an operation that accepts a single double-valued argument and returns no result. This is a checked-exception throwing equivalent of DoubleConsumer.

    • Method Detail

      • accept

        void accept​(double value)
     throws X extends Throwable
        Performs this operation on the given argument.
        Parameters:
        value - The input argument.
        Throws:
        X - If an error occurs.
        X extends Throwable

      • andThen

        default ThrowingDoubleConsumer<X> andThen​(ThrowingDoubleConsumer<? extends X> after)
        Returns a composed ThrowingDoubleConsumer that performs, in sequence, this operation followed by the 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 after operation will not be performed.
        Parameters:
        after - The operation to perform after this operation.
        Returns:
        A composed ThrowingDoubleConsumer that performs in sequence this operation followed by the after operation.
        Throws:
        NullPointerException - If after is null.

      • onErrorThrowAsChecked

        default <E extends Throwable> ThrowingDoubleConsumer<E> onErrorThrowAsChecked​(Function<? super X,​? extends E> errorMapper)
        Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is transformed using the given error mapper, and the returned operation throws the transformation result.
        Type Parameters:
        E - The type of checked exception to transform to.
        Parameters:
        errorMapper - The function to use to transform any checked exception thrown by this operation.
        Returns:
        An operation that transforms any thrown checked exception.
        Throws:
        NullPointerException - If errorMapper is null.

      • onErrorThrowAsUnchecked

        default <E extends RuntimeException> DoubleConsumer onErrorThrowAsUnchecked​(Function<? super X,​? extends E> errorMapper)
        Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is transformed using the given error mapper, and the returned operation throws the transformation result.
        Type Parameters:
        E - The type of unchecked exception to transform to.
        Parameters:
        errorMapper - The function to use to transform any checked exception thrown by this operation.
        Returns:
        An operation that transforms any thrown checked exception.
        Throws:
        NullPointerException - If errorMapper is null.

      • onErrorHandleChecked

        default <E extends Throwable> ThrowingDoubleConsumer<E> onErrorHandleChecked​(ThrowingConsumer<? super X,​? extends E> errorHandler)
        Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is handled by the given error handler.
        Type Parameters:
        E - The type of checked exception that can be thrown by the given error handler.
        Parameters:
        errorHandler - The operation to perform on any checked exception thrown by this operation.
        Returns:
        An operation that handles any thrown checked exception.
        Throws:
        NullPointerException - If errorHandler is null.

      • onErrorHandleUnchecked

        default DoubleConsumer onErrorHandleUnchecked​(Consumer<? super X> errorHandler)
        Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is handled by the given error handler.
        Parameters:
        errorHandler - The operation to perform on any checked exception thrown by this operation.
        Returns:
        An operation that handles any thrown checked exception.
        Throws:
        NullPointerException - If errorHandler is null.

      • onErrorAcceptChecked

        default <E extends Throwable> ThrowingDoubleConsumer<E> onErrorAcceptChecked​(ThrowingDoubleConsumer<? extends E> fallback)
        Returns an operation that performs this operation on its input. If this operation throws any checked exception, it is discarded and the given fallback operation is invoked.
        Type Parameters:
        E - The type of checked exception that can be thrown by the given fallback operation.
        Parameters:
        fallback - The operation to invoke if this operation throws any checked exception.
        Returns:
        An operation that invokes the fallback operation if this operation throws any checked exception.
        Throws:
        NullPointerException - If fallback is null.

      • onErrorAcceptUnchecked

        default DoubleConsumer onErrorAcceptUnchecked​(DoubleConsumer fallback)
        Returns an operation that performs this operation on its input. If this operation throws any checked exception, it is discarded and the given fallback operation is invoked.
        Parameters:
        fallback - The operation to invoke if this operation throws any checked exception.
        Returns:
        An operation that invokes the fallback operation if this operation throws any checked exception.
        Throws:
        NullPointerException - If fallback is null.

      • onErrorDiscard

        default DoubleConsumer onErrorDiscard()
        Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is discarded.
        Returns:
        An operation that discards any thrown checked exception.

      • of

        static <X extends Throwable> ThrowingDoubleConsumer<X> of​(ThrowingDoubleConsumer<X> operation)
        Factory method for turning ThrowingDoubleConsumer-shaped lambdas into ThrowingDoubleConsumers.
        Type Parameters:
        X - The type of checked exception that can be thrown.
        Parameters:
        operation - The lambda to return as ThrowingDoubleConsumer.
        Returns:
        The given lambda as a ThrowingDoubleConsumer.
        Throws:
        NullPointerException - If operation is null.

      • unchecked

        static DoubleConsumer unchecked​(ThrowingDoubleConsumer<?> operation)
        Returns an operation that performs the operation operation to its input. Any checked exception thrown by the operation operation is wrapped in an UncheckedException.
        Parameters:
        operation - The operation to perform when the returned operation is performed.
        Returns:
        An operation that wraps any checked exception in an UncheckedException.
        Throws:
        NullPointerException - If operation is null.

      • checked

        static <X extends Throwable> ThrowingDoubleConsumer<X> checked​(DoubleConsumer operation)
        Returns an operation that performs the operation operation to its input. Any checked exception thrown by the operation operation is relayed to the caller. This method allows existing DoubleConsumer instances to be used where ThrowingDoubleConsumer is expected.
        Type Parameters:
        X - The type of checked exception that can be thrown.
        Parameters:
        operation - The operation to perform when the returned operation is performed.
        Returns:
        An operation that wraps any checked exception in an UncheckedException.
        Throws:
        NullPointerException - If operation is null.

      • checked

        static <X extends Throwable> ThrowingDoubleConsumer<X> checked​(DoubleConsumer operation,
                                                               Class<X> errorType)
        Returns an operation that performs the operation operation to its input. Any UncheckedException thrown by the operation operation is unwrapped if its cause is an instance of errorType, otherwise it is relayed to the caller.
        Type Parameters:
        X - The type of checked exception that can be thrown.
        Parameters:
        operation - The operation to perform when the returned operation is performed.
        errorType - The type of checked exception that can be thrown.
        Returns:
        An operation that wraps any checked exception in an UncheckedException.
        Throws:
        NullPointerException - If operation or errorType is null.