Exceptional (stream 1.2.2 API)

java.lang.Object
- com.annimon.stream.Exceptional<T>

Type Parameters:: T - the type of the inner value

public class Exceptional<T>
extends java.lang.Object

A container for values which provided by ThrowableSupplier. Stores value which provided by ThrowableSupplier or an exception which were thrown.


     Exceptional.of(new ThrowableSupplier<String, Throwable>() {
          @Override
          public String get() throws Throwable {
              return IOUtils.read(inputStream);
          }
      }).ifExceptionIs(IOException.class, new Consumer<IOException>() {
          @Override
          public void accept(IOException exception) {
              logger.log(Level.WARNING, "read file", exception);
          }
      }).getOrElse("default string");

      Exceptional.of(() -> IOUtils.readBytes(inputStream)).getOrElse(new byte[0]);

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R> R`	`custom(Function<Exceptional<T>,R> function)` Applies custom operator on `Exceptional`.
`boolean`	`equals(java.lang.Object obj)`
`T`	`get()` Returns inner value.
`java.lang.Throwable`	`getException()` Returns exception.
`Optional<T>`	`getOptional()` Wraps inner value with `Optional` container
`T`	`getOrElse(Supplier<? extends T> other)` Returns inner value if there were no exceptions, otherwise returns value produced by supplier function.
`T`	`getOrElse(T other)` Returns inner value if there were no exceptions, otherwise returns `other`.
`T`	`getOrThrow()` Returns inner value if there were no exceptions, otherwise throws an exception.
`<E extends java.lang.Throwable> T`	`getOrThrow(E exception)` Returns inner value if there were no exceptions, otherwise throws the given `exception`.
`T`	`getOrThrowRuntimeException()` Returns inner value if there were no exceptions, otherwise throws `RuntimeException`.
`int`	`hashCode()`
`Exceptional<T>`	`ifException(Consumer<java.lang.Throwable> consumer)` Invokes consumer function if there were any exception.
`<E extends java.lang.Throwable> Exceptional<T>`	`ifExceptionIs(java.lang.Class<E> throwableClass, Consumer<? super E> consumer)` Invokes consumer function if exception class matches `throwableClass`.
`Exceptional<T>`	`ifPresent(Consumer<? super T> consumer)` Invokes consumer function with value if present.
`boolean`	`isPresent()` Checks value present (i.e.
`<U> Exceptional<U>`	`map(ThrowableFunction<? super T,? extends U,java.lang.Throwable> mapper)` Invokes mapping function on inner value if there were no exceptions.
`static <T> Exceptional<T>`	`of(java.lang.Throwable throwable)` Returns an `Exceptional` with throwable already set.
`static <T> Exceptional<T>`	`of(ThrowableSupplier<T,java.lang.Throwable> supplier)` Returns an `Exceptional` with value provided by given `ThrowableSupplier` function.
`Exceptional<T>`	`or(Supplier<Exceptional<T>> supplier)` Returns current `Exceptional` if there were no exceptions, otherwise returns an `Exceptional` produced by supplier function.
`Exceptional<T>`	`recover(ThrowableFunction<java.lang.Throwable,? extends T,java.lang.Throwable> function)` Returns current `Exceptional` if there were no exceptions, otherwise calls `function` and wraps produced result with an `Exceptional`.
`Exceptional<T>`	`recoverWith(Function<java.lang.Throwable,? extends Exceptional<T>> function)` Returns current `Exceptional` if there were no exceptions, otherwise returns an `Exceptional` produced by `function`.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
@NotNull
public static <T> Exceptional<T> of(@NotNull
                                             ThrowableSupplier<T,java.lang.Throwable> supplier)
```
    Returns an Exceptional with value provided by given ThrowableSupplier function.
    
    Type Parameters:
    
    T - the type of value
    
    Parameters:
    
    supplier - a supplier function
    
    Returns:
    
    an Exceptional
    
    Throws:
    
    java.lang.NullPointerException - if supplier is null
  - of
```
@NotNull
 @Contract(value="_ -> new")
public static <T> Exceptional<T> of(@NotNull
                                                                          java.lang.Throwable throwable)
```
    Returns an Exceptional with throwable already set.
    
    Type Parameters:
    
    T - the type of value
    
    Parameters:
    
    throwable - throwable instance
    
    Returns:
    
    an Exceptional
  - get
```
@Nullable
public T get()
```
    Returns inner value.
    
    Returns:
    
    inner value.
  - isPresent
```
public boolean isPresent()
```
    Checks value present (i.e. there were no exceptions).
    
    Returns:
    
    true if a value present, false otherwise
  - getOrElse
```
@Nullable
public T getOrElse(@Nullable
                             T other)
```
    Returns inner value if there were no exceptions, otherwise returns other.
    
    Parameters:
    
    other - the value to be returned if there were any exception
    
    Returns:
    
    inner value if there were no exceptions, otherwise other
  - getOrElse
```
@Nullable
public T getOrElse(@NotNull
                             Supplier<? extends T> other)
```
    Returns inner value if there were no exceptions, otherwise returns value produced by supplier function.
    
    Parameters:
    
    other - the supplier function that produces value if there were any exception
    
    Returns:
    
    inner value if there were no exceptions, otherwise value produced by supplier function
    
    Since:
    
    1.1.9
  - getOptional
```
@NotNull
public Optional<T> getOptional()
```
    Wraps inner value with Optional container
    
    Returns:
    
    an Optional
  - getException
