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