Package com.apptus.esales.connector

Class ProductStreamer

java.lang.Object

com.apptus.esales.connector.ProductStreamer

All Implemented Interfaces:

AutoCloseable, Iterable<Result.Product>

public class ProductStreamer
extends Object
implements Iterable<Result.Product>, AutoCloseable

An Iterable ProductStreamer that allows you to do filtered product exports, conveniently parsed into Result.Product items. Every new iteration on this class will result in a new request to eSales. Note that the ProductStreamer must be closed when done, which is most conveniently done by using a try-with-resources block as in the example below:

 try(ProductStreamer productStreamer = connector.exportProducts(null,null)){
     for (Product p : productStreamer){
         // Do something
     }
 }

While iterating, imports will be blocked from completing on a selected eSales server. Imports will not fail but will wait for the iteration to finish. This means that if you fail to close the ProductStreamer you might block imports indefinitely!

If the iteration is interrupted by an error, an InterruptedIterationException will be thrown. To save the whole result in memory, you can use the toList() convenience method.

Method Summary

Modifier and Type	Method	Description
void	close()
Iterator<Result.Product>	iterator()	Closes any previous iterator associated with this ProductStreamer and creates a new iterator.
List<Result.Product>	toList()	Iterates through all products and returns them as a list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

public Iterator<Result.Product> iterator()

Closes any previous iterator associated with this ProductStreamer and creates a new iterator. Makes a new eSales request.

Specified by:

iterator in interface Iterable<Result.Product>

Returns:

all Result.Product items as a list.

Throws:

InterruptedIterationException - if there was an error reading the stream, or the stream could not be parsed

toList

public List<Result.Product> toList()

Iterates through all products and returns them as a list. Note that this should only be done when the resulting list is small enough to be held in memory. This method also closes the iterator in a safe way.

Returns:

all Result.Product items as a list.

Throws:

InterruptedIterationException - if the iteration was prematurely interrupted due to an error reading the stream, or that the stream could not be parsed

close

public void close()

Specified by:

close in interface AutoCloseable