net.ashwork.functionality

Interface FunctionN<R>

Type Parameters:

R - the type of the result of the function

All Superinterfaces:

Arity, ResultChainable<R>, ResultChainableResult<R>

All Known Subinterfaces:

BooleanFunction1<R>, BooleanToByteFunction1, BooleanToCharFunction1, BooleanToDoubleFunction1, BooleanToFloatFunction1, BooleanToIntFunction1, BooleanToLongFunction1, BooleanToShortFunction1, ByteFunction1<R>, ByteToBooleanFunction1, ByteToCharFunction1, ByteToDoubleFunction1, ByteToFloatFunction1, ByteToIntFunction1, ByteToLongFunction1, ByteToShortFunction1, CharFunction1<R>, CharToBooleanFunction1, CharToByteFunction1, CharToDoubleFunction1, CharToFloatFunction1, CharToIntFunction1, CharToLongFunction1, CharToShortFunction1, DoubleFunction1<R>, DoubleToBooleanFunction1, DoubleToByteFunction1, DoubleToCharFunction1, DoubleToFloatFunction1, DoubleToIntFunction1, DoubleToLongFunction1, DoubleToShortFunction1, FloatFunction1<R>, FloatToBooleanFunction1, FloatToByteFunction1, FloatToCharFunction1, FloatToDoubleFunction1, FloatToIntFunction1, FloatToLongFunction1, FloatToShortFunction1, Function0<R>, Function1<T1,R>, Function2<T1,T2,R>, IntFunction1<R>, IntToBooleanFunction1, IntToByteFunction1, IntToCharFunction1, IntToDoubleFunction1, IntToFloatFunction1, IntToLongFunction1, IntToShortFunction1, LongFunction1<R>, LongToBooleanFunction1, LongToByteFunction1, LongToCharFunction1, LongToDoubleFunction1, LongToFloatFunction1, LongToIntFunction1, LongToShortFunction1, ShortFunction1<R>, ShortToBooleanFunction1, ShortToByteFunction1, ShortToCharFunction1, ShortToDoubleFunction1, ShortToFloatFunction1, ShortToIntFunction1, ShortToLongFunction1, ToBooleanFunction0, ToBooleanFunction1<T1>, ToBooleanFunction2<T1,T2>, ToBooleanFunctionN, ToByteFunction0, ToByteFunction1<T1>, ToByteFunction2<T1,T2>, ToByteFunctionN, ToCharFunction0, ToCharFunction1<T1>, ToCharFunction2<T1,T2>, ToCharFunctionN, ToDoubleFunction0, ToDoubleFunction1<T1>, ToDoubleFunction2<T1,T2>, ToDoubleFunctionN, ToFloatFunction0, ToFloatFunction1<T1>, ToFloatFunction2<T1,T2>, ToFloatFunctionN, ToIntFunction0, ToIntFunction1<T1>, ToIntFunction2<T1,T2>, ToIntFunctionN, ToLongFunction0, ToLongFunction1<T1>, ToLongFunction2<T1,T2>, ToLongFunctionN, ToShortFunction0, ToShortFunction1<T1>, ToShortFunction2<T1,T2>, ToShortFunctionN

All Known Implementing Classes:

FunctionN.Instance, ToBooleanFunctionN.Instance, ToByteFunctionN.Instance, ToCharFunctionN.Instance, ToDoubleFunctionN.Instance, ToFloatFunctionN.Instance, ToIntFunctionN.Instance, ToLongFunctionN.Instance, ToShortFunctionN.Instance

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 FunctionN<R>
extends ResultChainableResult<R>, Arity

Represents a function that accepts n arguments and produces a result. All functions are derived from this n-arity specialization.

This is a functional interface whose functional method is applyAllUnchecked(Object...).

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FunctionN.FunctionSizeException A RuntimeException that is thrown whenever the size of the arguments of a function is not equal to its arity.
static class	FunctionN.Instance<R> An instance of FunctionN which properly defines the arity of that particular function.

