mcs/tools/monkeydoc/Lucene.Net/Lucene.Net/Index/FormatPostingsDocsConsumer.cs

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