org.apache.commons.functor.adapter
Class IgnoreRightProcedure<L,R>

java.lang.Object
  extended by org.apache.commons.functor.adapter.IgnoreRightProcedure<L,R>
Type Parameters:
L - the left argument type.
R - the right argument type.
All Implemented Interfaces:
Serializable, BinaryFunctor<L,R>, BinaryProcedure<L,R>, Functor

public final class IgnoreRightProcedure<L,R>
extends Object
implements BinaryProcedure<L,R>, Serializable

Adapts a UnaryProcedure to the BinaryProcedure interface by ignoring the second binary argument.

Note that although this class implements Serializable, a given instance will only be truly Serializable if the underlying functor is. Attempts to serialize an instance whose delegate is not Serializable will result in an exception.

Version:
$Revision: 1157617 $ $Date: 2011-08-14 21:53:50 +0200 (Sun, 14 Aug 2011) $
Author:
Rodney Waldhoff
See Also:
Serialized Form

Constructor Summary
IgnoreRightProcedure(UnaryProcedure<? super L> procedure)
          Create a new IgnoreRightProcedure.
 
Method Summary
static
<L,R> IgnoreRightProcedure<L,R>
adapt(UnaryProcedure<? super L> procedure)
          Adapt a UnaryProcedure to the BinaryProcedure interface.
 boolean equals(IgnoreRightProcedure<?,?> that)
          Learn whether another IgnoreRightProcedure is equal to this.
 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.
 void run(L left, R right)
          Execute this procedure.
 String toString()
          Returns a human readable description of this functor.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IgnoreRightProcedure

public IgnoreRightProcedure(UnaryProcedure<? super L> procedure)
Create a new IgnoreRightProcedure.

Parameters:
procedure - UnaryProcedure to adapt
Method Detail

run

public void run(L left,
                R right)
Execute this procedure.

Specified by:
run in interface BinaryProcedure<L,R>
Parameters:
left - the L element of the ordered pair of arguments
right - the R element of the ordered pair of arguments

equals

public 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.

Specified by:
equals in interface Functor
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:
Functor.hashCode()

equals

public boolean equals(IgnoreRightProcedure<?,?> that)
Learn whether another IgnoreRightProcedure is equal to this.

Parameters:
that - IgnoreRightProcedure to test
Returns:
boolean

hashCode

public 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.

Specified by:
hashCode in interface Functor
Overrides:
hashCode in class Object
Returns:
a hash code for this functor
See Also:
Functor.equals(java.lang.Object)

toString

public 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.

Specified by:
toString in interface Functor
Overrides:
toString in class Object
Returns:
a human readable description of this functor

adapt

public static <L,R> IgnoreRightProcedure<L,R> adapt(UnaryProcedure<? super L> procedure)
Adapt a UnaryProcedure to the BinaryProcedure interface.

Type Parameters:
L - left type
R - right type
Parameters:
procedure - UnaryProcedure to adapt
Returns:
IgnoreRightProcedure


Copyright © 2003-2011 The Apache Software Foundation. All Rights Reserved.