org.apache.commons.functor
Interface Functor

All Known Subinterfaces:

BinaryFunction<L,R,T>, BinaryFunctor<L,R>, BinaryPredicate<L,R>, BinaryProcedure<L,R>, Function<T>, NullaryFunctor, Predicate, Procedure, UnaryFunction<A,T>, UnaryFunctor<A>, UnaryPredicate<A>, UnaryProcedure<A>

All Known Implementing Classes:

AbstractLoopProcedure, And, BinaryAnd, BinaryCompositeBinaryFunction, BinaryFunctionBinaryPredicate, BinaryFunctionBinaryProcedure, BinaryFunctionUnaryFunction, BinaryNot, BinaryOr, BinaryPredicateBinaryFunction, BinaryPredicateUnaryPredicate, BinaryProcedureBinaryFunction, BinaryProcedureUnaryProcedure, BinarySequence, BoundFunction, BoundPredicate, BoundProcedure, CollectionTransformer, ComparatorFunction, CompositeUnaryFunction, CompositeUnaryPredicate, CompositeUnaryProcedure, ConditionalBinaryFunction, ConditionalBinaryPredicate, ConditionalBinaryProcedure, ConditionalFunction, ConditionalPredicate, ConditionalProcedure, ConditionalUnaryFunction, ConditionalUnaryPredicate, ConditionalUnaryProcedure, Constant, DoUntil, DoWhile, DoWhileProcedure, FindWithinGenerator, FoldLeft, FoldRight, FullyBoundFunction, FullyBoundPredicate, FullyBoundProcedure, FunctionPredicate, FunctionProcedure, FunctionUnaryFunction, GeneratorContains, Identity, IgnoreLeftFunction, IgnoreLeftPredicate, IgnoreLeftProcedure, IgnoreRightFunction, IgnoreRightPredicate, IgnoreRightProcedure, IndexOfInGenerator, InPlaceTransform, IsElementOf, IsEmpty, IsEqual, IsEquivalent, IsGreaterThan, IsGreaterThanOrEqual, IsInstance, IsLessThan, IsLessThanOrEqual, IsNotEqual, IsNotEquivalent, IsNotNull, IsNotSame, IsNull, IsSame, IsWithinRange, LeftBoundFunction, LeftBoundPredicate, LeftBoundProcedure, Limit, Max, Min, NoOp, Not, Offset, Or, PredicateFunction, PredicateUnaryPredicate, ProcedureFunction, ProcedureUnaryProcedure, RecursiveEvaluation, RemoveMatching, RetainMatching, RightBoundFunction, RightBoundPredicate, RightBoundProcedure, Sequence, Size, TransformedBinaryFunction, TransformedBinaryProcedure, TransformedFunction, TransformedProcedure, TransposedFunction, TransposedPredicate, TransposedProcedure, UnaryAnd, UnaryCompositeBinaryFunction, UnaryCompositeBinaryPredicate, UnaryFunctionUnaryPredicate, UnaryFunctionUnaryProcedure, UnaryNot, UnaryOr, UnaryPredicateUnaryFunction, UnaryProcedureUnaryFunction, UnarySequence, UntilDo, WhileDo, WhileDoProcedure

public interface Functor

Functor marker interface. All provided functor interfaces extend this interface.

Implementors are encouraged but not required to make their functors Serializable.

Since:

1.0

Version:

$Revision: 647297 $ $Date: 2008-04-11 22:14:50 +0200 (Fri, 11 Apr 2008) $

Method Summary

boolean	equals(Object that) Indicates whether some other object is "equal to" this functor.
int	hashCode() Returns a hash code for this functor adhering to the general Object.hashCode contract.
String	toString() Returns a human readable description of this functor.

Method Detail

toString

String toString()

Returns a human readable description of this functor. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.

Overrides:

toString in class Object

Returns:

a human readable description of this functor

hashCode

int hashCode()

Returns a hash code for this functor adhering to the general Object.hashCode contract. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.

Overrides:

hashCode in class Object

Returns:

a hash code for this functor

See Also:

equals(java.lang.Object)

equals

boolean equals(Object that)

Indicates whether some other object is "equal to" this functor. This method must adhere to general Object.equals contract. Additionally, this method can return true only if the specified Object implements the same functor interface and is known to produce the same results and/or side-effects for the same arguments (if any).

While implementators are strongly encouraged to override the default Object implementation of this method, note that the default Object implementation does in fact adhere to the functor equals contract.

Overrides:

equals in class Object

Parameters:

that - the object to compare this functor to

Returns:

true iff the given object implements this functor interface, and is known to produce the same results and/or side-effects for the same arguments (if any).

See Also:

hashCode()