IsWithinRange (Commons Functor 1.0-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.functor.core.comparator.IsWithinRange<A>

Type Parameters:
A - the predicate argument type.

All Implemented Interfaces:

Serializable, Functor, UnaryFunctor<A>, UnaryPredicate<A>
```
public class IsWithinRange<A extends Comparable<A>>
extends Object
implements UnaryPredicate<A>, Serializable
```
A UnaryPredicate that tests whether a Comparable object is within a range. The range is defined in the constructor.

Since:

1.0

Version:

$Revision: 1345136 $ $Date: 2012-06-01 08:47:06 -0400 (Fri, 01 Jun 2012) $

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

IsWithinRange(A min, A max)
Create a new IsWithinRange by passing in the range that will be used in the test(A).

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`static <A extends Comparable<A>> IsWithinRange<A>`	`instance(A min, A max)` Obtain an IsWithinRange instance.
`boolean`	`test(A o)` Evaluate this predicate.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IsWithinRange
```
public IsWithinRange(A min,
             A max)
```
    Create a new IsWithinRange by passing in the range that will be used in the test(A).
    
    Parameters:
    min - Comparable
    max - Comparable
- Method Detail
  - test
```
public final boolean test(A o)
```
    Evaluate this predicate. Test if the passed in object is within the specified range.
    
    Specified by:
    
    test in interface UnaryPredicate<A extends Comparable<A>>
    
    Parameters:
    o - the A object to test
    
    Returns:
    the result of this test
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - instance
```
public static <A extends Comparable<A>> IsWithinRange<A> instance(A min,
                                                  A max)
```
    Obtain an IsWithinRange instance.
    
    Type Parameters:
    A - the argument type.
    Parameters:
    min - the min value
    max - the max value
    
    Returns:
    IsWithinRange

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.