pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / src / java / org / apache / lucene / index / NoMergeScheduler.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  * A {@link MergeScheduler} which never executes any merges. It is also a
24  * singleton and can be accessed through {@link NoMergeScheduler#INSTANCE}. Use
25  * it if you want to prevent an {@link IndexWriter} from ever executing merges,
26  * irregardless of the {@link MergePolicy} used. Note that you can achieve the
27  * same thing by using {@link NoMergePolicy}, however with
28  * {@link NoMergeScheduler} you also ensure that no unnecessary code of any
29  * {@link MergeScheduler} implementation is ever executed. Hence it is
30  * recommended to use both if you want to disable merges from ever happening.
31  */
32 public final class NoMergeScheduler extends MergeScheduler {
33
34   /** The single instance of {@link NoMergeScheduler} */
35   public static final MergeScheduler INSTANCE = new NoMergeScheduler();
36
37   private NoMergeScheduler() {
38     // prevent instantiation
39   }
40
41   @Override
42   public void close() {}
43
44   @Override
45   public void merge(IndexWriter writer) throws CorruptIndexException, IOException {}
46 }