| 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.aggregator |
This package contains the interfaces and utilities needed to implement
an aggregation service.
|
| org.apache.commons.functor.aggregator.functions |
This package contains
Function's used by aggregators
defined in org.apache.commons.functor.aggregator. |
| 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.
|
| Modifier and Type | Interface and 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<A,T>
A functor that takes one argument and returns an
Object value. |
interface |
NullaryFunction<T>
A functor that takes no arguments and returns a value.
|
interface |
NullaryFunctor
Marker interface for nullary (zero-argument) functors.
|
interface |
NullaryPredicate
A functor that takes no arguments and returns a
boolean value. |
interface |
NullaryProcedure
A functor that takes no arguments and returns no value.
|
interface |
Predicate<A>
A functor that takes one argument and returns a
boolean value. |
interface |
Procedure<A>
A functor that takes one argument and returns no value.
|
interface |
UnaryFunctor<A>
Marker interface for unary (single-argument) functors.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BinaryFunctionBinaryPredicate<L,R>
|
class |
BinaryFunctionBinaryProcedure<L,R>
Adapts a
BinaryFunction
to the BinaryProcedure
interface by ignoring the value returned
by the function. |
class |
BinaryFunctionFunction<A,T>
Adapts a BinaryFunction as a Function by sending the same argument to both sides of the BinaryFunction.
|
class |
BinaryPredicateBinaryFunction<L,R>
Adapts a
BinaryPredicate
to the
BinaryFunction interface. |
class |
BinaryPredicatePredicate<A>
Adapts a BinaryPredicate as a Predicate by sending the same argument to both sides of the BinaryPredicate.
|
class |
BinaryProcedureBinaryFunction<L,R,T>
|
class |
BinaryProcedureProcedure<A>
Adapts a BinaryProcedure as a Procedure by sending the same argument to both sides of the BinaryProcedure.
|
class |
BoundNullaryFunction<T>
Adapts a
Function
to the
NullaryFunction interface
using a constant unary argument. |
class |
BoundNullaryPredicate
Adapts a
Predicate
to the
NullaryPredicate interface
using a constant unary argument. |
class |
BoundNullaryProcedure
Adapts a
Procedure
to the
NullaryProcedure interface
using a constant unary argument. |
class |
FullyBoundNullaryFunction<T>
Adapts a
BinaryFunction
to the
NullaryFunction interface
using constant arguments. |
class |
FullyBoundNullaryPredicate
Adapts a
BinaryPredicate
to the
NullaryPredicate interface
using a constant left-side argument. |
class |
FullyBoundNullaryProcedure
Adapts a
BinaryProcedure
to the
NullaryProcedure interface
using a constant left-side argument. |
class |
FunctionPredicate<A>
|
class |
FunctionProcedure<A>
|
class |
IgnoreLeftFunction<L,R,T>
Adapts a
Function
to the
BinaryFunction interface
by ignoring the first binary argument. |
class |
IgnoreLeftPredicate<L,R>
Adapts a
Predicate
to the
BinaryPredicate interface
by ignoring the first binary argument. |
class |
IgnoreLeftProcedure<L,R>
Adapts a
Procedure
to the
BinaryProcedure interface
by ignoring the first binary argument. |
class |
IgnoreRightFunction<L,R,T>
Adapts a
Function
to the
BinaryFunction interface
by ignoring the second binary argument. |
class |
IgnoreRightPredicate<L,R>
Adapts a
Predicate
to the
BinaryPredicate interface
by ignoring the second binary argument. |
class |
IgnoreRightProcedure<L,R>
Adapts a
Procedure
to the
BinaryProcedure interface
by ignoring the second binary argument. |
class |
LeftBoundFunction<A,T>
Adapts a
BinaryFunction
to the
Function interface
using a constant left-side argument. |
class |
LeftBoundPredicate<A>
Adapts a
BinaryPredicate
to the
Predicate interface
using a constant left-side argument. |
class |
LeftBoundProcedure<A>
Adapts a
BinaryProcedure
to the
Procedure interface
using a constant left-side argument. |
class |
NullaryFunctionFunction<A,T>
Adapts a
NullaryFunction
to the
Function interface
by ignoring the unary argument. |
class |
NullaryFunctionNullaryPredicate
|
class |
NullaryFunctionNullaryProcedure
Adapts a
NullaryFunction
to the NullaryProcedure
interface by ignoring the value returned
by the function. |
class |
NullaryPredicateNullaryFunction
Adapts a
Predicate
to the
NullaryFunction interface. |
class |
NullaryPredicatePredicate<A>
Adapts a
NullaryPredicate
to the
Predicate interface
by ignoring the given argument. |
class |
NullaryProcedureNullaryFunction<T>
|
class |
NullaryProcedureProcedure<A>
|
class |
PredicateFunction<A>
|
class |
ProcedureFunction<A,T>
|
class |
RightBoundFunction<A,T>
Adapts a
BinaryFunction
to the
Function interface
using a constant right-side argument. |
class |
RightBoundPredicate<A>
Adapts a
BinaryPredicate
to the
Predicate interface
using a constant left-side argument. |
class |
RightBoundProcedure<A>
Adapts a
BinaryProcedure
to the
Procedure interface
using a constant left-side argument. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
Aggregator<T>
Interface which offers a means of "aggregating" data.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractListBackedAggregator<T>
An aggregator which stores the data series in a List.
|
class |
AbstractNoStoreAggregator<T>
An implementation of an aggregator which doesn't store the data series but
instead it processes the data on the fly, as it arrives in
AbstractTimedAggregator.add(Object) and stores the result after each addition. |
class |
AbstractTimedAggregator<T>
An aggregator which automatically resets the aggregated data at regular
intervals and sends a notification when it is about to do so, so listeners
can decide to gather the information before it is being reset (and log it
etc).
|
class |
ArrayListBackedAggregator<T>
Implementation of an aggregator which stores the data series in an
ArrayList. |
| Modifier and Type | Class and Description |
|---|---|
class |
DoubleMaxAggregatorBinaryFunction
Aggregation function to be used with subclasses of
AbstractNoStoreAggregator which
finds the maximum of 2 double(s). |
class |
DoubleMaxAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which finds the maximum number in a list. |
class |
DoubleMeanValueAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which computes the arithmetic mean of all the numbers in the list. |
class |
DoubleMedianValueAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which computes the median
of all the numbers in the list. |
class |
DoublePercentileAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which retrieves the percentile value for a
given percentile. |
class |
DoubleSumAggregatorBinaryFunction
Aggregator function to be used with subclasses of
AbstractNoStoreAggregator which
sums up the 2 given numbers (hence the "Binary" in the name!). |
class |
DoubleSumAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which sums up all the numbers in the list. |
class |
IntegerCountAggregatorBinaryFunction
Aggregator function to be used with subclasses of
AbstractNoStoreAggregator which
simply increments the first argument by 1 and returns it. |
class |
IntegerMaxAggregatorBinaryFunction
Aggregation function to be used with subclasses of
AbstractNoStoreAggregator which
finds the maximum of 2 ints. |
class |
IntegerMaxAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which finds the maximum number in a list. |
class |
IntegerMeanValueAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which computes the arithmetic mean of all the numbers in the list. |
class |
IntegerMedianValueAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which computes the median
of all the numbers in the list. |
class |
IntegerPercentileAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which retrieves the percentile value for a
given percentile. |
class |
IntegerSumAggregatorBinaryFunction
Aggregator function to be used with subclasses of
AbstractNoStoreAggregator which
sums up the 2 given numbers (hence the "Binary" in the name!). |
class |
IntegerSumAggregatorFunction
Aggregator function to be used with subclasses of
AbstractListBackedAggregator
which sums up all the numbers in the list. |
| Modifier and Type | Class and Description |
|---|---|
class |
Constant<T>
Evaluates to constant value. |
class |
Identity<T>
Evaluates to its input argument. |
class |
IsEqual<L,R>
|
class |
IsInstance<T>
|
class |
IsNotEqual<L,R>
|
class |
IsNotNull<T>
|
class |
IsNotSame<L,R>
Tests the reference (! |
class |
IsNull<A>
|
class |
IsSame<L,R>
Tests the reference (==) equality of its arguments. |
class |
Limit
A predicate that returns
true
the first n times it is invoked, and
false thereafter. |
class |
NoOp
A procedure that does nothing at all.
|
class |
Offset
A predicate that returns
false
the first n times it is invoked, and
true thereafter. |
| Modifier and Type | Class and Description |
|---|---|
class |
DoUntil
Do-until algorithm (test after).
|
class |
DoWhile
Do-while algorithm (test after).
|
class |
FindWithinGenerator<E>
|
class |
FoldLeft<T>
Functional left-fold algorithm against the elements of a
Generator. |
class |
FoldRight<T>
Functional right-fold algorithm against the elements of a
Generator. |
class |
GeneratorContains<T>
|
class |
IndexOfInGenerator<T>
Return the index of the first Object in a
LoopGenerator matching a
Predicate, or -1 if not found. |
class |
InPlaceTransform<T>
Implements an in-place transformation of a ListIterator's contents.
|
class |
RecursiveEvaluation
Tail recursion for
functions. |
class |
RemoveMatching<T>
Remove elements from left Iterator that match right Predicate.
|
class |
RetainMatching<T>
Retain elements in left Iterator that match right Predicate.
|
class |
UntilDo
Until-do algorithm (test before).
|
class |
WhileDo
While-do algorithm (test before).
|
| Modifier and Type | Class and Description |
|---|---|
class |
IsElementOf<L,R>
A
BinaryPredicate that checks to see if the
specified object is an element of the specified
Collection. |
class |
IsEmpty<A>
A
Predicate that checks to see if the specified object is empty. |
class |
Size<A>
Returns the size of the specified Collection, or the length
of the specified array or String.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ComparatorFunction<T>
Adapts a
Comparator to the
BinaryFunction interface. |
class |
IsEquivalent<T>
A
BinaryPredicate that tests
true iff the left argument is equal to the
right argument under the specified Comparator. |
class |
IsGreaterThan<T>
A
BinaryPredicate that tests
true iff the left argument is greater than the
right argument under the specified Comparator. |
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. |
class |
IsLessThan<T>
A
BinaryPredicate that tests
true iff the left argument is greater than the
right argument under the specified Comparator. |
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. |
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
Predicate that tests whether a Comparable object is
within a range. |
class |
Max<T>
Adapts a
Comparator to the
BinaryFunction interface. |
class |
Min<T>
Adapts a
Comparator to the
BinaryFunction interface. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractLoopNullaryProcedure
Abstract base class for
WhileDoNullaryProcedure and DoWhileNullaryProcedure
used to implement loop procedures. |
class |
And<A>
|
class |
BinaryAnd<L,R>
|
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)). |
class |
BinaryNot<L,R>
Tests to the logical inverse
of some other predicate. |
class |
BinaryOr<L,R>
|
class |
BinarySequence<L,R>
|
class |
CompositeBinaryFunction<L,R,T>
A
BinaryFunction composed of
one binary function, f, and two
functions, g and h,
evaluating the ordered parameters x, y
to f(g(x),h(y)). |
class |
CompositeBinaryPredicate<L,R>
A
BinaryPredicate composed of
one binary predicate, p, and two
functions, f and g,
evaluating the ordered parameters x, y
to p(f(x),g(y)). |
class |
CompositeFunction<A,T>
|
class |
CompositePredicate<A>
|
class |
CompositeProcedure<A>
|
class |
ConditionalBinaryFunction<L,R,T>
A
BinaryFunction
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
ConditionalBinaryPredicate<L,R>
A
BinaryPredicate
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
ConditionalBinaryProcedure<L,R>
A
BinaryProcedure
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
ConditionalFunction<A,T>
A
Function
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
ConditionalNullaryFunction<T>
A
NullaryFunction
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
ConditionalNullaryPredicate
A
NullaryPredicate
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
ConditionalNullaryProcedure
A
NullaryProcedure
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
ConditionalPredicate<A>
A
Predicate
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
ConditionalProcedure<A>
A
Procedure
similiar to Java's "ternary"
or "conditional" operator (? :). |
class |
DoWhileNullaryProcedure
A
NullaryProcedure implementation of a while loop. |
class |
Not<A>
Tests to the logical inverse
of some other predicate. |
class |
NullaryAnd
|
class |
NullaryNot
Tests to the logical inverse
of some other predicate. |
class |
NullaryOr
|
class |
NullarySequence
|
class |
Or<A>
|
class |
Sequence<A>
|
class |
TransformedBinaryFunction<L,R,T>
A BinaryFunction whose result is then run through a Function.
|
class |
TransformedBinaryProcedure<L,R>
A BinaryProcedure composed of a BinaryFunction whose result is then run through a Procedure.
|
class |
TransformedNullaryFunction<T>
A NullaryFunction whose result is then run through a Function.
|
class |
TransformedNullaryProcedure
A NullaryProcedure composed of a NullaryFunction whose result is then run through a Procedure.
|
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. |
class |
WhileDoNullaryProcedure
A
NullaryProcedure implementation of a while loop. |
| Modifier and Type | Class and Description |
|---|---|
class |
CollectionTransformer<E,C extends Collection<? super E>>
Transforms a generator into a collection.
|
Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.