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.model.root;
20
21 import java.nio.file.Path;
22
23 /**
24 * Interface used to locate the root directory for a given project.
25 *
26 * The root locator is usually looked up from the plexus container.
27 * One notable exception is the computation of the early {@code session.rootDirectory}
28 * property which happens very early. The implementation used in this case
29 * will be discovered using the JDK service mechanism.
30 *
31 * The default implementation will look for a {@code .mvn} child directory.
32 *
33 * @see DefaultRootLocator
34 *
35 * @since 3.10.0
36 */
37 public interface RootLocator {
38
39 String UNABLE_TO_FIND_ROOT_PROJECT_MESSAGE = "Unable to find the root directory. Create a .mvn"
40 + " directory in the project root directory to identify it.";
41
42 Path findRoot(Path basedir);
43
44 Path findMandatoryRoot(Path basedir);
45
46 default String getNoRootMessage() {
47 return UNABLE_TO_FIND_ROOT_PROJECT_MESSAGE;
48 }
49 }