PublicationContentIterator

All Implemented Interfaces:

org.readium.r2.shared.publication.services.content.Content.Iterator
```
public final class PublicationContentIterator
 implements Content.Iterator
                    
```
A composite Content.Iterator which iterates through a whole publication and delegates the iteration inside a given resource to media type-specific iterators.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`PublicationContentIterator(Publication publication, Locator startLocator, List<SuspendFunction2<Resource, Locator, Content.Iterator>> resourceContentIteratorFactories)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Boolean`	`hasPrevious()`	Returns true if the iterator has a previous element, suspending the caller while processing it.
`Content.Element`	`previous()`	Retrieves the element computed by a preceding call to hasPrevious, or throws an IllegalStateException if hasPrevious was not invoked.
`Boolean`	`hasNext()`	Returns true if the iterator has a next element, suspending the caller while processing it.
`Content.Element`	`next()`	Retrieves the element computed by a preceding call to hasNext, or throws an IllegalStateException if hasNext was not invoked.

Methods inherited from class org.readium.r2.shared.publication.services.content.Content.Iterator
nextOrNull, previousOrNull
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PublicationContentIterator
```
PublicationContentIterator(Publication publication, Locator startLocator, List<SuspendFunction2<Resource, Locator, Content.Iterator>> resourceContentIteratorFactories)
```
    Parameters:
    
    publication - The Publication which will be iterated through.
    
    startLocator - Starting Locator in the publication.
    
    resourceContentIteratorFactories - List of ResourceContentIteratorFactory which will be used to create the iterator for each resource.
- Method Detail
  - hasPrevious
```
 Boolean hasPrevious()
```
    Returns true if the iterator has a previous element, suspending the caller while processing it.
  - previous
```
 Content.Element previous()
```
    Retrieves the element computed by a preceding call to hasPrevious, or throws an IllegalStateException if hasPrevious was not invoked. This method should only be used in pair with hasPrevious.
  - hasNext
```
 Boolean hasNext()
```
    Returns true if the iterator has a next element, suspending the caller while processing it.
  - next
```
 Content.Element next()
```
    Retrieves the element computed by a preceding call to hasNext, or throws an IllegalStateException if hasNext was not invoked. This method should only be used in pair with hasNext.