com.annimon.stream

Class Exceptional<T>

java.lang.Object

com.annimon.stream.Exceptional<T>

Type Parameters:

T - the type of the inner value

public class Exceptional<T>
extends 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

Modifier and Type	Method and Description
boolean	equals(Object obj)
T	get() Returns inner value.
Throwable	getException() Returns exception.
Optional<T>	getOptional() Wraps inner value with Optional container
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 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<Throwable> consumer) Invokes consumer function if there were any exception.
<E extends Throwable> Exceptional<T>	ifExceptionIs(Class<E> throwableClass, Consumer<? super E> consumer) Invokes consumer function if exception class matches throwableClass.
<U> Exceptional<U>	map(ThrowableFunction<? super T,? extends U,Throwable> mapper) Invokes mapping function on inner value if there were no exceptions.
static <T> Exceptional<T>	of(ThrowableSupplier<T,Throwable> supplier) Returns an Exceptional with value provided by given ThrowableSupplier function.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static <T> Exceptional<T> of(ThrowableSupplier<T,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

get

public T get()

Returns inner value.

Returns:

inner value.

getOrElse

public T getOrElse(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

getOptional

public Optional<T> getOptional()

Wraps inner value with Optional container

Returns:

an Optional

getException

public Throwable getException()

Returns exception.

Returns:

exception

getOrThrow

public T getOrThrow()
             throws Throwable

Returns inner value if there were no exceptions, otherwise throws an exception.

Returns:

inner value if there were no exceptions

Throws:

Throwable - that was thrown in supplier function

getOrThrowRuntimeException

public T getOrThrowRuntimeException()
                             throws RuntimeException

Returns inner value if there were no exceptions, otherwise throws RuntimeException.

Returns:

inner value if there were no exceptions

Throws:

RuntimeException - with wrapped exception which was thrown in supplier function

getOrThrow

public <E extends Throwable> T getOrThrow(E exception)
                                   throws E extends 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 Throwable

map

public <U> Exceptional<U> map(ThrowableFunction<? super T,? extends U,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:

NullPointerException - if mapper is null

ifException

public Exceptional<T> ifException(Consumer<Throwable> consumer)

Invokes consumer function if there were any exception.

Parameters:

consumer - a consumer function

Returns:

an Exceptional

ifExceptionIs

public <E extends Throwable> Exceptional<T> ifExceptionIs(Class<E> throwableClass,
                                                          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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object