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