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;
20
21 import java.nio.file.Path;
22
23 import org.apache.maven.api.annotations.Nonnull;
24 import org.apache.maven.api.annotations.Nullable;
25
26 import static org.apache.maven.api.services.BaseRequest.nonNull;
27
28 /**
29 * A Source specific to load POMs. The {@link #resolve(ModelLocator, String)} method
30 * will be used to find POMs for children modules.
31 *
32 * @since 4.0.0
33 */
34 public interface ModelSource extends Source {
35
36 interface ModelLocator {
37 /**
38 * Returns the file containing the pom or null if a pom can not be
39 * found at the given file or in the given directory.
40 *
41 * @since 4.0.0
42 */
43 @Nullable
44 Path locateExistingPom(@Nonnull Path project);
45 }
46
47 @Nullable
48 ModelSource resolve(@Nonnull ModelLocator modelLocator, @Nonnull String relative);
49
50 @Nonnull
51 static ModelSource fromPath(@Nonnull Path path) {
52 return fromPath(path, null);
53 }
54
55 @Nonnull
56 static ModelSource fromPath(@Nonnull Path path, @Nullable String location) {
57 return new PathSource(nonNull(path, "path cannot be null"), location);
58 }
59 }