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 import org.apache.maven.api.Artifact;
23 import org.apache.maven.api.ArtifactCoordinate;
24 import org.apache.maven.api.Service;
25 import org.apache.maven.api.Session;
26 import org.apache.maven.api.annotations.Experimental;
27 import org.apache.maven.api.annotations.Nonnull;
28
29 /**
30 * @since 4.0
31 */
32 @Experimental
33 public interface ProjectBuilder extends Service {
34
35 /**
36 * Creates a {@link org.apache.maven.api.Project} from a POM file.
37 *
38 * @param request {@link ProjectBuilderRequest}
39 * @return the {@link ProjectBuilderResult} containing the built project and possible errors
40 * @throws ProjectBuilderException if the project cannot be created
41 * @throws IllegalArgumentException if an argument is {@code null} or invalid
42 */
43 @Nonnull
44 ProjectBuilderResult build(ProjectBuilderRequest request);
45
46 /**
47 * Creates a {@link org.apache.maven.api.Project} from a POM file.
48 *
49 * @param session the {@link Session}, must not be {@code null}
50 * @param source The {@link Source}, must not be {@code null}
51 * @throws ProjectBuilderException if the project cannot be created
52 * @throws IllegalArgumentException if an argument is {@code null} or invalid
53 * @see #build(ProjectBuilderRequest)
54 */
55 @Nonnull
56 default ProjectBuilderResult build(@Nonnull Session session, @Nonnull Source source) {
57 return build(ProjectBuilderRequest.build(session, source));
58 }
59
60 /**
61 * Creates a {@link org.apache.maven.api.Project} from a POM file.
62 *
63 * @param session the {@link Session}, must not be {@code null}
64 * @param path the {@link Path}, must not be {@code null}
65 * @throws ProjectBuilderException if the project cannot be created
66 * @throws IllegalArgumentException if an argument is {@code null} or invalid
67 * @see #build(ProjectBuilderRequest)
68 */
69 @Nonnull
70 default ProjectBuilderResult build(@Nonnull Session session, @Nonnull Path path) {
71 return build(ProjectBuilderRequest.build(session, path));
72 }
73
74 /**
75 * Creates a {@link org.apache.maven.api.Project} from an artifact.
76 *
77 * @param session the {@link Session}, must not be {@code null}
78 * @param artifact the {@link Artifact}, must not be {@code null}
79 * @throws ProjectBuilderException if the project cannot be created
80 * @throws IllegalArgumentException if an argument is {@code null} or invalid
81 * @see #build(ProjectBuilderRequest)
82 */
83 @Nonnull
84 default ProjectBuilderResult build(@Nonnull Session session, @Nonnull Artifact artifact) {
85 return build(ProjectBuilderRequest.build(session, artifact));
86 }
87
88 /**
89 * Creates a {@link org.apache.maven.api.Project} from a coordinate.
90 *
91 * @param session the {@link Session}, must not be {@code null}
92 * @param coordinate the {@link ArtifactCoordinate}, must not be {@code null}
93 * @throws ProjectBuilderException if the project cannot be created
94 * @throws IllegalArgumentException if an argument is {@code null} or invalid
95 * @see #build(ProjectBuilderRequest)
96 */
97 @Nonnull
98 default ProjectBuilderResult build(@Nonnull Session session, @Nonnull ArtifactCoordinate coordinate) {
99 return build(ProjectBuilderRequest.build(session, coordinate));
100 }
101 }