View Javadoc

1   package org.apache.maven;
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 org.apache.maven.plugin.MojoFailureException;
23  
24  /**
25   * Exception which occurs when a normal (i.e. non-aggregator) mojo fails to
26   * execute. In this case, the mojo failed while executing against a particular
27   * project instance, so we can wrap the {@link MojoFailureException} with context
28   * information including projectId that caused the failure.
29   *
30   * @author jdcasey
31   *
32   */
33  public class ProjectBuildFailureException
34      extends BuildFailureException
35  {
36  
37      private final String projectId;
38  
39      public ProjectBuildFailureException( String projectId, MojoFailureException cause )
40      {
41          super( "Build for project: " + projectId + " failed during execution of mojo.", cause );
42  
43          this.projectId = projectId;
44      }
45  
46      public MojoFailureException getMojoFailureException()
47      {
48          return (MojoFailureException) getCause();
49      }
50  
51      public String getProjectId()
52      {
53          return projectId;
54      }
55  }