Package org.sellcom.core.util.function

Interface ThrowingToIntFunction<T>

All Superinterfaces:

java.util.function.ToIntFunction<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 ThrowingToIntFunction<T>
extends java.util.function.ToIntFunction<T>

Represents a function that accepts a single argument and produces an int-valued result, possibly throwing an exception.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
default int	applyAsInt(T argument)	Applies this function to the given argument.
int	applyAsIntThrowing(T argument)	Applies this function to the given argument.
default java.util.function.ToIntFunction<T>	fallbackTo(java.util.function.ToIntFunction<T> fallback)	Returns a ToIntFunction applying the given function to the argument if this function throws an exception.
default java.util.function.ToIntFunction<T>	fallbackTo(java.util.function.ToIntFunction<T> fallback, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a ToIntFunction applying the given function to the argument if this function throws an exception.
default java.util.function.ToIntFunction<T>	orReturn(int value)	Returns a ToIntFunction returning the given value if this function throws an exception.
default java.util.function.ToIntFunction<T>	orReturn(int value, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a ToIntFunction returning the given value if this function throws an exception.
default ThrowingToIntFunction<T>	orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass)	Returns a ThrowingToIntFunction throwing an exception of the given type if this function throws an exception.
default ThrowingToIntFunction<T>	orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass, java.lang.String message)	Returns a ThrowingToIntFunction throwing an exception of the given type if this function throws an exception.
default ThrowingToIntFunction<T>	orTryWith(ThrowingToIntFunction<? super T> other)	Returns a ThrowingToIntFunction applying the given function to the argument if this function throws an exception.
default ThrowingToIntFunction<T>	orTryWith(ThrowingToIntFunction<? super T> other, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a ThrowingToIntFunction applying the given function to the argument if this function throws an exception.

Method Detail

applyAsInt

default int applyAsInt(T argument)

Applies this function to the given argument. Wraps any thrown checked exceptions with UncheckedException.

Specified by:

applyAsInt in interface java.util.function.ToIntFunction<T>

Since:

1.0

applyAsIntThrowing

int applyAsIntThrowing(T argument)
                throws java.lang.Exception

Applies this function to the given argument.

Throws:

java.lang.Exception

Since:

1.0

fallbackTo

default java.util.function.ToIntFunction<T> fallbackTo(java.util.function.ToIntFunction<T> fallback)

Returns a ToIntFunction applying the given function to the argument if this function throws an exception.

Throws:

java.lang.IllegalArgumentException - if fallback is null

Since:

1.0

fallbackTo

default java.util.function.ToIntFunction<T> fallbackTo(java.util.function.ToIntFunction<T> fallback,
                                                       java.util.function.Consumer<java.lang.Exception> exceptionConsumer)

Returns a ToIntFunction applying the given function to the argument if this function throws an exception.

Throws:

java.lang.IllegalArgumentException - if fallback is null

Since:

1.0

orReturn

default java.util.function.ToIntFunction<T> orReturn(int value)

Returns a ToIntFunction returning the given value if this function throws an exception.

Since:

1.0

orReturn

default java.util.function.ToIntFunction<T> orReturn(int value,
                                                     java.util.function.Consumer<java.lang.Exception> exceptionConsumer)

Returns a ToIntFunction returning the given value if this function throws an exception.

Since:

1.0

orThrow

default ThrowingToIntFunction<T> orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass)

Returns a ThrowingToIntFunction 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:

java.lang.IllegalArgumentException - if exceptionClass is null

Since:

1.0

orThrow

default ThrowingToIntFunction<T> orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass,
                                         java.lang.String message)

Returns a ThrowingToIntFunction 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:

java.lang.IllegalArgumentException - if exceptionClass is null

Since:

1.0

orTryWith

default ThrowingToIntFunction<T> orTryWith(ThrowingToIntFunction<? super T> other)

Returns a ThrowingToIntFunction applying the given function to the argument if this function throws an exception.

Throws:

java.lang.IllegalArgumentException - if other is null

Since:

1.0

orTryWith

default ThrowingToIntFunction<T> orTryWith(ThrowingToIntFunction<? super T> other,
                                           java.util.function.Consumer<java.lang.Exception> exceptionConsumer)

Returns a ThrowingToIntFunction applying the given function to the argument if this function throws an exception.

Throws:

java.lang.IllegalArgumentException - if other is null

Since:

1.0