org.nuxeo.ecm.core.io.impl.plugins

Class DocumentsListReader

java.lang.Object

org.nuxeo.ecm.core.io.impl.AbstractDocumentReader

org.nuxeo.ecm.core.io.impl.plugins.DocumentModelReader

org.nuxeo.ecm.core.io.impl.plugins.DocumentsListReader

All Implemented Interfaces:

DocumentReader

public class DocumentsListReader
extends DocumentModelReader

Reader for a simple list of DocumentModel objects.

Author:

DM

Field Summary

Fields inherited from class org.nuxeo.ecm.core.io.impl.plugins.DocumentModelReader

inlineBlobs, session

Constructor Summary

Constructors

Constructor and Description
DocumentsListReader(CoreSession session, List<DocumentModel> docsList)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader.
static DocumentsListReader	createDocumentsListReader(CoreSession session, Collection<DocumentRef> docRefsList)
ExportedDocument	read() Reads a single document.

Methods inherited from class org.nuxeo.ecm.core.io.impl.plugins.DocumentModelReader

getInlineBlobs, setInlineBlobs

Methods inherited from class org.nuxeo.ecm.core.io.impl.AbstractDocumentReader

read

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentsListReader

public DocumentsListReader(CoreSession session,
                           List<DocumentModel> docsList)

Method Detail

createDocumentsListReader

public static DocumentsListReader createDocumentsListReader(CoreSession session,
                                                            Collection<DocumentRef> docRefsList)

close

public void close()

Description copied from interface: DocumentReader

Closes the reader.

Specified by:

close in interface DocumentReader

Overrides:

close in class DocumentModelReader

read

public ExportedDocument read()
                      throws IOException

Description copied from interface: DocumentReader

Reads a single document.

Specified by:

read in interface DocumentReader

Specified by:

read in class DocumentModelReader

Returns:

the document read or null if there are no more documents to read

Throws:

IOException