Module org.scijava.function

Package org.scijava.function

Class Functions

java.lang.Object

org.scijava.function.Functions

public final class Functions
extends Object

Container class for higher-arity Function-style functional interfaces—i.e. with functional method apply with a number of arguments corresponding to the arity.

• For 0-arity (nullary) functions, use Producer (and notice the functional method there is named Producer.create()).
• For 1-arity (unary) functions, use Function.
• For 2-arity (binary) functions, use BiFunction.

Author:

Curtis Rueden, Gabriel Selzer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Functions.Arity10<I1,I2,I3,I4,I5,I6,I7,I8,I9,I10,O>	A 10-arity specialization of Function.
static interface	Functions.Arity11<I1,I2,I3,I4,I5,I6,I7,I8,I9,I10,I11,O>	A 11-arity specialization of Function.
static interface	Functions.Arity12<I1,I2,I3,I4,I5,I6,I7,I8,I9,I10,I11,I12,O>	A 12-arity specialization of Function.
static interface	Functions.Arity13<I1,I2,I3,I4,I5,I6,I7,I8,I9,I10,I11,I12,I13,O>	A 13-arity specialization of Function.
static interface	Functions.Arity14<I1,I2,I3,I4,I5,I6,I7,I8,I9,I10,I11,I12,I13,I14,O>	A 14-arity specialization of Function.
static interface	Functions.Arity15<I1,I2,I3,I4,I5,I6,I7,I8,I9,I10,I11,I12,I13,I14,I15,O>	A 15-arity specialization of Function.
static interface	Functions.Arity16<I1,I2,I3,I4,I5,I6,I7,I8,I9,I10,I11,I12,I13,I14,I15,I16,O>	A 16-arity specialization of Function.
static interface	Functions.Arity3<I1,I2,I3,O>	A 3-arity specialization of Function.
static interface	Functions.Arity4<I1,I2,I3,I4,O>	A 4-arity specialization of Function.
static interface	Functions.Arity5<I1,I2,I3,I4,I5,O>	A 5-arity specialization of Function.
static interface	Functions.Arity6<I1,I2,I3,I4,I5,I6,O>	A 6-arity specialization of Function.
static interface	Functions.Arity7<I1,I2,I3,I4,I5,I6,I7,O>	A 7-arity specialization of Function.
static interface	Functions.Arity8<I1,I2,I3,I4,I5,I6,I7,I8,O>	A 8-arity specialization of Function.
static interface	Functions.Arity9<I1,I2,I3,I4,I5,I6,I7,I8,I9,O>	A 9-arity specialization of Function.
static interface	Functions.ArityN<O>

Field Summary

Fields

Modifier and Type	Field	Description
static HashMap<Class<?>,Integer>	ALL_ARITIES
static HashMap<Integer,Class<?>>	ALL_FUNCTIONS	All known function types and their arities.

Method Summary

Modifier and Type	Method	Description
static int	arityOf(Class<?> c)
static Class<?>	functionOfArity(int arity)
static boolean	isFunction(Class<?> c)
static <O> Functions.ArityN<O>	nary(BiFunction<?,?,O> f)	Converts a BiFunction to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Function<?,O> f)	Converts a Function to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity10<?,?,?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity10 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity11<?,?,?,?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity11 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity12<?,?,?,?,?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity12 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity13<?,?,?,?,?,?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity13 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity14<?,?,?,?,?,?,?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity14 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity15<?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity15 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity16<?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity16 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity3<?,?,?,O> f)	Converts a Functions.Arity3 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity4<?,?,?,?,O> f)	Converts a Functions.Arity4 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity5<?,?,?,?,?,O> f)	Converts a Functions.Arity5 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity6<?,?,?,?,?,?,O> f)	Converts a Functions.Arity6 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity7<?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity7 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity8<?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity8 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Functions.Arity9<?,?,?,?,?,?,?,?,?,O> f)	Converts a Functions.Arity9 to a Functions.ArityN.
static <O> Functions.ArityN<O>	nary(Producer<O> f)	Converts a Producer to a Functions.ArityN.
static Class<?>	superType(Class<?> c)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_FUNCTIONS

public static final HashMap<Integer,Class<?>> ALL_FUNCTIONS

All known function types and their arities. The entries are sorted by arity, i.e., the i-th entry has an arity of i. It might be nice to use a BiMap from e.g. Google Guava, but that would require a dependency on that component :(

ALL_ARITIES

public static final HashMap<Class<?>,Integer> ALL_ARITIES

Method Detail

isFunction

public static boolean isFunction(Class<?> c)

Returns:

true if the given type is a known function type, false otherwise.
Note that only the type itself and not its type hierarchy is considered.

Throws:

NullPointerException - If c is null.

superType

public static Class<?> superType(Class<?> c)

functionOfArity

public static Class<?> functionOfArity(int arity)

Parameters:

arity - an int corresponding to a Function of that arity.

Returns:

the Function of arity arity.

Throws:

IllegalArgumentException - iff there is no known Function of arity arity.

arityOf

public static int arityOf(Class<?> c)

Parameters:

c - the Class of unknown arity

Returns:

the arity of c, or -1 if c is not a Function.

nary

public static <O> Functions.ArityN<O> nary(Producer<O> f)

Converts a Producer to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Producer

Parameters:

f - the Producer to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Producer

nary

public static <O> Functions.ArityN<O> nary(Function<?,O> f)

Converts a Function to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Function

Parameters:

f - the Function to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Function

nary

public static <O> Functions.ArityN<O> nary(BiFunction<?,?,O> f)

Converts a BiFunction to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the BiFunction

Parameters:

f - the BiFunction to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the BiFunction

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity3<?,?,?,O> f)

Converts a Functions.Arity3 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity3

Parameters:

f - the Functions.Arity3 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity3

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity4<?,?,?,?,O> f)

Converts a Functions.Arity4 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity4

Parameters:

f - the Functions.Arity4 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity4

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity5<?,?,?,?,?,O> f)

Converts a Functions.Arity5 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity5

Parameters:

f - the Functions.Arity5 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity5

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity6<?,?,?,?,?,?,O> f)

Converts a Functions.Arity6 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity6

Parameters:

f - the Functions.Arity6 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity6

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity7<?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity7 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity7

Parameters:

f - the Functions.Arity7 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity7

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity8<?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity8 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity8

Parameters:

f - the Functions.Arity8 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity8

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity9<?,?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity9 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity9

Parameters:

f - the Functions.Arity9 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity9

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity10<?,?,?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity10 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity10

Parameters:

f - the Functions.Arity10 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity10

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity11<?,?,?,?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity11 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity11

Parameters:

f - the Functions.Arity11 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity11

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity12<?,?,?,?,?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity12 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity12

Parameters:

f - the Functions.Arity12 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity12

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity13<?,?,?,?,?,?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity13 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity13

Parameters:

f - the Functions.Arity13 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity13

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity14<?,?,?,?,?,?,?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity14 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity14

Parameters:

f - the Functions.Arity14 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity14

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity15<?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity15 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity15

Parameters:

f - the Functions.Arity15 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity15

nary

public static <O> Functions.ArityN<O> nary(Functions.Arity16<?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,O> f)

Converts a Functions.Arity16 to a Functions.ArityN.

Type Parameters:

O - the type variable linked the output of the Functions.Arity16

Parameters:

f - the Functions.Arity16 to be converted into a Functions.ArityN

Returns:

a Functions.ArityN created from the Functions.Arity16