Package org.apache.commons.collections4.functors

Class EqualPredicate<T>

  • Type Parameters:
    T - the type of the input to the predicate.
    All Implemented Interfaces:
    java.io.Serializable, java.util.function.Predicate<T>, Predicate<T>
    public final class EqualPredicate<T>
extends AbstractPredicate<T>
implements java.io.Serializable
    Predicate implementation that returns true if the input is the same object as the one stored in this predicate by equals.
    Since:
    3.0
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      EqualPredicate​(T object)
      Constructor that performs no validation.
      EqualPredicate​(T test, Equator<T> equator)
      Constructor that performs no validation.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static <T> Predicate<T> equalPredicate​(T object)
      Creates the predicate.
      static <T> Predicate<T> equalPredicate​(T object, Equator<T> equator)
      Creates the identity predicate.
      java.lang.Object getValue()
      Gets the value.
      boolean test​(T object)
      Evaluates the predicate returning true if the input equals the stored value.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.function.Predicate

        and, negate, or

    • Constructor Detail

      • EqualPredicate

        public EqualPredicate​(T object)
        Constructor that performs no validation. Use equalPredicate if you want that.
        Parameters:
        object - the object to compare to

      • EqualPredicate

        public EqualPredicate​(T test,
                      Equator<T> equator)
        Constructor that performs no validation. Use equalPredicate if you want that.
        Parameters:
        test - the object to compare to
        equator - the equator to use for comparison
        Since:
        4.0

    • Method Detail

      • equalPredicate

        public static <T> Predicate<T> equalPredicate​(T object)
        Creates the predicate.
        Type Parameters:
        T - the type that the predicate queries
        Parameters:
        object - the object to compare to
        Returns:
        the predicate

      • equalPredicate

        public static <T> Predicate<T> equalPredicate​(T object,
                                              Equator<T> equator)
        Creates the identity predicate.
        Type Parameters:
        T - the type that the predicate queries
        Parameters:
        object - the object to compare to
        equator - the equator to use for comparison
        Returns:
        the predicate
        Since:
        4.0

      • getValue

        public java.lang.Object getValue()
        Gets the value.
        Returns:
        the value
        Since:
        3.1

      • test

        public boolean test​(T object)
        Evaluates the predicate returning true if the input equals the stored value.
        Specified by:
        test in interface java.util.function.Predicate<T>
        Specified by:
        test in interface Predicate<T>
        Parameters:
        object - the input object
        Returns:
        true if input object equals stored value