Uses of Interface
org.apache.commons.functor.Functor

Packages that use Functor

Package	Description
org.apache.commons.functor	Basic functor interfaces.
org.apache.commons.functor.adapter	Classes that adapt one functor interface to another.
org.apache.commons.functor.core	Commonly used functor implementations.
org.apache.commons.functor.core.algorithm	Various algorithm-esque functors.
org.apache.commons.functor.core.collection	Collection-based functors, algorithms and utilities.
org.apache.commons.functor.core.comparator	Comparator- and Comparable-based functors, algorithms and utilities.
org.apache.commons.functor.core.composite	Functors composed of other functors.
org.apache.commons.functor.generator.util	Contains utility code for Generators.

Uses of Functor in org.apache.commons.functor

Subinterfaces of Functor in org.apache.commons.functor

Modifier and Type	Interface	Description
interface	BinaryFunction<L,R,T>	A functor that takes two arguments and returns a value.
interface	BinaryFunctor<L,R>	Marker interface for binary (two-argument) functors.
interface	BinaryPredicate<L,R>	A functor that takes two arguments and returns a boolean value.
interface	BinaryProcedure<L,R>	A functor that takes two arguments and has no return value.
interface	Function<T>	A functor that takes no arguments and returns a value.
interface	NullaryFunctor	Marker interface for nullary (zero-argument) functors.
interface	Predicate	A functor that takes no arguments and returns a boolean value.
interface	Procedure	A functor that takes no arguments and returns no value.
interface	UnaryFunction<A,T>	A functor that takes one argument and returns an Object value.
interface	UnaryFunctor<A>	Marker interface for unary (single-argument) functors.
interface	UnaryPredicate<A>	A functor that takes one argument and returns a boolean value.
interface	UnaryProcedure<A>	A functor that takes one argument and returns no value.

Uses of Functor in org.apache.commons.functor.adapter

Classes in org.apache.commons.functor.adapter that implement Functor

