Class UnaryFunctionUnaryProcedure<A>
java.lang.Object
org.apache.commons.functor.adapter.UnaryFunctionUnaryProcedure<A>
- Type Parameters:
A- the argument type.
- All Implemented Interfaces:
Serializable, Functor, UnaryFunctor<A>, UnaryProcedure<A>
public final class UnaryFunctionUnaryProcedure<A>
extends Object
implements UnaryProcedure<A>, Serializable
Adapts a
UnaryFunction
to the UnaryProcedure
interface by ignoring the value returned
by the function.
Note that although this class implements
Serializable, a given instance will
only be truly Serializable if the
underlying function is. Attempts to serialize
an instance whose delegate is not
Serializable will result in an exception.- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final UnaryFunction<? super A, ?> TheUnaryFunctionI'm wrapping.private static final longserialVersionUID declaration. -
Constructor Summary
ConstructorsConstructorDescriptionUnaryFunctionUnaryProcedure(UnaryFunction<? super A, ?> function) Create anUnaryProcedurewrapping the givenUnaryFunction. -
Method Summary
Modifier and TypeMethodDescriptionstatic <A> UnaryFunctionUnaryProcedure<A> adapt(UnaryFunction<? super A, ?> function) booleanIndicates whether some other object is "equal to" this functor.booleanequals(UnaryFunctionUnaryProcedure<?> that) Learn whether a specified UnaryFunctionUnaryPredicate is equal to this.inthashCode()Returns a hash code for this functor adhering to the generalObject.hashCodecontract.voidEvaluatemy function, but ignore its returned value.toString()Returns a human readable description of this functor.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDserialVersionUID declaration.- See Also:
-
function
TheUnaryFunctionI'm wrapping.
-
-
Constructor Details
-
UnaryFunctionUnaryProcedure
Create anUnaryProcedurewrapping the givenUnaryFunction.- Parameters:
function- theUnaryFunctionto wrap
-
-
Method Details
-
run
Evaluatemy function, but ignore its returned value. Execute this procedure.- Specified by:
runin interfaceUnaryProcedure<A>- Parameters:
obj- an A parameter to this execution
-
equals
Indicates whether some other object is "equal to" this functor. This method must adhere to generalObject.equalscontract. 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
equalscontract.- Specified by:
equalsin interfaceFunctor- Overrides:
equalsin classObject- Parameters:
that- the object to compare this functor to- Returns:
trueiff 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:
-
equals
Learn whether a specified UnaryFunctionUnaryPredicate is equal to this.- Parameters:
that- the UnaryFunctionUnaryPredicate to test- Returns:
- boolean
-
hashCode
public int hashCode()Returns a hash code for this functor adhering to the generalObject.hashCodecontract. Implementators are strongly encouraged but not strictly required to override the defaultObjectimplementation of this method. -
toString
Returns a human readable description of this functor. Implementators are strongly encouraged but not strictly required to override the defaultObjectimplementation of this method. -
adapt
Adapt the given, possibly-null,UnaryFunctionto theUnaryProcedureinterface. When the givenUnaryFunctionisnull, returnsnull.- Type Parameters:
A- the argument type.- Parameters:
function- the possibly-nullUnaryFunctionto adapt- Returns:
- a
UnaryProcedurewrapping the givenUnaryFunction, ornullif the givenUnaryFunctionisnull
-