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.locator;
20
21 import java.io.File;
22 import java.nio.file.Path;
23
24 /**
25 * Locates a POM file within a project base directory.
26 *
27 * @deprecated use {@link org.apache.maven.api.services.ModelBuilder} instead
28 */
29 @Deprecated(since = "4.0.0")
30 public interface ModelLocator {
31
32 /**
33 * Locates the POM file within the specified project directory. In case the given project directory does not exist
34 * or does not contain a POM file, the return value indicates the expected path to the POM file. Subdirectories of
35 * the project directory will not be considered when locating the POM file. The return value will be an absolute
36 * path if the project directory is given as an absolute path.
37 *
38 * @param projectDirectory The (possibly non-existent) base directory to locate the POM file in, must not be {@code
39 * null}.
40 * @return The path to the (possibly non-existent) POM file, never {@code null}.
41 * @deprecated Use {@link #locatePom(Path)} instead.
42 */
43 @Deprecated
44 File locatePom(File projectDirectory);
45
46 /**
47 * Locates the POM file within the specified project directory. In case the given project directory does not exist
48 * or does not contain a POM file, the return value indicates the expected path to the POM file. Subdirectories of
49 * the project directory will not be considered when locating the POM file. The return value will be an absolute
50 * path if the project directory is given as an absolute path.
51 *
52 * @param projectDirectory The (possibly non-existent) base directory to locate the POM file in, must not be {@code
53 * null}.
54 * @return The path to the (possibly non-existent) POM file, never {@code null}.
55 * @since 4.0.0
56 */
57 Path locatePom(Path projectDirectory);
58
59 /**
60 * Returns the file containing the pom or null if a pom can not be found at the given file or in the given directory.
61 *
62 * @deprecated Use {@link #locateExistingPom(Path)} instead.
63 */
64 @Deprecated
65 default File locateExistingPom(File project) {
66 Path path = locateExistingPom(project != null ? project.toPath() : null);
67 return path != null ? path.toFile() : null;
68 }
69
70 /**
71 * Returns the file containing the pom or null if a pom can not be found at the given file or in the given directory.
72 *
73 * @since 4.0.0
74 */
75 Path locateExistingPom(Path project);
76 }