Limit (Apache 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.Limit

All Implemented Interfaces:

BinaryFunctor<Object,Object>, BinaryPredicate<Object,Object>, Functor, NullaryFunctor, NullaryPredicate, Predicate<Object>, UnaryFunctor<Object>
```
public final class Limit
extends Object
implements NullaryPredicate, Predicate<Object>, BinaryPredicate<Object,Object>
```
A predicate that returns true the first n times it is invoked, and false thereafter.

Since:

1.0

Version:

$Revision: 1539877 $ $Date: 2013-11-08 01:20:07 +0100 (Fr, 08 Nov 2013) $

Constructor Summary

Constructors
Constructor and Description

Limit(int count)
Create a new Limit.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`static Limit`	`of(int count)` Get a Limit instance for the specified value.
`boolean`	`test()` Evaluate this predicate.
`boolean`	`test(Object obj)` Evaluate this predicate.
`boolean`	`test(Object a, Object b)` Evaluate this predicate.
`String`	`toString()`

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

- Constructor Detail
  - Limit
```
public Limit(int count)
```
    Create a new Limit.
    
    Parameters:
    count - limit
- Method Detail
  - test
```
public boolean test()
```
    Evaluate this predicate.
    
    Specified by:
    
    test in interface NullaryPredicate
    
    Returns:
    the result of this test
  - test
```
public boolean test(Object obj)
```
    Evaluate this predicate.
    
    Specified by:
    
    test in interface Predicate<Object>
    
    Parameters:
    obj - the A object to test
    
    Returns:
    the result of this test
  - test
```
public boolean test(Object a,
           Object b)
```
    Evaluate this predicate.
    
    Specified by:
    
    test in interface BinaryPredicate<Object,Object>
    
    Parameters:
    a - the L element of the ordered pair of arguments
    b - the R element of the ordered pair of arguments
    
    Returns:
    the result of this test for the given arguments
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static Limit of(int count)
```
    Get a Limit instance for the specified value.
    
    Parameters:
    count - limit
    
    Returns:
    Limit

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.