Package org.apache.commons.collections

Interface Predicate

All Known Subinterfaces:
PredicateDecorator
All Known Implementing Classes:
AbstractNodePredicate, AbstractResourcePredicate, AllPredicate, AndPredicate, AnyPredicate, AuthorizableFilterPredicate, AuthorizablePredicate, DialogPredicate, EqualPredicate, ExceptionPredicate, FalsePredicate, HierarchyNotFilePredicate, IdentityPredicate, InstanceofPredicate, IsAuthorizableFolderPredicate, IsFolderPredicate, IsHierarchyNodePredicate, IsNoSystemNodePredicate, IsPageNodePredicate, IsTemplateNodePredicate, IsUnstructuredPredicate, NonePredicate, NotNullPredicate, NotPredicate, NullIsExceptionPredicate, NullIsFalsePredicate, NullIsTruePredicate, NullPredicate, OnePredicate, OrPredicate, ResourceFilter, TransformedPredicate, TransformerPredicate, TruePredicate, UniquePredicate
@Deprecated(since="2021-04-30") public interface Predicate
Deprecated.
Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
Defines a functor interface implemented by classes that perform a predicate test on an object.

A Predicate is the object equivalent of an if statement. It uses the input object to return a true or false value, and is often used in validation or filtering.

Standard implementations of common predicates are provided by PredicateUtils. These include true, false, instanceof, equals, and, or, not, method invokation and null testing.

Since:
Commons Collections 1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    evaluate(Object object)
    Deprecated.
    Use the specified parameter to perform a test that returns true or false.

  • Method Details

    • evaluate

      boolean evaluate(Object object)
      Deprecated.
      Use the specified parameter to perform a test that returns true or false.
      Parameters:
      object - the object to evaluate, should not be changed
      Returns:
      true or false
      Throws:
      ClassCastException - (runtime) if the input is the wrong class
      IllegalArgumentException - (runtime) if the input is invalid
      FunctorException - (runtime) if the predicate encounters a problem