001package org.apache.maven.execution;
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.project.MavenProject;
023
024/**
025 * Summarizes the result of a failed project build in the reactor.
026 *
027 * @author Benjamin Bentmann
028 */
029public class BuildFailure
030    extends BuildSummary
031{
032
033    /**
034     * The cause of the build failure.
035     */
036    private final Throwable cause;
037
038    /**
039     * Creates a new build summary for the specified project.
040     *
041     * @param project The project being summarized, must not be {@code null}.
042     * @param time The build time of the project in milliseconds.
043     * @param cause The cause of the build failure, may be {@code null}.
044     */
045    public BuildFailure( MavenProject project, long time, Throwable cause )
046    {
047        super( project, time );
048        this.cause = cause;
049    }
050
051    /**
052     * Gets the cause of the build failure.
053     *
054     * @return The cause of the build failure or {@code null} if unknown.
055     */
056    public Throwable getCause()
057    {
058        return cause;
059    }
060
061}