001package org.apache.maven.execution;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.project.MavenProject;
023
024/**
025 * Summarizes the result of a project build in the reactor.
026 * 
027 * @author Benjamin Bentmann
028 */
029public abstract class BuildSummary
030{
031
032    /**
033     * The project being summarized.
034     */
035    private final MavenProject project;
036
037    /**
038     * The build time of the project in milliseconds.
039     */
040    private final long time;
041
042    /**
043     * Creates a new build summary for the specified project.
044     * 
045     * @param project The project being summarized, must not be {@code null}.
046     * @param time The build time of the project in milliseconds.
047     */
048    protected BuildSummary( MavenProject project, long time )
049    {
050        if ( project == null )
051        {
052            throw new IllegalArgumentException( "project missing" );
053        }
054        this.project = project;
055        this.time = time;
056    }
057
058    /**
059     * Gets the project being summarized.
060     * 
061     * @return The project being summarized, never {@code null}.
062     */
063    public MavenProject getProject()
064    {
065        return project;
066    }
067
068    /**
069     * Gets the build time of the project in milliseconds.
070     * 
071     * @return The build time of the project in milliseconds.
072     */
073    public long getTime()
074    {
075        return time;
076    }
077
078}