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