/*
* (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Contributors:
* Nuxeo - initial API and implementation
*
* $Id$
*/
package org.nuxeo.ecm.core.api;
import java.util.Iterator;
/**
* A serializable iterator of document models. Long result sets are loaded frame by frame transparently by the
* DocumentModelIterator.
*
* @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
* @author <a href="mailto:dm@nuxeo.com">Dragos Mihalache</a>
*/
public interface DocumentModelIterator extends Iterator<DocumentModel>, Iterable<DocumentModel> {
int UNKNOWN_SIZE = -1;
/**
* This might return a real elements count if the implementation allow this.
*
* @return the number of elements or -1 (by convention) if it is unknown
*/
long size();
}