Class UnaryFunctionUnaryPredicate<A>
- java.lang.Object
-
- org.apache.commons.functor.adapter.UnaryFunctionUnaryPredicate<A>
-
- Type Parameters:
A- the argument type.
- All Implemented Interfaces:
java.io.Serializable,Functor,UnaryFunctor<A>,UnaryPredicate<A>
public final class UnaryFunctionUnaryPredicate<A> extends java.lang.Object implements UnaryPredicate<A>, java.io.Serializable
Adapts aBoolean-valuedUnaryFunctionto theUnaryPredicateinterface. Note that although this class implementsSerializable, a given instance will only be trulySerializableif the underlying function is. Attempts to serialize an instance whose delegate is notSerializablewill result in an exception.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private UnaryFunction<? super A,java.lang.Boolean>functionTheUnaryFunctionI'm wrapping.private static longserialVersionUIDserialVersionUID declaration.
-
Constructor Summary
Constructors Constructor Description UnaryFunctionUnaryPredicate(UnaryFunction<? super A,java.lang.Boolean> function)Create anUnaryPredicatewrapping the givenUnaryFunction.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static <A> UnaryFunctionUnaryPredicate<A>adapt(UnaryFunction<? super A,java.lang.Boolean> function)booleanequals(java.lang.Object that)Indicates whether some other object is "equal to" this functor.booleanequals(UnaryFunctionUnaryPredicate<?> that)Learn whether another UnaryFunctionUnaryPredicate is equal to this.inthashCode()Returns a hash code for this functor adhering to the generalObject.hashCodecontract.booleantest(A obj)Evaluate this predicate.java.lang.StringtoString()Returns a human readable description of this functor.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
serialVersionUID declaration.- See Also:
- Constant Field Values
-
function
private final UnaryFunction<? super A,java.lang.Boolean> function
TheUnaryFunctionI'm wrapping.
-
-
Constructor Detail
-
UnaryFunctionUnaryPredicate
public UnaryFunctionUnaryPredicate(UnaryFunction<? super A,java.lang.Boolean> function)
Create anUnaryPredicatewrapping the givenUnaryFunction.- Parameters:
function- theUnaryFunctionto wrap
-
-
Method Detail
-
test
public boolean test(A obj)
Evaluate this predicate. Returns thebooleanvalue of the non-nullBooleanreturned by theevaluatemethod of my underlying function.- Specified by:
testin interfaceUnaryPredicate<A>- Parameters:
obj- the A object to test- Returns:
- the result of this test
-
equals
public boolean equals(java.lang.Object that)
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 classjava.lang.Object- 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:
Functor.hashCode()
-
equals
public boolean equals(UnaryFunctionUnaryPredicate<?> that)
Learn whether another UnaryFunctionUnaryPredicate is equal to this.- Parameters:
that- 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.- Specified by:
hashCodein interfaceFunctor- Overrides:
hashCodein classjava.lang.Object- Returns:
- a hash code for this functor
- See Also:
Functor.equals(java.lang.Object)
-
toString
public java.lang.String 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
public static <A> UnaryFunctionUnaryPredicate<A> adapt(UnaryFunction<? super A,java.lang.Boolean> function)
Adapt the given, possibly-null,UnaryFunctionto theUnaryPredicateinterface. When the givenUnaryFunctionisnull, returnsnull.- Type Parameters:
A- the argument type.- Parameters:
function- the possibly-nullUnaryFunctionto adapt- Returns:
- a
UnaryPredicatewrapping the givenUnaryFunction, ornullif the givenUnaryFunctionisnull
-
-