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 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 * @author Benjamin Bentmann
30 */
31 public abstract class BuildSummary
32 {
33
34 /**
35 * The project being summarized.
36 */
37 private final MavenProject project;
38
39 /**
40 * The build time of the project in milliseconds.
41 */
42 private final long time;
43
44 /**
45 * Creates a new build summary for the specified project.
46 *
47 * @param project The project being summarized, must not be {@code null}.
48 * @param time The build time of the project in milliseconds.
49 */
50 protected BuildSummary( MavenProject project, long time )
51 {
52 this.project = Objects.requireNonNull( project, "project cannot be null" );
53 // TODO Validate for < 0?
54 this.time = time;
55 }
56
57 /**
58 * Gets the project being summarized.
59 *
60 * @return The project being summarized, never {@code null}.
61 */
62 public MavenProject getProject()
63 {
64 return project;
65 }
66
67 /**
68 * Gets the build time of the project in milliseconds.
69 *
70 * @return The build time of the project in milliseconds.
71 */
72 public long getTime()
73 {
74 return time;
75 }
76
77 }