1 package org.apache.maven.model.locator;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23
24 /**
25 * Locates a POM file within a project base directory.
26 *
27 * @author Benjamin Bentmann
28 */
29 public interface ModelLocator
30 {
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. Sub directories 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 */
42 File locatePom( File projectDirectory );
43
44 }