AbstractIteratorDecorator (Apache Commons Collections 3.2.2 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.collections.iterators.AbstractIteratorDecorator

All Implemented Interfaces:

Iterator

Direct Known Subclasses:

AbstractDualBidiMap.EntrySetIterator, AbstractDualBidiMap.KeySetIterator, AbstractDualBidiMap.ValuesIterator
```
public class AbstractIteratorDecorator
extends Object
implements Iterator
```
Provides basic behaviour for decorating an iterator with extra functionality.
All methods are forwarded to the decorated iterator.

Since:

Commons Collections 3.0

Version:

$Revision: 972404 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $

Author:

James Strachan, Stephen Colebourne

- Field Summary
  
  Fields
  Modifier and Type Field and Description
  
  protected Iterator iterator
  The iterator being decorated
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  AbstractIteratorDecorator(Iterator iterator)
  Constructor that decorates the specified iterator.
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  protected Iterator getIterator()
  Gets the iterator being decorated.
  
  boolean hasNext()
  
  Object next()
  
  void remove()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - iterator
```
protected final Iterator iterator
```
    The iterator being decorated
- Constructor Detail
  - AbstractIteratorDecorator
```
public AbstractIteratorDecorator(Iterator iterator)
```
    Constructor that decorates the specified iterator.
    
    Parameters:
    iterator - the iterator to decorate, must not be null
    
    Throws:
    
    IllegalArgumentException - if the collection is null
- Method Detail
  - getIterator
```
protected Iterator getIterator()
```
    Gets the iterator being decorated.
    
    Returns:
    the decorated iterator
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator
  - next
```
public Object next()
```
    Specified by:
    
    next in interface Iterator
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.