001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id: DocumentReader.java 29029 2008-01-14 18:38:14Z ldoguin $
020 */
021
022package org.nuxeo.ecm.core.io;
023
024import java.io.IOException;
025
026/**
027 * A document reader. This reader is designed to be accessed remotely (over a network).
028 *
029 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
030 */
031public interface DocumentReader {
032
033    /**
034     * Reads a single document.
035     *
036     * @return the document read or null if there are no more documents to read
037     * @throws IOException
038     */
039    ExportedDocument read() throws IOException;
040
041    /**
042     * Reads next 'count' documents.
043     *
044     * @param count the number of documents to read
045     * @return the array of read documents or null if there are no more documents to read
046     * @throws IOException
047     */
048    ExportedDocument[] read(int count) throws IOException;
049
050    /**
051     * Closes the reader.
052     */
053    void close();
054
055}