org.nuxeo.ecm.core.api.impl
Class DocumentModelIteratorImpl

java.lang.Object
  org.nuxeo.ecm.core.api.impl.DocumentModelIteratorImpl

All Implemented Interfaces:

Serializable, Iterable<DocumentModel>, Iterator<DocumentModel>, DocumentModelIterator

public class DocumentModelIteratorImpl
extends Object
implements DocumentModelIterator

Iterator implementation. Keeps track of the last item retrieved from the underlying iterator.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.nuxeo.ecm.core.api.DocumentModelIterator

UNKNOWN_SIZE

Constructor Summary

DocumentModelIteratorImpl()
Default constructor is needed as this class is being deserialized on the client side.

DocumentModelIteratorImpl(CoreSession coreSession, int chunkSize, DocsQueryProviderDef def, String type, String perm, Filter filter)
This constructor is to be called only from the server side from a CoreSession (AbstractSession).

Method Summary

boolean	hasNext()
Iterator<DocumentModel>	iterator()
DocumentModel	next()
DocumentModel	nextDocument()
void	remove()
long	size() This might return a real elements count if the implementation allow this.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentModelIteratorImpl

public DocumentModelIteratorImpl()

Default constructor is needed as this class is being deserialized on the client side.

DocumentModelIteratorImpl

public DocumentModelIteratorImpl(CoreSession coreSession,
                                 int chunkSize,
                                 DocsQueryProviderDef def,
                                 String type,
                                 String perm,
                                 Filter filter)
                          throws ClientException

This constructor is to be called only from the server side from a CoreSession (AbstractSession).

Throws:

ClientException

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<DocumentModel>

next

public DocumentModel next()

Specified by:

next in interface Iterator<DocumentModel>

nextDocument

public DocumentModel nextDocument()
                           throws ClientException

Throws:

ClientException

remove

public void remove()

Specified by:

remove in interface Iterator<DocumentModel>

iterator

public Iterator<DocumentModel> iterator()

Specified by:

iterator in interface Iterable<DocumentModel>

size

public long size()

Description copied from interface: DocumentModelIterator

This might return a real elements count if the implementation allow this.

Specified by:

size in interface DocumentModelIterator

Returns:

the number of elements or -1 (by convention) if it is unknown