Modifier and Type	Class	Description
final class	BinaryFunctionBinaryPredicate<L,R>	Adapts a Boolean-valued BinaryFunction to the BinaryPredicate interface.
final class	BinaryFunctionBinaryProcedure<L,R>	Adapts a BinaryFunction to the BinaryProcedure interface by ignoring the value returned by the function.
final class	BinaryFunctionUnaryFunction<A,T>	Adapts a BinaryFunction as a UnaryFunction by sending the same argument to both sides of the BinaryFunction.
final class	BinaryPredicateBinaryFunction<L,R>	Adapts a BinaryPredicate to the BinaryFunction interface.
final class	BinaryPredicateUnaryPredicate<A>	Adapts a BinaryPredicate as a UnaryPredicate by sending the same argument to both sides of the BinaryPredicate.
final class	BinaryProcedureBinaryFunction<L,R,T>	Adapts a BinaryProcedure to the BinaryFunction interface by always returning null.
final class	BinaryProcedureUnaryProcedure<A>	Adapts a BinaryProcedure as a UnaryProcedure by sending the same argument to both sides of the BinaryProcedure.
final class	BoundFunction<T>	Adapts a UnaryFunction to the Function interface using a constant unary argument.
final class	BoundPredicate	Adapts a UnaryPredicate to the Predicate interface using a constant unary argument.
final class	BoundProcedure	Adapts a UnaryProcedure to the Procedure interface using a constant unary argument.
final class	FullyBoundFunction<T>	Adapts a BinaryFunction to the Function interface using constant arguments.
final class	FullyBoundPredicate	Adapts a BinaryPredicate to the UnaryPredicate interface using a constant left-side argument.
final class	FullyBoundProcedure	Adapts a BinaryProcedure to the Procedure interface using a constant left-side argument.
final class	FunctionPredicate	Adapts a Boolean-valued Function to the Predicate interface.
final class	FunctionProcedure	Adapts a Function to the Procedure interface by ignoring the value returned by the function.
final class	FunctionUnaryFunction<A,T>	Adapts a Function to the UnaryFunction interface by ignoring the unary argument.
final class	IgnoreLeftFunction<L,R,T>	Adapts a UnaryFunction to the BinaryFunction interface by ignoring the first binary argument.
final class	IgnoreLeftPredicate<L,R>	Adapts a UnaryPredicate to the BinaryPredicate interface by ignoring the first binary argument.
final class	IgnoreLeftProcedure<L,R>	Adapts a UnaryProcedure to the BinaryProcedure interface by ignoring the first binary argument.
final class	IgnoreRightFunction<L,R,T>	Adapts a UnaryFunction to the BinaryFunction interface by ignoring the second binary argument.
final class	IgnoreRightPredicate<L,R>	Adapts a UnaryPredicate to the BinaryPredicate interface by ignoring the second binary argument.
final class	IgnoreRightProcedure<L,R>	Adapts a UnaryProcedure to the BinaryProcedure interface by ignoring the second binary argument.
final class	LeftBoundFunction<A,T>	Adapts a BinaryFunction to the UnaryFunction interface using a constant left-side argument.
final class	LeftBoundPredicate<A>	Adapts a BinaryPredicate to the UnaryPredicate interface using a constant left-side argument.
final class	LeftBoundProcedure<A>	Adapts a BinaryProcedure to the UnaryProcedure interface using a constant left-side argument.
final class	PredicateFunction	Adapts a Predicate to the Function interface.
final class	PredicateUnaryPredicate<A>	Adapts a Predicate to the UnaryPredicate interface by ignoring the given argument.
final class	ProcedureFunction<T>	Adapts a Procedure to the Function interface by always returning null.
final class	ProcedureUnaryProcedure<A>	Adapts a Procedure to the UnaryProcedure interface by ignoring the arguments.
final class	RightBoundFunction<A,T>	Adapts a BinaryFunction to the UnaryFunction interface using a constant right-side argument.
final class	RightBoundPredicate<A>	Adapts a BinaryPredicate to the UnaryPredicate interface using a constant left-side argument.
final class	RightBoundProcedure<A>	Adapts a BinaryProcedure to the UnaryProcedure interface using a constant left-side argument.
final class	UnaryFunctionUnaryPredicate<A>	Adapts a Boolean-valued UnaryFunction to the UnaryPredicate interface.
final class	UnaryFunctionUnaryProcedure<A>	Adapts a UnaryFunction to the UnaryProcedure interface by ignoring the value returned by the function.
final class	UnaryPredicateUnaryFunction<A>	Adapts a UnaryPredicate to the UnaryFunction interface.
final class	UnaryProcedureUnaryFunction<A,T>	Adapts a UnaryProcedure to the UnaryFunction interface by always returning null.

Uses of Functor in org.apache.commons.functor.core

Classes in org.apache.commons.functor.core that implement Functor

Modifier and Type	Class	Description
final class	Constant<T>	Evaluates to constant value.
final class	Identity<T>	Evaluates to its input argument.
final class	IsEqual<L,R>	Tests true iff its arguments are equal or both null.
final class	IsInstance<T>	Tests true iff its argument is an instance of some specified Class.
final class	IsNotEqual<L,R>	Tests true iff its arguments are not equal or both null.
final class	IsNotNull<T>	Tests false iff its argument is null.
final class	IsNotSame<L,R>	Tests the reference (!=) inequality of its arguments.
final class	IsNull<A>	Tests true iff its argument is null.
final class	IsSame<L,R>	Tests the reference (==) equality of its arguments.
final class	Limit	A predicate that returns true the first n times it is invoked.
final class	NoOp	A procedure that does nothing at all.
final class	Offset	A predicate that returns false the first n times it is invoked, and true thereafter.

Uses of Functor in org.apache.commons.functor.core.algorithm

Classes in org.apache.commons.functor.core.algorithm that implement Functor

