Class NoOp

java.lang.Object
org.apache.commons.functor.core.NoOp
All Implemented Interfaces:
Serializable, Runnable, BinaryFunctor<Object,Object>, BinaryProcedure<Object,Object>, Functor, NullaryFunctor, Procedure, UnaryFunctor<Object>, UnaryProcedure<Object>
public final class NoOp extends Object implements Procedure, UnaryProcedure<Object>, BinaryProcedure<Object,Object>, Serializable
A procedure that does nothing at all.

Note that this class implements Procedure, UnaryProcedure, and BinaryProcedure.

Version:
$Revision$ $Date$
See Also:

  • Field Details

    • INSTANCE

      public static final NoOp INSTANCE
      Basic NoOp instance.

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

  • Constructor Details

    • NoOp

      public NoOp()
      Create a new NoOp.

  • Method Details

    • run

      public void run()
      Execute this procedure.
      Specified by:
      run in interface Procedure
      Specified by:
      run in interface Runnable

    • run

      public void run(Object obj)
      Execute this procedure.
      Specified by:
      run in interface UnaryProcedure<Object>
      Parameters:
      obj - an A parameter to this execution

    • run

      public void run(Object left, Object right)
      Execute this procedure.
      Specified by:
      run in interface BinaryProcedure<Object,Object>
      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:

    • 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:

    • 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

    • instance

      public static NoOp instance()
      Get a NoOp instance.
      Returns:
      NoOp

    • unaryInstance

      public static <A> UnaryProcedure<A> unaryInstance()
      Get a typed NoOp UnaryProcedure.
      Type Parameters:
      A - type
      Returns:
      UnaryProcedure<A>

    • binaryInstance

      public static <L,R> BinaryProcedure<L,R> binaryInstance()
      Get a typed NoOp BinaryProcedure.
      Type Parameters:
      L - left type
      R - right type
      Returns:
      BinaryProcedure<L, R>