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

Interface ThrowingDoubleUnaryOperator<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 ThrowingDoubleUnaryOperator<X extends Throwable>
    Represents an operation on a single double-valued operand that produces a double-valued result. This is a checked-exception throwing equivalent of DoubleUnaryOperator.

    • Method Detail

      • applyAsDouble

        double applyAsDouble​(double operand)
              throws X extends Throwable
        Applies this operator to the given operand.
        Parameters:
        operand - The operand.
        Returns:
        The operator result.
        Throws:
        X - If an error occurs.
        X extends Throwable

      • onErrorThrowAsChecked

        default <E extends Throwable> ThrowingDoubleUnaryOperator<E> onErrorThrowAsChecked​(Function<? super X,​? extends E> errorMapper)
        Returns a unary operator that applies this operator to its input. Any checked exception thrown by this operator is transformed using the given error mapper, and the returned operator 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 operator.
        Returns:
        A unary operator that transforms any thrown checked exception.
        Throws:
        NullPointerException - If errorMapper is null.

      • onErrorThrowAsUnchecked

        default <E extends RuntimeException> DoubleUnaryOperator onErrorThrowAsUnchecked​(Function<? super X,​? extends E> errorMapper)
        Returns a unary operator that applies this operator to its input. Any checked exception thrown by this operator is transformed using the given error mapper, and the returned operator 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 operator.
        Returns:
        A unary operator that transforms any thrown checked exception.
        Throws:
        NullPointerException - If errorMapper is null.

      • onErrorHandleChecked

        default <E extends Throwable> ThrowingDoubleUnaryOperator<E> onErrorHandleChecked​(ThrowingToDoubleFunction<? super X,​? extends E> errorHandler)
        Returns a unary operator that applies this operator to its input. Any checked exception thrown by this operator is transformed using the given error handler, and the returned operator returns the transformation result.
        Type Parameters:
        E - The type of checked exception that can be thrown by the given error handler.
        Parameters:
        errorHandler - The function to use to transform any checked exception thrown by this operator.
        Returns:
        A unary operator that transforms any thrown checked exception.
        Throws:
        NullPointerException - If errorHandler is null.

      • onErrorHandleUnchecked

        default DoubleUnaryOperator onErrorHandleUnchecked​(ToDoubleFunction<? super X> errorHandler)
        Returns a unary operator that applies this operator to its input. Any checked exception thrown by this operator is transformed using the given error handler, and the returned operator returns the transformation result.
        Parameters:
        errorHandler - The function to use to transform any checked exception thrown by this operator.
        Returns:
        A unary operator that transforms any thrown checked exception.
        Throws:
        NullPointerException - If errorHandler is null.

      • onErrorApplyChecked

        default <E extends Throwable> ThrowingDoubleUnaryOperator<E> onErrorApplyChecked​(ThrowingDoubleUnaryOperator<? extends E> fallback)
        Returns a unary operator that applies this operator to its input. If this operator throws any checked exception, it is discarded and the given fallback operator is invoked.
        Type Parameters:
        E - The type of checked exception that can be thrown by the given fallback operator.
        Parameters:
        fallback - The operator to invoke if this operator throws any checked exception.
        Returns:
        A unary operator that invokes the fallback operator if this operator throws any checked exception.
        Throws:
        NullPointerException - If fallback is null.

      • onErrorApplyUnchecked

        default DoubleUnaryOperator onErrorApplyUnchecked​(DoubleUnaryOperator fallback)
        Returns a unary operator that applies this operator to its input. If this operator throws any checked exception, it is discarded and the given fallback operator is invoked.
        Parameters:
        fallback - The operator to invoke if this operator throws any checked exception.
        Returns:
        A unary operator that invokes the fallback operator if this operator throws any checked exception.
        Throws:
        NullPointerException - If fallback is null.

      • onErrorGetChecked

        default <E extends Throwable> ThrowingDoubleUnaryOperator<E> onErrorGetChecked​(ThrowingDoubleSupplier<? extends E> fallback)
        Returns a unary operator that applies this operator to its input. If this operator throws any checked exception, it is discarded and the given fallback supplier is invoked.
        Type Parameters:
        E - The type of checked exception that can be thrown by the given fallback supplier.
        Parameters:
        fallback - The supplier to produce the value to return if this operator throws any checked exception.
        Returns:
        A unary operator that invokes the fallback supplier if this operator throws any checked exception.
        Throws:
        NullPointerException - If fallback is null.

      • onErrorGetUnchecked

        default DoubleUnaryOperator onErrorGetUnchecked​(DoubleSupplier fallback)
        Returns a unary operator that applies this operator to its input. If this operator throws any checked exception, it is discarded and the given fallback supplier is invoked.
        Parameters:
        fallback - The supplier to produce the value to return if this operator throws any checked exception.
        Returns:
        A unary operator that invokes the fallback supplier if this operator throws any checked exception.
        Throws:
        NullPointerException - If fallback is null.

      • onErrorReturn

        default DoubleUnaryOperator onErrorReturn​(double fallback)
        Returns a unary operator that applies this operator to its input. If this operator throws any checked exception, it is discarded and the given fallback value is returned.
        Parameters:
        fallback - The value to return if this operator throws any checked exception.
        Returns:
        A unary operator that returns the fallback value if this operator throws any checked exception.

      • of

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

      • identity

        static <X extends Throwable> ThrowingDoubleUnaryOperator<X> identity()
        Returns a unary operator that always returns its input argument.
        Type Parameters:
        X - The type of checked exception that can be thrown.
        Returns:
        A unary operator that always returns its input argument.

      • checked

        static <X extends Throwable> ThrowingDoubleUnaryOperator<X> checked​(DoubleUnaryOperator operator)
        Returns a unary operator that applies the operator operator to its input. Any unchecked exception thrown by the operator operator is relayed to the caller. This method allows existing DoubleUnaryOperator instances to be used where ThrowingDoubleUnaryOperator is expected.
        Type Parameters:
        X - The type of checked exception that can be thrown.
        Parameters:
        operator - The operator to apply when the returned operator is applied.
        Returns:
        A unary operator that wraps any checked exception in an UncheckedException.
        Throws:
        NullPointerException - If operator is null.

      • checked

        static <X extends Throwable> ThrowingDoubleUnaryOperator<X> checked​(DoubleUnaryOperator operator,
                                                                    Class<X> errorType)
        Returns a unary operator that applies the operator operator to its input. Any UncheckedException thrown by the operator operator 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:
        operator - The operator to apply when the returned operator is applied.
        errorType - The type of checked exception that can be thrown.
        Returns:
        A unary operator that wraps any checked exception in an UncheckedException.
        Throws:
        NullPointerException - If operator or errorType is null.