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