KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > geronimo > mavenplugins > geronimo > reporting > Reportable


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
20 package org.apache.geronimo.mavenplugins.geronimo.reporting;
21
22 import java.io.File JavaDoc;
23 import java.util.Date JavaDoc;
24
25 /**
26  * Provides the details of the report to a {@link Reporter}.
27  *
28  * @version $Rev: 476061 $ $Date: 2006-11-17 01:36:50 -0500 (Fri, 17 Nov 2006) $
29  */

30 public interface Reportable
31 {
32     /**
33      * Returns the date at which the goal was started.
34      *
35      * @return The date when the goal was started.
36      */

37     Date JavaDoc getStartTime();
38
39     /**
40      * Returns the name of the goal.
41      *
42      * @return Goal name.
43      */

44     String JavaDoc getName();
45
46     /**
47      * Returns the log file which the goal may or may not output logs to.
48      *
49      * @return The log file; or null of the goal does not log to a file.
50      */

51     File JavaDoc getLogFile();
52 }
53
Popular Tags