ThrowingFunction (sellcom-java 1.1.0)

All Superinterfaces:

Function<T,R>

All Known Subinterfaces:

ThrowingUnaryOperator<T>

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 ThrowingFunction<T,R>
extends Function<T,R>
```
Represents a function that accepts a single argument and produces a result, possibly throwing an exception.
Example
```
 ThrowingFunction<String, Integer> parse = Integer::parseInt;
 Function<String, Optional<Integer>> safeParse = parse.fallbackTo(string -> null)
         .andThen(Optional::ofNullable);
 
```
Since:

1.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <V> ThrowingFunction<T,V>`	`andThen(ThrowingFunction<? super R,? extends V> after)` Returns a composed `ThrowingFunction` that first applies this function to the argument, and then applies the after function to the result.
`default R`	`apply(T argument)` Applies this function to the given argument.
`R`	`applyThrowing(T argument)` Applies this function to the given argument.
`default <V> ThrowingFunction<V,R>`	`compose(ThrowingFunction<? super V,? extends T> before)` Returns a composed `ThrowingFunction` that first applies the before function to the argument, and then applies this function to the result.
`default Function<T,R>`	`fallbackTo(Function<T,R> fallback)` Returns a `Function` applying the given function to the argument if this function throws an exception.
`default Function<T,R>`	`fallbackTo(Function<T,R> fallback, Consumer<Exception> exceptionConsumer)` Returns a `Function` applying the given function to the argument if this function throws an exception.
`default Function<T,R>`	`orReturn(R value)` Returns a `Function` returning the given value if this function throws an exception.
`default Function<T,R>`	`orReturn(R value, Consumer<Exception> exceptionConsumer)` Returns a `Function` returning the given value if this function throws an exception.
`default ThrowingFunction<T,R>`	`orThrow(Class<? extends RuntimeException> exceptionClass)` Returns a `ThrowingFunction` throwing an exception of the given type if this function throws an exception.
`default ThrowingFunction<T,R>`	`orThrow(Class<? extends RuntimeException> exceptionClass, String message)` Returns a `ThrowingFunction` throwing an exception of the given type if this function throws an exception.
`default ThrowingFunction<T,R>`	`orTryWith(ThrowingFunction<? super T,? extends R> other)` Returns a `ThrowingFunction` applying the given function to the argument if this function throws an exception.
`default ThrowingFunction<T,R>`	`orTryWith(ThrowingFunction<? super T,? extends R> other, Consumer<Exception> exceptionConsumer)` Returns a `ThrowingFunction` applying the given function to the argument if this function throws an exception.

Methods inherited from interface java.util.function.Function
andThen, compose, identity

- Method Detail
  - andThen
```
default <V> ThrowingFunction<T,V> andThen(ThrowingFunction<? super R,? extends V> after)
```
    Returns a composed ThrowingFunction that first applies this function to the argument, and then applies the after function to the result.
    
    Throws:
    
    IllegalArgumentException - if after is null
    
    Since:
    
    1.0
  - apply
```
default R apply(T argument)
```
    Applies this function to the given argument. Wraps any thrown checked exceptions with UncheckedException.
    
    Specified by:
    
    apply in interface Function<T,R>
    
    Since:
    
    1.0
  - applyThrowing
```
R applyThrowing(T argument)
         throws Exception
```
    Applies this function to the given argument.
    
    Throws:
    
    Exception
    
    Since:
    
    1.0
  - compose
```
default <V> ThrowingFunction<V,R> compose(ThrowingFunction<? super V,? extends T> before)
```
    Returns a composed ThrowingFunction that first applies the before function to the argument, and then applies this function to the result.
    
    Throws:
    
    IllegalArgumentException - if before is null
    
    Since:
    
    1.0
  - fallbackTo
```
default Function<T,R> fallbackTo(Function<T,R> fallback)
```
    Returns a Function applying the given function to the argument if this function throws an exception.
    
    Throws:
    
    IllegalArgumentException - if fallback is null
    
    Since:
    
    1.0
  - fallbackTo
```
default Function<T,R> fallbackTo(Function<T,R> fallback,
                                 Consumer<Exception> exceptionConsumer)
```
    Returns a Function applying the given function to the argument if this function throws an exception.
    
    Throws:
    
    IllegalArgumentException - if fallback is null
    
    Since:
    
    1.0
  - orReturn
```
default Function<T,R> orReturn(R value)
```
    Returns a Function returning the given value if this function throws an exception.
    
    Since:
    
    1.0
  - orReturn
```
default Function<T,R> orReturn(R value,
                               Consumer<Exception> exceptionConsumer)
```
    Returns a Function returning the given value if this function throws an exception.
    
    Since:
    
    1.0
  - orThrow
```
default ThrowingFunction<T,R> orThrow(Class<? extends RuntimeException> exceptionClass)
```
    Returns a ThrowingFunction throwing an exception of the given type if this function throws an exception. The original exception thrown by this function is the cause of the thrown exception.
    The exception class must have a constructor accepting a single Throwable as an argument.
    
    Throws:
    
    IllegalArgumentException - if exceptionClass is null
    
    Since:
    
    1.0
  - orThrow
```
default ThrowingFunction<T,R> orThrow(Class<? extends RuntimeException> exceptionClass,
                                      String message)
```
    Returns a ThrowingFunction throwing an exception of the given type if this function throws an exception. The original exception thrown by this function is the cause of the thrown exception.
    The exception class must have a constructor accepting String and Throwable as arguments.
    
    Throws:
    
    IllegalArgumentException - if exceptionClass is null
    
    Since:
    
    1.0
  - orTryWith
```
default ThrowingFunction<T,R> orTryWith(ThrowingFunction<? super T,? extends R> other)
```
    Returns a ThrowingFunction applying the given function to the argument if this function throws an exception.
    
    Throws:
    
    IllegalArgumentException - if other is null
    
    Since:
    
    1.0
  - orTryWith
```
default ThrowingFunction<T,R> orTryWith(ThrowingFunction<? super T,? extends R> other,
                                        Consumer<Exception> exceptionConsumer)
```
    Returns a ThrowingFunction applying the given function to the argument if this function throws an exception.
    
    Throws:
    
    IllegalArgumentException - if other is null
    
    Since:
    
    1.0

Interface ThrowingFunction<T,R>

Example

Method Summary

Methods inherited from interface java.util.function.Function

Method Detail

andThen

apply

applyThrowing

compose

fallbackTo

fallbackTo

orReturn

orReturn

orThrow

orThrow

orTryWith

orTryWith