DocumentProducer.java

/*
 * Copyright 2007  T-Rank AS
 * 
 * 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.
 */
package no.trank.openpipe.api.document;

/**
 * An interface describing a document-producer.
 *
 * @version $Revision$
 */
public interface DocumentProducer extends Iterable<Document> {

   /**
    * Initializes the document-producer. Must be called before the first call to {@link #iterator()}.
    */
   void init();

   /**
    * Closes this document-producer, releasing any resources held.
    */
   void close();

   /**
    * Close this document-producer, and do any error handling.  
    */
   void fail();
}