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;
20
21 import java.nio.file.Path;
22 import java.util.List;
23 import java.util.Optional;
24 import org.apache.maven.api.annotations.Experimental;
25 import org.apache.maven.api.annotations.Nonnull;
26 import org.apache.maven.api.model.Build;
27 import org.apache.maven.api.model.Model;
28
29 /**
30 * Interface representing a Maven project.
31 * Projects can be built using the {@link org.apache.maven.api.services.ProjectBuilder} service.
32 *
33 * @since 4.0
34 */
35 @Experimental
36 public interface Project {
37
38 @Nonnull
39 String getGroupId();
40
41 @Nonnull
42 String getArtifactId();
43
44 @Nonnull
45 String getVersion();
46
47 @Nonnull
48 String getPackaging();
49
50 @Nonnull
51 Artifact getArtifact();
52
53 @Nonnull
54 Model getModel();
55
56 @Nonnull
57 default Build getBuild() {
58 Build build = getModel().getBuild();
59 return build != null ? build : Build.newInstance();
60 }
61
62 /**
63 * Returns the path to the pom file for this project.
64 * A project is usually read from the file system and this will point to
65 * the file. In some cases, a transient project can be created which
66 * will not point to an actual pom file.
67 * @return the path of the pom
68 */
69 @Nonnull
70 Optional<Path> getPomPath();
71
72 @Nonnull
73 default Optional<Path> getBasedir() {
74 return getPomPath().map(Path::getParent);
75 }
76
77 @Nonnull
78 List<DependencyCoordinate> getDependencies();
79
80 @Nonnull
81 List<DependencyCoordinate> getManagedDependencies();
82
83 @Nonnull
84 default String getId() {
85 return getModel().getId();
86 }
87
88 boolean isExecutionRoot();
89
90 @Nonnull
91 Optional<Project> getParent();
92
93 @Nonnull
94 List<RemoteRepository> getRemoteProjectRepositories();
95
96 @Nonnull
97 List<RemoteRepository> getRemotePluginRepositories();
98 }