IsElementOf (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.collection.IsElementOf<L,R>

Type Parameters:
L - the left argument type.
R - the right argument type.

All Implemented Interfaces:

Serializable, BinaryFunctor<L,R>, BinaryPredicate<L,R>, Functor
```
public final class IsElementOf<L,R>
extends Object
implements BinaryPredicate<L,R>, Serializable
```
A BinaryPredicate that checks to see if the specified object is an element of the specified Collection.

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

IsElementOf()
Create a new IsElementOf.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`static IsElementOf<Object,Object>`	`instance()` Get an IsElementOf instance.
`static <A> UnaryPredicate<A>`	`instance(Object obj)` Get an IsElementOf(collection\|array) UnaryPredicate.
`boolean`	`test(L obj, R col)` Evaluate this predicate.
`String`	`toString()`

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

- Constructor Detail
  - IsElementOf
```
public IsElementOf()
```
    Create a new IsElementOf.
- Method Detail
  - test
```
public boolean test(L obj,
           R col)
```
    Evaluate this predicate.
    
    Specified by:
    
    test in interface BinaryPredicate<L,R>
    
    Parameters:
    obj - the L element of the ordered pair of arguments
    col - 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
  - instance
```
public static IsElementOf<Object,Object> instance()
```
    Get an IsElementOf instance.
    
    Returns:
    IsElementOf
  - instance
```
public static <A> UnaryPredicate<A> instance(Object obj)
```
    Get an IsElementOf(collection|array) UnaryPredicate.
    
    Type Parameters:
    A - the UnaryPredicate argument generic type
    Parameters:
    obj - collection/array to search
    
    Returns:
    UnaryPredicate

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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