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
23 /**
24 * Locates a POM file within a project base directory.
25 *
26 * @author Benjamin Bentmann
27 */
28 public interface ModelLocator {
29
30 /**
31 * Locates the POM file within the specified project directory. In case the given project directory does not exist
32 * or does not contain a POM file, the return value indicates the expected path to the POM file. Subdirectories of
33 * the project directory will not be considered when locating the POM file. The return value will be an absolute
34 * path if the project directory is given as an absolute path.
35 *
36 * @param projectDirectory The (possibly non-existent) base directory to locate the POM file in, must not be {@code
37 * null}.
38 * @return The path to the (possibly non-existent) POM file, never {@code null}.
39 */
40 File locatePom(File projectDirectory);
41 }