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.commons.lang3.Validate;
023import org.apache.maven.project.MavenProject;
024
025/**
026 * Summarizes the result of a project build in the reactor.
027 *
028 * @author Benjamin Bentmann
029 */
030public abstract class BuildSummary
031{
032
033    /**
034     * The project being summarized.
035     */
036    private final MavenProject project;
037
038    /**
039     * The build time of the project in milliseconds.
040     */
041    private final long time;
042
043    /**
044     * Creates a new build summary for the specified project.
045     *
046     * @param project The project being summarized, must not be {@code null}.
047     * @param time The build time of the project in milliseconds.
048     */
049    protected BuildSummary( MavenProject project, long time )
050    {
051        this.project = Validate.notNull( project, "project cannot be null" );
052        // TODO Validate for < 0?
053        this.time = time;
054    }
055
056    /**
057     * Gets the project being summarized.
058     *
059     * @return The project being summarized, never {@code null}.
060     */
061    public MavenProject getProject()
062    {
063        return project;
064    }
065
066    /**
067     * Gets the build time of the project in milliseconds.
068     *
069     * @return The build time of the project in milliseconds.
070     */
071    public long getTime()
072    {
073        return time;
074    }
075
076}