Method Summary

Modifier and Type	Method and Description
default <V> FunctionN<V>	andThen(Function1<? super R,? extends V> after) Returns a chained object that applies this chainable object, and then applies the after function to ths result.
default <V> FunctionN<V>	andThenUnchecked(Function1<? super R,? extends V> after) Returns a chained object that applies this chainable object, and then applies the after function to ths result.
R	applyAllUnchecked(java.lang.Object... args) Applies this function to the given arguments.
default int	arity() Returns the number of arguments of the function.
static <T> T[]	checkSize(int size, T[] array) Checks the size of the array to see if it is equal to the expected size.
static <T> T[]	checkSize(int size, T[] array, java.lang.String message) Checks the size of the array to see if it is equal to the expected size.
default R	sizedApplyAllUnchecked(java.lang.Object... args) Applies this function to the given arguments.

Method Detail

applyAllUnchecked

R applyAllUnchecked(java.lang.Object... args)

Applies this function to the given arguments. Makes no assumptions of the arguments passed in and whether a value will compute successfully.

Parameters:

args - the function arguments

Returns:

the function result

arity

default int arity()

Returns the number of arguments of the function. If used as a functional interface with a non-specific number of arguments, this will return -1.

Specified by:

arity in interface Arity

Returns:

the number of arguments of the function

sizedApplyAllUnchecked

default R sizedApplyAllUnchecked(java.lang.Object... args)

Applies this function to the given arguments. If the number of arguments do not match the arity() of this function, an exception will be thrown.

Parameters:

args - the number of arguments of the function

Returns:

the function result

Throws:

FunctionN.FunctionSizeException - if the number of arguments of the function is not equal to its arity

andThen

default <V> FunctionN<V> andThen(Function1<? super R,? extends V> after)

Description copied from interface: ResultChainable

Returns a chained object that applies this chainable object, and then applies the after function to ths result. If evaluation of either throws an exception, it is relayed to the caller of the chained object.

Specified by:

andThen in interface ResultChainable<R>

Specified by:

andThen in interface ResultChainableResult<R>

Type Parameters:

V - the type of the output of the after function, and of the chained object

Parameters:

after - the function to apply after this chainable object is applied

Returns:

a chained object that applies this chainable object and then applies the after function

andThenUnchecked

default <V> FunctionN<V> andThenUnchecked(Function1<? super R,? extends V> after)

Description copied from interface: ResultChainable

Returns a chained object that applies this chainable object, and then applies the after function to ths result. If evaluation of either throws an exception, it is relayed to the caller of the chained object. This makes no assumptions on the arguments of this method.

Specified by:

andThenUnchecked in interface ResultChainable<R>

Specified by:

andThenUnchecked in interface ResultChainableResult<R>

Type Parameters:

V - the type of the output of the after function, and of the chained object

Parameters:

after - the function to apply after this chainable object is applied

Returns:

a chained object that applies this chainable object and then applies the after function

checkSize

static <T> T[] checkSize(int size,
                         T[] array)

Checks the size of the array to see if it is equal to the expected size. If not, an exception is thrown.

Type Parameters:

T - the type of the elements in the array

Parameters:

size - the expected size of the array

array - the array being checked

Returns:

the array if the sizes are equal

Throws:

FunctionN.FunctionSizeException - if the array's length and the expected size are not equal

checkSize

static <T> T[] checkSize(int size,
                         T[] array,
                         java.lang.String message)

Checks the size of the array to see if it is equal to the expected size. If not, an exception is thrown.

Type Parameters:

T - the type of the elements in the array

Parameters:

size - the expected size of the array

array - the array being checked

message - the error message shown if the array's length and the expected size are not equal

Returns:

the array if the sizes are equal

Throws:

FunctionN.FunctionSizeException - if the array's length and the expected size are not equal