-
Notifications
You must be signed in to change notification settings - Fork 624
/
LiveDocsFormat.cs
68 lines (60 loc) · 2.72 KB
/
LiveDocsFormat.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
using System.Collections.Generic;
using System.Runtime.CompilerServices;
namespace Lucene.Net.Codecs
{
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
using IBits = Lucene.Net.Util.IBits;
using Directory = Lucene.Net.Store.Directory;
using IOContext = Lucene.Net.Store.IOContext;
using IMutableBits = Lucene.Net.Util.IMutableBits;
using SegmentCommitInfo = Lucene.Net.Index.SegmentCommitInfo;
/// <summary>
/// Format for live/deleted documents.
/// <para/>
/// @lucene.experimental
/// </summary>
public abstract class LiveDocsFormat
{
/// <summary>
/// Sole constructor. (For invocation by subclass
/// constructors, typically implicit.)
/// </summary>
protected internal LiveDocsFormat()
{
}
/// <summary>
/// Creates a new MutableBits, with all bits set, for the specified size. </summary>
public abstract IMutableBits NewLiveDocs(int size);
/// <summary>
/// Creates a new mutablebits of the same bits set and size of existing. </summary>
public abstract IMutableBits NewLiveDocs(IBits existing);
/// <summary>
/// Read live docs bits. </summary>
public abstract IBits ReadLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context);
/// <summary>
/// Persist live docs bits. Use
/// <see cref="SegmentCommitInfo.NextDelGen"/> to determine the
/// generation of the deletes file you should write to.
/// </summary>
[MethodImpl(MethodImplOptions.NoInlining)]
public abstract void WriteLiveDocs(IMutableBits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context);
/// <summary>
/// Records all files in use by this <see cref="SegmentCommitInfo"/> into the files argument. </summary>
public abstract void Files(SegmentCommitInfo info, ICollection<string> files);
}
}