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