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