```
@Nullable
public java.lang.Throwable getException()
```
    Returns exception.
    
    Returns:
    
    exception
  - getOrThrow
```
@Nullable
public T getOrThrow()
                       throws java.lang.Throwable
```
    Returns inner value if there were no exceptions, otherwise throws an exception.
    
    Returns:
    
    inner value if there were no exceptions
    
    Throws:
    
    java.lang.Throwable - that was thrown in supplier function
  - getOrThrowRuntimeException
```
@Nullable
public T getOrThrowRuntimeException()
                                       throws java.lang.RuntimeException
```
    Returns inner value if there were no exceptions, otherwise throws RuntimeException.
    
    Returns:
    
    inner value if there were no exceptions
    
    Throws:
    
    java.lang.RuntimeException - with wrapped exception which was thrown in supplier function
  - getOrThrow
```
@Nullable
public <E extends java.lang.Throwable> T getOrThrow(@NotNull
                                                              E exception)
                                                       throws E extends java.lang.Throwable
```
    Returns inner value if there were no exceptions, otherwise throws the given exception.
    
    Type Parameters:
    
    E - the type of exception
    
    Parameters:
    
    exception - an exception to be thrown
    
    Returns:
    
    inner value if there were no exceptions
    
    Throws:
    
    E - if there were exceptions in supplier function
    
    E extends java.lang.Throwable
  - or
```
@NotNull
public Exceptional<T> or(@NotNull
                                  Supplier<Exceptional<T>> supplier)
```
    Returns current Exceptional if there were no exceptions, otherwise returns an Exceptional produced by supplier function.
    
    Parameters:
    
    supplier - supplier function that produced an Exceptional to be returned
    
    Returns:
    
    this Exceptional if there were no exceptions, otherwise an Exceptional produced by supplier function
    
    Throws:
    
    java.lang.NullPointerException - if supplier or its result is null
  - custom
```
@Nullable
public <R> R custom(@NotNull
                              Function<Exceptional<T>,R> function)
```
    Applies custom operator on Exceptional.
    
    Type Parameters:
    
    R - the type of the result
    
    Parameters:
    
    function - a transforming function
    
    Returns:
    
    a result of the transforming function
    
    Throws:
    
    java.lang.NullPointerException - if function is null
    
    Since:
    
    1.1.9
  - map
```
@NotNull
public <U> Exceptional<U> map(@NotNull
                                       ThrowableFunction<? super T,? extends U,java.lang.Throwable> mapper)
```
    Invokes mapping function on inner value if there were no exceptions.
    
    Type Parameters:
    
    U - the type of result value
    
    Parameters:
    
    mapper - mapping function
    
    Returns:
    
    an Exceptional with transformed value if there were no exceptions
    
    Throws:
    
    java.lang.NullPointerException - if mapper is null
  - ifPresent
```
@NotNull
public Exceptional<T> ifPresent(@NotNull
                                         Consumer<? super T> consumer)
```
    Invokes consumer function with value if present.
    
    Parameters:
    
    consumer - a consumer function
    
    Returns:
    
    this Exceptional
    
    Since:
    
    1.1.2
  - ifException
```
@NotNull
public Exceptional<T> ifException(@NotNull
                                           Consumer<java.lang.Throwable> consumer)
```
    Invokes consumer function if there were any exception.
    
    Parameters:
    
    consumer - a consumer function
    
    Returns:
    
    an Exceptional
  - ifExceptionIs
```
@NotNull
public <E extends java.lang.Throwable> Exceptional<T> ifExceptionIs(@NotNull
                                                                             java.lang.Class<E> throwableClass,
                                                                             @NotNull
                                                                             Consumer<? super E> consumer)
```
    Invokes consumer function if exception class matches throwableClass.
    
    Type Parameters:
    
    E - the type of exception
    
    Parameters:
    
    throwableClass - the class of an exception to be compared
    
    consumer - a consumer function
    
    Returns:
    
    an Exceptional
  - recover
```
@NotNull
public Exceptional<T> recover(@NotNull
                                       ThrowableFunction<java.lang.Throwable,? extends T,java.lang.Throwable> function)
```
    Returns current Exceptional if there were no exceptions, otherwise calls function and wraps produced result with an Exceptional.
    
    Parameters:
    
    function - recovering function
    
    Returns:
    
    this Exceptional if there were no exceptions, otherwise an Exceptional with wrapped recovering function result
    
    Throws:
    
    java.lang.NullPointerException - if function is null
    
    Since:
    
    1.1.2
  - recoverWith
```
@NotNull
public Exceptional<T> recoverWith(@NotNull
                                           Function<java.lang.Throwable,? extends Exceptional<T>> function)
```
    Returns current Exceptional if there were no exceptions, otherwise returns an Exceptional produced by function.
    
    Parameters:
    
    function - recovering function
    
    Returns:
    
    this Exceptional if there were no exceptions, otherwise an Exceptional produced by recovering function
    
    Throws:
    
    java.lang.NullPointerException - if function or produced result is null
    
    Since:
    
    1.1.2
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
@NotNull
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Exceptional<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

get

isPresent

getOrElse

getOrElse

getOptional

getException

getOrThrow

getOrThrowRuntimeException

getOrThrow

or

custom

map

ifPresent

ifException

ifExceptionIs

recover

recoverWith

equals

hashCode

toString