001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *  http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package org.apache.geronimo.mavenplugins.geronimo.reporting;
021    
022    import java.io.File;
023    import java.util.Date;
024    
025    /**
026     * Provides the details of the report to a {@link Reporter}.
027     *
028     * @version $Rev: 450613 $ $Date: 2006-09-27 15:45:46 -0700 (Wed, 27 Sep 2006) $
029     */
030    public interface Reportable
031    {
032        /**
033         * Returns the date at which the goal was started.
034         *
035         * @return  The date when the goal was started.
036         */
037        Date getStartTime();
038    
039        /**
040         * Returns the name of the goal.
041         *
042         * @return  Goal name.
043         */
044        String getName();
045    
046        /**
047         * Returns the log file which the goal may or may not output logs to.
048         *
049         * @return  The log file; or null of the goal does not log to a file.
050         */
051        File getLogFile();
052    }