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.Service;
24 import org.apache.maven.api.Session;
25 import org.apache.maven.api.annotations.Experimental;
26 import org.apache.maven.api.annotations.Nonnull;
27
28 /**
29 * @since 4.0.0
30 */
31 @Experimental
32 public interface ProjectBuilder extends Service {
33
34 /**
35 * Creates a {@link org.apache.maven.api.Project} from a POM file.
36 *
37 * @param request {@link ProjectBuilderRequest}
38 * @return the {@link ProjectBuilderResult} containing the built project and possible errors
39 * @throws ProjectBuilderException if the project cannot be created
40 * @throws IllegalArgumentException if an argument is {@code null} or invalid
41 */
42 @Nonnull
43 ProjectBuilderResult build(ProjectBuilderRequest request);
44
45 /**
46 * Creates a {@link org.apache.maven.api.Project} from a POM file.
47 *
48 * @param session the {@link Session}, must not be {@code null}
49 * @param source The {@link Source}, must not be {@code null}
50 * @throws ProjectBuilderException if the project cannot be created
51 * @throws IllegalArgumentException if an argument is {@code null} or invalid
52 * @see #build(ProjectBuilderRequest)
53 */
54 @Nonnull
55 default ProjectBuilderResult build(@Nonnull Session session, @Nonnull Source source) {
56 return build(ProjectBuilderRequest.build(session, source));
57 }
58
59 /**
60 * Creates a {@link org.apache.maven.api.Project} from a POM file.
61 *
62 * @param session the {@link Session}, must not be {@code null}
63 * @param path the {@link Path}, must not be {@code null}
64 * @throws ProjectBuilderException if the project cannot be created
65 * @throws IllegalArgumentException if an argument is {@code null} or invalid
66 * @see #build(ProjectBuilderRequest)
67 */
68 @Nonnull
69 default ProjectBuilderResult build(@Nonnull Session session, @Nonnull Path path) {
70 return build(ProjectBuilderRequest.build(session, path));
71 }
72 }