Modifier and Type	Class	Description
class	DoUntil	Do-until algorithm (test after).
class	DoWhile	Do-while algorithm (test after).
final class	FindWithinGenerator<E>	Return the first Object in a Generator matching a UnaryPredicate.
private static class	FindWithinGenerator.FindProcedure<T>	Helper procedure.
class	FoldLeft<T>	Functional left-fold algorithm against the elements of a Generator.
private static class	FoldLeft.FoldLeftHelper<T>	Helper procedure.
class	FoldRight<T>	Functional right-fold algorithm against the elements of a Generator.
private static class	FoldRight.FoldRightHelper<T>	Helper class.
final class	GeneratorContains<T>	Tests whether a Generator contains an element that matches a UnaryPredicate.
private static class	GeneratorContains.ContainsProcedure<T>	Helper procedure.
final class	IndexOfInGenerator<T>	Return the index of the first Object in a Generator matching a UnaryPredicate, or -1 if not found.
private static class	IndexOfInGenerator.IndexProcedure<T>	Helper procedure.
final class	InPlaceTransform<T>	Implements an in-place transformation of a ListIterator's contents.
(package private) class	PredicatedLoop	Base class for predicated procedure algorithms.
class	RecursiveEvaluation	Tail recursion for functions.
final class	RemoveMatching<T>	Remove elements from left Iterator that match right UnaryPredicate.
final class	RetainMatching<T>	Retain elements in left Iterator that match right UnaryPredicate.
class	UntilDo	Until-do algorithm (test before).
class	WhileDo	While-do algorithm (test before).

Uses of Functor in org.apache.commons.functor.core.collection

Classes in org.apache.commons.functor.core.collection that implement Functor

Modifier and Type	Class	Description
final class	IsElementOf<L,R>	A BinaryPredicate that checks to see if the specified object is an element of the specified Collection.
final class	IsEmpty<A>
final class	Size<A>	Returns the size of the specified Collection, or the length of the specified array or String.

Uses of Functor in org.apache.commons.functor.core.comparator

Classes in org.apache.commons.functor.core.comparator that implement Functor

Modifier and Type	Class	Description
final class	ComparatorFunction<T>	Adapts a Comparator to the BinaryFunction interface.
final class	IsEquivalent<T>	A BinaryPredicate that tests true iff the left argument is equal to the right argument under the specified Comparator.
final class	IsGreaterThan<T>	A BinaryPredicate that tests true iff the left argument is greater than the right argument under the specified Comparator.
final class	IsGreaterThanOrEqual<T>	A BinaryPredicate that tests true iff the left argument is greater than or equal to the right argument under the specified Comparator.
final class	IsLessThan<T>	A BinaryPredicate that tests true iff the left argument is greater than the right argument under the specified Comparator.
final class	IsLessThanOrEqual<T>	A BinaryPredicate that tests true iff the left argument is less than or equal to the right argument under the specified Comparator.
final class	IsNotEquivalent<T>	A BinaryPredicate that tests true iff the left argument is not equal to the right argument under the specified Comparator.
class	IsWithinRange<A extends Comparable<A>>	A UnaryPredicate that tests whether a Comparable object is within a range.
final class	Max<T>	Adapts a Comparator to the BinaryFunction interface.
final class	Min<T>	Adapts a Comparator to the BinaryFunction interface.

Uses of Functor in org.apache.commons.functor.core.composite

Classes in org.apache.commons.functor.core.composite that implement Functor

