1 package org.apache.maven.index.updater;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23 import java.io.IOException;
24
25 import org.apache.lucene.store.FSDirectory;
26
27 /**
28 * FSDirectoryFactory allows host application choose specific FSDirectory implementation used during index update. This
29 * is useful in some environments where default Lucene heuristics results in suboptimal choice of FSDirectory. For
30 * example, MMapDirectory used by default on 64 bit Linux JDK results in heavy operating system swap with certain Linux
31 * configuration and host application can choose NIOFSDirectory to avoid the problem.
32 */
33 public interface FSDirectoryFactory
34 {
35 /**
36 * Default implementation that lets Lucene choose FSDirectory implementation.
37 */
38 FSDirectoryFactory DEFAULT = new FSDirectoryFactory()
39 {
40 public FSDirectory open( File indexDir )
41 throws IOException
42 {
43 return FSDirectory.open( indexDir.toPath() );
44 }
45 };
46
47 FSDirectory open( File indexDir )
48 throws IOException;
49 }