View Javadoc
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.project;
20  
21  import java.io.File;
22  import java.util.List;
23  
24  /**
25   * @author Jason van Zyl
26   */
27  public class ProjectBuildingException extends Exception {
28      private final String projectId;
29  
30      private File pomFile;
31  
32      private List<ProjectBuildingResult> results;
33  
34      public ProjectBuildingException(String projectId, String message, Throwable cause) {
35          super(createMessage(message, projectId, null), cause);
36          this.projectId = projectId;
37      }
38  
39      /**
40       * @param projectId
41       * @param message
42       * @param pomFile   pom file location
43       */
44      public ProjectBuildingException(String projectId, String message, File pomFile) {
45          super(createMessage(message, projectId, pomFile));
46          this.projectId = projectId;
47          this.pomFile = pomFile;
48      }
49  
50      /**
51       * @param projectId
52       * @param message
53       * @param pomFile   pom file location
54       * @param cause
55       */
56      protected ProjectBuildingException(String projectId, String message, File pomFile, Throwable cause) {
57          super(createMessage(message, projectId, pomFile), cause);
58          this.projectId = projectId;
59          this.pomFile = pomFile;
60      }
61  
62      public ProjectBuildingException(List<ProjectBuildingResult> results) {
63          super("Some problems were encountered while processing the POMs");
64          this.projectId = "";
65          this.results = results;
66      }
67  
68      public File getPomFile() {
69          return pomFile;
70      }
71  
72      /**
73       * @deprecated use {@link #getPomFile()}
74       */
75      @Deprecated
76      public String getPomLocation() {
77          if (getPomFile() != null) {
78              return getPomFile().getAbsolutePath();
79          } else {
80              return "null";
81          }
82      }
83  
84      public String getProjectId() {
85          return projectId;
86      }
87  
88      public List<ProjectBuildingResult> getResults() {
89          return results;
90      }
91  
92      private static String createMessage(String message, String projectId, File pomFile) {
93          StringBuilder buffer = new StringBuilder(256);
94          buffer.append(message);
95          buffer.append(" for project ").append(projectId);
96          if (pomFile != null) {
97              buffer.append(" at ").append(pomFile.getAbsolutePath());
98          }
99          return buffer.toString();
100     }
101 }