public interface

Predicate

org.apache.commons.collections.Predicate
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
abstract boolean evaluate(Object object)
Use the specified parameter to perform a test that returns true or false.

Public Methods

public abstract boolean evaluate (Object object)

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