001package org.apache.maven;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.plugin.MojoFailureException;
023
024/**
025 * Exception which occurs when a normal (i.e. non-aggregator) mojo fails to
026 * execute. In this case, the mojo failed while executing against a particular
027 * project instance, so we can wrap the {@link MojoFailureException} with context
028 * information including projectId that caused the failure.
029 *
030 * @author jdcasey
031 *
032 */
033public class ProjectBuildFailureException
034    extends BuildFailureException
035{
036
037    private final String projectId;
038
039    public ProjectBuildFailureException( String projectId, MojoFailureException cause )
040    {
041        super( "Build for project: " + projectId + " failed during execution of mojo.", cause );
042
043        this.projectId = projectId;
044    }
045
046    public MojoFailureException getMojoFailureException()
047    {
048        return (MojoFailureException) getCause();
049    }
050
051    public String getProjectId()
052    {
053        return projectId;
054    }
055}