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