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 import java.util.Objects;
23
24 import org.apache.maven.project.MavenProject;
25
26 /**
27 * Summarizes the result of a project build in the reactor.
28 *
29 */
30 public abstract class BuildSummary {
31
32 /**
33 * The project being summarized.
34 */
35 private final MavenProject project;
36
37 /**
38 * The build time of the project in milliseconds.
39 */
40 private final Duration wallTime;
41
42 /**
43 * The total amount of time spent for to run mojos in milliseconds.
44 */
45 private final Duration execTime;
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 */
53 protected BuildSummary(MavenProject project, long time) {
54 this(project, Duration.ofMillis(time), Duration.ofMillis(time));
55 }
56
57 /**
58 * Creates a new build summary for the specified project.
59 *
60 * @param project The project being summarized, must not be {@code null}.
61 * @param execTime The exec time of the project in milliseconds.
62 * @param wallTime The wall time of the project in milliseconds.
63 */
64 protected BuildSummary(MavenProject project, Duration execTime, Duration wallTime) {
65 this.project = Objects.requireNonNull(project, "project cannot be null");
66 // TODO Validate for < 0?
67 this.execTime = execTime;
68 this.wallTime = wallTime;
69 }
70
71 /**
72 * Gets the project being summarized.
73 *
74 * @return The project being summarized, never {@code null}.
75 */
76 public MavenProject getProject() {
77 return project;
78 }
79
80 /**
81 * Gets the wall time of the project in milliseconds.
82 *
83 * @return The wall time of the project in milliseconds.
84 */
85 public long getTime() {
86 return execTime.toMillis();
87 }
88
89 /**
90 * Gets the wall time of the project.
91 *
92 * @return The wall time of the project.
93 */
94 public Duration getWallTime() {
95 return wallTime;
96 }
97
98 /**
99 * Gets the exec time of the project.
100 *
101 * @return The exec time of the project.
102 */
103 public Duration getExecTime() {
104 return execTime;
105 }
106 }