org.apache.commons.collections.functors

## Class IdentityPredicate

- java.lang.Object
- - org.apache.commons.collections.functors.IdentityPredicate

- All Implemented Interfaces:
    Serializable, Predicate

      public final class IdentityPredicate
      extends Object
      implements Predicate, Serializable

  Predicate implementation that returns true if the input is the same object as the one stored in this predicate.
  Since:
    Commons Collections 3.0
  Version:
    $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
  Author:
    Stephen Colebourne
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `IdentityPredicate(Object object)` Constructor that performs no validation.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `evaluate(Object object)` Evaluates the predicate returning true if the input object is identical to the stored object.
    `static Predicate` | `getInstance(Object object)` Factory to create the identity predicate.
    `Object` | `getValue()` Gets the value.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### IdentityPredicate

          public IdentityPredicate(Object object)

      Constructor that performs no validation. Use `getInstance` if you want that.
      Parameters:
        `object` - the object to compare to

  - ### Method Detail

    - #### getInstance

          public static Predicate getInstance(Object object)

      Factory to create the identity predicate.
      Parameters:
        `object` - the object to compare to
      Returns:
        the predicate
      Throws:
        `IllegalArgumentException` - if the predicate is null

    - #### evaluate

          public boolean evaluate(Object object)

      Evaluates the predicate returning true if the input object is identical to the stored object.
      Specified by:
        `evaluate` in interface `Predicate`
      Parameters:
        `object` - the input object
      Returns:
        true if input is the same object as the stored value

    - #### getValue

          public Object getValue()

      Gets the value.
      Returns:
        the value
      Since:
        Commons Collections 3.1

Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.