lucene-java-3.5.0/lucene/src/java/org/apache/lucene/index/FormatPostingsDocsConsumer.java

   1 package org.apache.lucene.index;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import java.io.IOException;
  21
  22 /**
  23  * @lucene.experimental
  24  */
  25
  26 abstract class FormatPostingsDocsConsumer {
  27
  28   /** Adds a new doc in this term.  If this returns null
  29    *  then we just skip consuming positions/payloads. */
  30   abstract FormatPostingsPositionsConsumer addDoc(int docID, int termDocFreq) throws IOException;
  31
  32   /** Called when we are done adding docs to this term */
  33   abstract void finish() throws IOException;
  34 }