AbstractPageLayoutActivityHelper.PagingIterator

java.lang.Object
- com.ibm.commerce.pagelayout.facade.server.helpers.activity.AbstractPageLayoutActivityHelper.PagingIterator<K>

Type Parameters:

K - The type of elements in the underlying list being iterated.

All Implemented Interfaces:

java.util.Iterator<java.util.List<K>>

Enclosing class:

AbstractPageLayoutActivityHelper
```
protected static class AbstractPageLayoutActivityHelper.PagingIterator<K>
extends java.lang.Object
implements java.util.Iterator<java.util.List<K>>
```
This iterator iterates over a list in a page-wise manner. The iterator divides the elements on the list into pages. The size of each page can be specified. By default, the page size is 1000. Each invocation of next returns a sub-set of elements that belong to the current page. The iterator does not support modifications on the underlying list.

Constructor Summary

Constructors
Constructor and Description
`AbstractPageLayoutActivityHelper.PagingIterator(int pageSize, java.util.List<K> listToPaginate)` Instantiates an iterator using the pageSize and list specified.
`AbstractPageLayoutActivityHelper.PagingIterator(java.util.List<K> listToPaginate)` Instantiates an iterator using the list specified.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`hasNext()` Answers if there are any more pages to return.
`java.util.List<K>`	`next()` Returns the list of the elements that belong to the current page.
`void`	`remove()` This method throws an `UnsupportedOperationException` as modifications on the underlying list is prohibited by the iterator.

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

- Constructor Detail
  - AbstractPageLayoutActivityHelper.PagingIterator
```
public AbstractPageLayoutActivityHelper.PagingIterator(int pageSize,
                                               java.util.List<K> listToPaginate)
```
    Instantiates an iterator using the pageSize and list specified.
    
    Parameters:
    
    pageSize - The size of each page.
    
    listToPaginate - The List that needs to be iterated over.
  - AbstractPageLayoutActivityHelper.PagingIterator
```
public AbstractPageLayoutActivityHelper.PagingIterator(java.util.List<K> listToPaginate)
```
    Instantiates an iterator using the list specified.
    
    Parameters:
    
    listToPaginate - The List that needs to be iterated over.
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Answers if there are any more pages to return.
    
    Specified by:
    
    hasNext in interface java.util.Iterator<java.util.List<K>>
    
    Returns:
    
    True, if there are more pages. False, otherwise.
  - next
```
public java.util.List<K> next()
```
    Returns the list of the elements that belong to the current page. The current page is then moved forward as per the page size.
    
    Specified by:
    
    next in interface java.util.Iterator<java.util.List<K>>
    
    Returns:
    
    The list of elements on the current page.
  - remove
```
public void remove()
```
    This method throws an UnsupportedOperationException as modifications on the underlying list is prohibited by the iterator.
    
    Specified by:
    
    remove in interface java.util.Iterator<java.util.List<K>>

Class AbstractPageLayoutActivityHelper.PagingIterator<K>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractPageLayoutActivityHelper.PagingIterator

AbstractPageLayoutActivityHelper.PagingIterator

Method Detail

hasNext

next

remove