blob: 9a43154c0ca091b39b6ef7ebcf6a68bbe0e2583d (
plain)
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
|
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.model.building.ModelProblem;
/**
* Collects the output of the project builder.
*
* @author Benjamin Bentmann
*/
public interface ProjectBuildingResult
{
/**
* Gets the identifier of the project that could not be built. The general format of the identifier is {@code
* <groupId>:<artifactId>:<version>} but some of these coordinates may still be unknown at the point the exception
* is thrown so this information is merely meant to assist the user.
*
* @return The identifier of the project or an empty string if not known, never {@code null}.
*/
String getProjectId();
/**
* Gets the POM file from which the project was built.
*
* @return The POM file or {@code null} if unknown.
*/
File getPomFile();
/**
* Gets the project that was built.
*
* @return The project that was built or {@code null} if an error occurred and this result accompanies a
* {@link ProjectBuildingException}.
*/
MavenProject getProject();
/**
* Gets the problems that were encountered during the project building.
*
* @return The problems that were encountered during the project building, can be empty but never {@code null}.
*/
List<ModelProblem> getProblems();
/**
* Gets the result of the dependency resolution for the project.
*
* @return The result of the dependency resolution for the project or {@code null} if the project dependencies were
* not requested.
*/
DependencyResolutionResult getDependencyResolutionResult();
}
|
