KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > maven > reporting > MavenReport


1 package org.apache.maven.reporting;
2
3 /*
4  * Copyright 2005 The Apache Software Foundation.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * 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, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 import org.codehaus.doxia.sink.Sink;
20
21 import java.io.File JavaDoc;
22 import java.util.Locale JavaDoc;
23
24 /**
25  * The basis for a Maven report.
26  *
27  * @author Brett Porter
28  * @author <a HREF="evenisse@apache.org">Emmanuel Venisse</a>
29  * @version $Id: MavenReport.java 163376 2005-02-23 00:06:06Z brett $
30  */
31 public interface MavenReport
32 {
33     String JavaDoc ROLE = MavenReport.class.getName();
34
35     String JavaDoc CATEGORY_PROJECT_INFORMATION = "Project Info";
36
37     String JavaDoc CATEGORY_PROJECT_REPORTS = "Project Reports";
38
39     // eventually, we must replace this with the o.a.m.d.s.Sink class as a parameter
40 void generate( Sink sink, Locale JavaDoc locale )
41         throws MavenReportException;
42
43     String JavaDoc getOutputName();
44
45     String JavaDoc getName( Locale JavaDoc locale );
46
47     String JavaDoc getCategoryName();
48
49     String JavaDoc getDescription( Locale JavaDoc locale );
50
51     // TODO: remove?
52 void setReportOutputDirectory( File JavaDoc outputDirectory );
53
54     File JavaDoc getReportOutputDirectory();
55
56     boolean isExternalReport();
57
58     boolean canGenerateReport();
59 }
60
Popular Tags