Package org.nuxeo.ecm.core.io

Interface DocumentReader

All Known Implementing Classes:
AbstractDocumentReader, DocumentModelReader, DocumentsListReader, DocumentTreeReader, ExtensibleDocumentTreeReader, NuxeoArchiveReader, SingleDocumentReader, TypedSingleDocumentReader, XMLDirectoryReader, XMLZipReader, ZipReader
public interface DocumentReader
A document reader. This reader is designed to be accessed remotely (over a network).
Author:
Bogdan Stefanescu

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closes the reader.
    ExportedDocument
    read()
    Reads a single document.
    ExportedDocument[]
    read(int count)
    Reads next 'count' documents.

  • Method Details

    • read

      ExportedDocument read() throws IOException
      Reads a single document.
      Returns:
      the document read or null if there are no more documents to read
      Throws:
      IOException

    • read

      ExportedDocument[] read(int count) throws IOException
      Reads next 'count' documents.
      Parameters:
      count - the number of documents to read
      Returns:
      the array of read documents or null if there are no more documents to read
      Throws:
      IOException

    • close

      void close()
      Closes the reader.