Modifier and Type	Class	Description
class	AbstractLoopProcedure	Abstract base class for WhileDoProcedure and DoWhileProcedure used to implement loop procedures.
final class	And	Tests true iff none of its children test false.
(package private) class	BaseBinaryPredicateList<L,R>	Abstract base class for BinaryPredicates composed of a list of BinaryPredicates.
(package private) class	BasePredicateList	Abstract base class for Predicates composed of a list of Predicates.
(package private) class	BaseUnaryPredicateList<A>	Abstract base class for UnaryPredicates composed of a list of UnaryPredicates.
final class	BinaryAnd<L,R>	Tests true iff none of its children test false.
class	BinaryCompositeBinaryFunction<L,R,T>	A BinaryFunction composed of three binary functions, f, g and h, evaluating the ordered parameters x, y to f(g(x,y),h(x,y)).
private static class	BinaryCompositeBinaryFunction.Helper<G,H,L,R,T>	Type-remembering Helper.
final class	BinaryNot<L,R>	Tests to the logical inverse of some other predicate.
final class	BinaryOr<L,R>	Tests true iff at least one of its children test true.
class	BinarySequence<L,R>	A BinaryProcedure that runs an ordered sequence of BinaryProcedures.
class	CompositeUnaryFunction<A,T>	A UnaryFunction representing the composition of UnaryFunctions, "chaining" the output of one to the input of another.
private static class	CompositeUnaryFunction.Helper<X,A,T>	Encapsulates a double function evaluation.
final class	CompositeUnaryPredicate<A>	A UnaryPredicate representing the composition of UnaryFunctions, "chaining" the output of one to the input of another.
final class	CompositeUnaryProcedure<A>	A UnaryProcedure representing the composition of UnaryFunctions, "chaining" the output of one to the input of another.
final class	ConditionalBinaryFunction<L,R,T>	A BinaryFunction similiar to Java's "ternary" or "conditional" operator (? :).
final class	ConditionalBinaryPredicate<L,R>	A BinaryPredicate similiar to Java's "ternary" or "conditional" operator (? :).
final class	ConditionalBinaryProcedure<L,R>	A BinaryProcedure similiar to Java's "ternary" or "conditional" operator (? :).
final class	ConditionalFunction<T>	A Function similiar to Java's "ternary" or "conditional" operator (? :).
final class	ConditionalPredicate	A Predicate similiar to Java's "ternary" or "conditional" operator (? :).
final class	ConditionalProcedure	A Procedure similiar to Java's "ternary" or "conditional" operator (? :).
final class	ConditionalUnaryFunction<A,T>	A UnaryFunction similiar to Java's "ternary" or "conditional" operator (? :).
final class	ConditionalUnaryPredicate<A>	A UnaryPredicate similiar to Java's "ternary" or "conditional" operator (? :).
final class	ConditionalUnaryProcedure<A>	A UnaryProcedure similiar to Java's "ternary" or "conditional" operator (? :).
class	DoWhileProcedure	A Procedure implementation of a while loop.
final class	Not	Tests to the logical inverse of some other predicate.
final class	Or	Tests true iff at least one of its children test true.
class	Sequence	A Procedure that runs an ordered sequence of Procedures.
class	TransformedBinaryFunction<L,R,T>	A BinaryFunction whose result is then run through a UnaryFunction.
private static final class	TransformedBinaryFunction.Helper<X,L,R,T>	Type-remembering helper.
class	TransformedBinaryProcedure<L,R>	A BinaryProcedure composed of a BinaryFunction whose result is then run through a UnaryProcedure.
private static final class	TransformedBinaryProcedure.Helper<X,L,R>	Type-remembering helper.
class	TransformedFunction<T>	A Function whose result is then run through a UnaryFunction.
private static final class	TransformedFunction.Helper<X,T>	Type-remembering helper.
class	TransformedProcedure	A Procedure composed of a Function whose result is then run through a UnaryProcedure.
private static final class	TransformedProcedure.Helper<X>	Type-remembering helper.
class	TransposedFunction<L,R,T>	Transposes (swaps) the arguments to some other function.
class	TransposedPredicate<L,R>	Transposes (swaps) the arguments to some other predicate.
class	TransposedProcedure<L,R>	Transposes (swaps) the arguments to some other procedure.
final class	UnaryAnd<A>	Tests true iff none of its children test false.
class	UnaryCompositeBinaryFunction<L,R,T>	A BinaryFunction composed of one binary function, f, and two unary functions, g and h, evaluating the ordered parameters x, y to f(g(x),h(y)).
private static class	UnaryCompositeBinaryFunction.Helper<G,H,L,R,T>
class	UnaryCompositeBinaryPredicate<L,R>	A BinaryPredicate composed of one binary predicate, p, and two unary functions, f and g, evaluating the ordered parameters x, y to p(f(x),g(y)).
private static class	UnaryCompositeBinaryPredicate.Helper<G,H,L,R>	Internal helper.
final class	UnaryNot<A>	Tests to the logical inverse of some other predicate.
final class	UnaryOr<A>	Tests true iff at least one of its children test true.
class	UnarySequence<A>	A UnaryProcedure that runs an ordered sequence of UnaryProcedures.
class	WhileDoProcedure	A Procedure implementation of a while loop.

Uses of Functor in org.apache.commons.functor.generator.util

Classes in org.apache.commons.functor.generator.util that implement Functor

Modifier and Type	Class	Description
class	CollectionTransformer<E>	Transforms a generator into a collection.