View Javadoc

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.maven.project.MavenProject;
23  
24  /**
25   * Summarizes the result of a project build in the reactor.
26   * 
27   * @author Benjamin Bentmann
28   */
29  public abstract class BuildSummary
30  {
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      {
50          if ( project == null )
51          {
52              throw new IllegalArgumentException( "project missing" );
53          }
54          this.project = project;
55          this.time = time;
56      }
57  
58      /**
59       * Gets the project being summarized.
60       * 
61       * @return The project being summarized, never {@code null}.
62       */
63      public MavenProject getProject()
64      {
65          return project;
66      }
67  
68      /**
69       * Gets the build time of the project in milliseconds.
70       * 
71       * @return The build time of the project in milliseconds.
72       */
73      public long getTime()
74      {
75          return time;
76      }
77  
78  }