TransformListIterator (Helenus Common Utilities 1.0.14 API)

java.lang.Object
- org.helenus.commons.collections.iterators.TransformListIterator<I,O>

Type Parameters:

I - the type of element being iterated on input

O - the type of element returned on output

All Implemented Interfaces:

Iterator<O>, ListIterator<O>
```
public class TransformListIterator<I,O>
extends Object
implements ListIterator<O>
```
The TransformListIterator class provides a useful extension to the ListIterator interface in cases where a transforming function needs to be applied to the iterator before returning any elements.
The implementation provided here creates a list iterator which wraps around the given list iterator. The original list iterator is iterated as this list iterator is being accessed.

Since:

1.0

Version:

1 - Jan 15, 2015 - paouelle - Creation, 2 - Jan 15, 2015 - paouelle - Creation - Renamed and remodeled after TransformIterator

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Constructor Summary

Constructors
Constructor and Description
`TransformListIterator(ListIterator<? extends I> i)` Constructs a transforming list iterator using an input list iterator.
`TransformListIterator(ListIterator<? extends I> i, Transformer<? super I,? extends O> transformer)` Constructs a transforming list iterator using an input list iterator and the specified transformer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(O o)`
`ListIterator<? extends I>`	`getIterator()` Gets the iterator this iterator is using.
`Transformer<? super I,? extends O>`	`getTransformer()` Gets the transformer this iterator is using.
`boolean`	`hasNext()`
`boolean`	`hasPrevious()`
`O`	`next()`
`int`	`nextIndex()`
`O`	`previous()`
`int`	`previousIndex()`
`void`	`remove()`
`void`	`set(O o)`
`void`	`setIterator(ListIterator<? extends I> iterator)` Sets the iterator for this iterator to use.
`void`	`setTransformer(Transformer<? super I,? extends O> transformer)` Sets the transformer this iterator will use.
`protected O`	`transform(I source)` Transforms the given object using the transformer.

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

Methods inherited from interface java.util.Iterator
forEachRemaining

- Constructor Detail
  - TransformListIterator
```
public TransformListIterator(ListIterator<? extends I> i)
```
    Constructs a transforming list iterator using an input list iterator.
    
    Parameters:
    
    i - a list iterator to be transformed
  - TransformListIterator
```
public TransformListIterator(ListIterator<? extends I> i,
                             Transformer<? super I,? extends O> transformer)
```
    Constructs a transforming list iterator using an input list iterator and the specified transformer.
    
    Parameters:
    
    i - a list iterator to be transformed
    
    transformer - a transformer object
- Method Detail
  - transform
```
protected O transform(I source)
```
    Transforms the given object using the transformer.
    
    Parameters:
    
    source - the object to transform
    
    Returns:
    
    the transformed object
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<O>
    
    Specified by:
    
    hasNext in interface ListIterator<O>
    
    See Also:
    
    ListIterator.hasNext()
  - next
```
public O next()
```
    Specified by:
    
    next in interface Iterator<O>
    
    Specified by:
    
    next in interface ListIterator<O>
    
    See Also:
    
    ListIterator.next()
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<O>
    
    Specified by:
    
    remove in interface ListIterator<O>
    
    See Also:
    
    ListIterator.remove()
  - hasPrevious
```
public boolean hasPrevious()
```
    Specified by:
    
    hasPrevious in interface ListIterator<O>
    
    See Also:
    
    ListIterator.hasPrevious()
  - previous
```
public O previous()
```
    Specified by:
    
    previous in interface ListIterator<O>
    
    See Also:
    
    ListIterator.previous()
  - nextIndex
```
public int nextIndex()
```
    Specified by:
    
    nextIndex in interface ListIterator<O>
    
    See Also:
    
    ListIterator.nextIndex()
  - previousIndex
```
public int previousIndex()
```
    Specified by:
    
    previousIndex in interface ListIterator<O>
    
    See Also:
    
    ListIterator.previousIndex()
  - set
```
public void set(O o)
```
    Specified by:
    
    set in interface ListIterator<O>
    
    See Also:
    
    ListIterator.set(java.lang.Object)
  - add
```
public void add(O o)
```
    Specified by:
    
    add in interface ListIterator<O>
    
    See Also:
    
    ListIterator.add(java.lang.Object)
  - getIterator
```
public ListIterator<? extends I> getIterator()
```
    Gets the iterator this iterator is using.
    
    Returns:
    
    the iterator
  - setIterator
```
public void setIterator(ListIterator<? extends I> iterator)
```
    Sets the iterator for this iterator to use. If iteration has started, this effectively resets the iterator.
    
    Parameters:
    
    iterator - the iterator to use
  - getTransformer
```
public Transformer<? super I,? extends O> getTransformer()
```
    Gets the transformer this iterator is using.
    
    Returns:
    
    the transformer
  - setTransformer
```
public void setTransformer(Transformer<? super I,? extends O> transformer)
```
    Sets the transformer this iterator will use.
    
    Parameters:
    
    transformer - the transformer to use

Class TransformListIterator<I,O>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Constructor Detail

TransformListIterator

TransformListIterator

Method Detail

transform

hasNext

next

remove

hasPrevious

previous

nextIndex

previousIndex

set

add

getIterator

setIterator

getTransformer

setTransformer