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