Merge pull request #409 from Alkarex/patch-1
[mono.git] / mcs / tools / monkeydoc / Lucene.Net / Lucene.Net / Index / FormatPostingsFieldsConsumer.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>Abstract API that consumes terms, doc, freq, prox and
24         /// payloads postings.  Concrete implementations of this
25         /// actually do "something" with the postings (write it into
26         /// the index in a specific format).
27         /// 
28         /// NOTE: this API is experimental and will likely change
29         /// </summary>
30         abstract class FormatPostingsFieldsConsumer
31         {
32                 
33                 /// <summary>Add a new field </summary>
34                 internal abstract FormatPostingsTermsConsumer AddField(FieldInfo field);
35                 
36                 /// <summary>Called when we are done adding everything. </summary>
37                 internal abstract void  Finish();
38         }
39 }