View Javadoc

1   package org.apache.maven.project;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.File;
23  import java.util.List;
24  
25  import org.apache.maven.model.building.ModelProblem;
26  
27  /**
28   * Collects the output of the project builder.
29   * 
30   * @author Benjamin Bentmann
31   */
32  public interface ProjectBuildingResult
33  {
34  
35      /**
36       * Gets the identifier of the project that could not be built. The general format of the identifier is {@code
37       * <groupId>:<artifactId>:<version>} but some of these coordinates may still be unknown at the point the exception
38       * is thrown so this information is merely meant to assist the user.
39       * 
40       * @return The identifier of the project or an empty string if not known, never {@code null}.
41       */
42      String getProjectId();
43  
44      /**
45       * Gets the POM file from which the project was built.
46       * 
47       * @return The POM file or {@code null} if unknown.
48       */
49      File getPomFile();
50  
51      /**
52       * Gets the project that was built.
53       * 
54       * @return The project that was built or {@code null} if an error occurred and this result accompanies a
55       *         {@link ProjectBuildingException}.
56       */
57      MavenProject getProject();
58  
59      /**
60       * Gets the problems that were encountered during the project building.
61       * 
62       * @return The problems that were encountered during the project building, can be empty but never {@code null}.
63       */
64      List<ModelProblem> getProblems();
65  
66      /**
67       * Gets the result of the dependency resolution for the project.
68       * 
69       * @return The result of the dependency resolution for the project or {@code null} if the project dependencies were
70       *         not requested.
71       */
72      DependencyResolutionResult getDependencyResolutionResult();
73  
74  }