FilteredIterable (Commons Functor 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.functor.core.collection.FilteredIterable<T>

Type Parameters:
T - the Iterable generic type

All Implemented Interfaces:

Iterable<T>
```
public class FilteredIterable<T>
extends Object
implements Iterable<T>
```
Adds a fluent filtering API to any Iterable.

Version:

$Revision: 1344786 $ $Date: 2012-05-31 11:55:31 -0400 (Thu, 31 May 2012) $

Constructor Summary

Constructors
Modifier Constructor and Description

protected FilteredIterable(Iterable<? extends T> iterable)
Create a new FilteredIterable.

Constructors
Modifier	Constructor and Description
`protected`	`FilteredIterable(Iterable<? extends T> iterable)` Create a new FilteredIterable.

Method Summary

Methods
Modifier and Type	Method and Description
`static <T> FilteredIterable<T>`	`empty()` Get an empty FilteredIterable.
`Iterator<T>`	`iterator()`
`static <T> FilteredIterable<T>`	`of(Iterable<T> iterable)` Get a `FilteredIterable` of `iterable`.
`FilteredIterable<T>`	`retain(Class<?>... ofType)` Retain elements of any of specified types.
`<U> FilteredIterable<U>`	`retain(Class<U> type)` Retain elements of a given type with type-safety.
`FilteredIterable<T>`	`retain(UnaryPredicate<? super T> filter)` Retain only elements matching `predicate`.
`String`	`toString()`

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

- Constructor Detail
  - FilteredIterable
```
protected FilteredIterable(Iterable<? extends T> iterable)
```
    Create a new FilteredIterable.
    
    Parameters:
    iterable - wrapped
- Method Detail
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - retain
```
public FilteredIterable<T> retain(UnaryPredicate<? super T> filter)
```
    Retain only elements matching predicate.
    
    Parameters:
    filter - filter predicate, non-null
    
    Returns:
    this, fluently
  - retain
```
public <U> FilteredIterable<U> retain(Class<U> type)
```
    Retain elements of a given type with type-safety.
    
    Type Parameters:
    U - the input Class generic type.
    Parameters:
    type - filter, non-null
    
    Returns:
    new FilteredIterable instance that delegates to this
  - retain
```
public FilteredIterable<T> retain(Class<?>... ofType)
```
    Retain elements of any of specified types.
    
    Parameters:
    ofType - filter, non-null
    
    Returns:
    this, fluently
  - of
```
public static <T> FilteredIterable<T> of(Iterable<T> iterable)
```
    Get a FilteredIterable of iterable. If wrapped is null, result will also be null. A FilteredIterable argument will be passed back directly; any other argument will be wrapped in a new FilteredIterable object.
    
    Type Parameters:
    T - the input iterable generic type
    Parameters:
    iterable - wrapped
    
    Returns:
    FilteredIterable
  - empty
```
public static <T> FilteredIterable<T> empty()
```
    Get an empty FilteredIterable.
    
    Type Parameters:
    T - the expected Iterable generic type.
    
    Returns:
    FilteredIterable

Class FilteredIterable<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilteredIterable

Method Detail

iterator

toString

retain

retain

retain

of

empty