1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
package org.apache.maven.project;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.util.List;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.building.ModelSource;
/**
* Builds in-memory descriptions of projects.
*/
public interface ProjectBuilder
{
/**
* Builds a project descriptor from the specified POM file.
*
* @param projectFile The POM file to build the project from, must not be {@code null}.
* @param request The project building request that holds further parameters, must not be {@code null}.
* @return The result of the project building, never {@code null}.
* @throws ProjectBuildingException If the project descriptor could not be successfully built.
*/
ProjectBuildingResult build( File projectFile, ProjectBuildingRequest request )
throws ProjectBuildingException;
/**
* Builds a project descriptor for the specified artifact.
*
* @param projectArtifact The POM artifact to build the project from, must not be {@code null}.
* @param request The project building request that holds further parameters, must not be {@code null}.
* @return The result of the project building, never {@code null}.
* @throws ProjectBuildingException If the project descriptor could not be successfully built.
*/
ProjectBuildingResult build( Artifact projectArtifact, ProjectBuildingRequest request )
throws ProjectBuildingException;
/**
* Builds a project descriptor for the specified artifact.
*
* @param projectArtifact The POM artifact to build the project from, must not be {@code null}.
* @param allowStubModel A flag controlling the case of a missing POM artifact. If {@code true} and the specified
* POM artifact does not exist, a simple stub model will be returned. If {@code false}, an exception will
* be thrown.
* @param request The project building request that holds further parameters, must not be {@code null}.
* @return The result of the project building, never {@code null}.
* @throws ProjectBuildingException If the project descriptor could not be successfully built.
*/
ProjectBuildingResult build( Artifact projectArtifact, boolean allowStubModel, ProjectBuildingRequest request )
throws ProjectBuildingException;
/**
* Builds a project descriptor for the specified model source.
*
* @param modelSource The source of the model to built the project descriptor from, must not be {@code null}.
* @param request The project building request that holds further parameters, must not be {@code null}.
* @return The result of the project building, never {@code null}.
* @throws ProjectBuildingException If the project descriptor could not be successfully built.
*
* @see org.apache.maven.model.building.ModelSource2
*/
ProjectBuildingResult build( ModelSource modelSource, ProjectBuildingRequest request )
throws ProjectBuildingException;
/**
* Builds the projects for the specified POM files and optionally their children.
*
* @param pomFiles The POM files to build, must not be {@code null}.
* @param recursive {@code true} to recursively build sub modules referenced by the POM files, {@code false} to
* build only the specified POM files.
* @param request The project builder configuration that provides further parameters, must not be {@code null}.
* @return The results of the project builder where each result corresponds to one project that was built, never
* {@code null}.
* @throws ProjectBuildingException If an error was encountered during building of any project.
* {@link ProjectBuildingException#getResults()} provides access to the details of the problems.
*/
List<ProjectBuildingResult> build( List<File> pomFiles, boolean recursive, ProjectBuildingRequest request )
throws ProjectBuildingException;
}
|
