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.api.services.model;
20
21 import java.nio.file.Path;
22
23 import org.apache.maven.api.Service;
24 import org.apache.maven.api.annotations.Nonnull;
25 import org.apache.maven.api.annotations.Nullable;
26
27 /**
28 * Interface used to locate the root directory for a given project.
29 *
30 * The root locator is usually looked up from the DI container.
31 * One notable exception is the computation of the early {@code session.rootDirectory}
32 * property which happens very early. The implementation used in this case
33 * will be discovered using the JDK service mechanism.
34 *
35 * The default implementation will look for a {@code .mvn} child directory
36 * or a {@code pom.xml} containing the {@code root="true"} attribute.
37 */
38 public interface RootLocator extends Service {
39
40 String UNABLE_TO_FIND_ROOT_PROJECT_MESSAGE = "Unable to find the root directory. "
41 + "Create a .mvn directory in the root directory or add the root=\"true\""
42 + " attribute on the root project's model to identify it.";
43
44 @Nullable
45 Path findRoot(@Nonnull Path basedir);
46
47 @Nonnull
48 Path findMandatoryRoot(@Nonnull Path basedir);
49
50 @Nonnull
51 default String getNoRootMessage() {
52 return UNABLE_TO_FIND_ROOT_PROJECT_MESSAGE;
53 }
54 }