001/*
002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the Eclipse Public License v1.0
006 * which accompanies this distribution, and is available at
007 * http://www.eclipse.org/legal/epl-v10.html
008 *
009 * Contributors:
010 *     Nuxeo - initial API and implementation
011 *
012 * $Id$
013 */
014
015package org.nuxeo.ecm.core.api;
016
017import java.util.Iterator;
018
019/**
020 * A serializable iterator of document models. Long result sets are loaded frame by frame transparently by the
021 * DocumentModelIterator.
022 *
023 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
024 * @author <a href="mailto:dm@nuxeo.com">Dragos Mihalache</a>
025 */
026public interface DocumentModelIterator extends Iterator<DocumentModel>, Iterable<DocumentModel> {
027
028    int UNKNOWN_SIZE = -1;
029
030    /**
031     * This might return a real elements count if the implementation allow this.
032     *
033     * @return the number of elements or -1 (by convention) if it is unknown
034     */
035    long size();
036
037}