View Javadoc

1   package org.apache.maven.execution;
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.project.MavenProject;
23  
24  /**
25   * Summarizes the result of a failed project build in the reactor.
26   * 
27   * @author Benjamin Bentmann
28   */
29  public class BuildFailure
30      extends BuildSummary
31  {
32  
33      /**
34       * The cause of the build failure.
35       */
36      private final Throwable cause;
37  
38      /**
39       * Creates a new build summary for the specified project.
40       * 
41       * @param project The project being summarized, must not be {@code null}.
42       * @param time The build time of the project in milliseconds.
43       * @param cause The cause of the build failure, may be {@code null}.
44       */
45      public BuildFailure( MavenProject project, long time, Throwable cause )
46      {
47          super( project, time );
48          this.cause = cause;
49      }
50  
51      /**
52       * Gets the cause of the build failure.
53       * 
54       * @return The cause of the build failure or {@code null} if unknown.
55       */
56      public Throwable getCause()
57      {
58          return cause;
59      }
60  
61  }