org.apache.commons.collections.functors
Class NullIsExceptionPredicate<T>

java.lang.Object
  extended by org.apache.commons.collections.functors.NullIsExceptionPredicate<T>
All Implemented Interfaces:
Serializable, PredicateDecorator<T>, Predicate<T>

public final class NullIsExceptionPredicate<T>
extends Object
implements Predicate<T>, PredicateDecorator<T>, Serializable

Predicate implementation that throws an exception if the input is null.

Since:
Commons Collections 3.0
Version:
$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:34:30 $
Author:
Matt Hall, John Watkinson, Stephen Colebourne
See Also:
Serialized Form

Constructor Summary
NullIsExceptionPredicate(Predicate<T> predicate)
          Constructor that performs no validation.
 
Method Summary
 boolean evaluate(T object)
          Evaluates the predicate returning the result of the decorated predicate once a null check is performed.
static
<T> Predicate<T>
getInstance(Predicate<T> predicate)
          Factory to create the null exception predicate.
 Predicate<? super T>[] getPredicates()
          Gets the predicate being decorated.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NullIsExceptionPredicate

public NullIsExceptionPredicate(Predicate<T> predicate)
Constructor that performs no validation. Use getInstance if you want that.

Parameters:
predicate - the predicate to call after the null check
Method Detail

getInstance

public static <T> Predicate<T> getInstance(Predicate<T> predicate)
Factory to create the null exception predicate.

Parameters:
predicate - the predicate to decorate, not null
Returns:
the predicate
Throws:
IllegalArgumentException - if the predicate is null

evaluate

public boolean evaluate(T object)
Evaluates the predicate returning the result of the decorated predicate once a null check is performed.

Specified by:
evaluate in interface Predicate<T>
Parameters:
object - the input object
Returns:
true if decorated predicate returns true
Throws:
FunctorException - if input is null

getPredicates

public Predicate<? super T>[] getPredicates()
Gets the predicate being decorated.

Specified by:
getPredicates in interface PredicateDecorator<T>
Returns:
the predicate as the only element in an array
Since:
Commons Collections 3.1


Copyright © 2005-2005 Apache Software Foundation, Matt Hall, John Watkinson. All Rights Reserved.