org.apache.maven.reporting
Interface MavenReport

All Known Subinterfaces:
MavenMultiPageReport

public interface MavenReport

The basis for a Maven report.

Version:
$Id: MavenReport.java 640236 2008-03-23 18:20:22Z bentmann $
Author:
Brett Porter, Emmanuel Venisse

Field Summary
static java.lang.String CATEGORY_PROJECT_INFORMATION
          Deprecated. For removal in Maven 3.0 or when reporting-api is decoupled from the core, as categories are dynamic.
static java.lang.String CATEGORY_PROJECT_REPORTS
          Deprecated. For removal in Maven 3.0 or when reporting-api is decoupled from the core, as categories are dynamic.
static java.lang.String ROLE
           
 
Method Summary
 boolean canGenerateReport()
           
 void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale)
           
 java.lang.String getCategoryName()
           
 java.lang.String getDescription(java.util.Locale locale)
           
 java.lang.String getName(java.util.Locale locale)
           
 java.lang.String getOutputName()
           
 java.io.File getReportOutputDirectory()
           
 boolean isExternalReport()
           
 void setReportOutputDirectory(java.io.File outputDirectory)
           
 

Field Detail

ROLE

static final java.lang.String ROLE

CATEGORY_PROJECT_INFORMATION

static final java.lang.String CATEGORY_PROJECT_INFORMATION
Deprecated. For removal in Maven 3.0 or when reporting-api is decoupled from the core, as categories are dynamic.
See Also:
Constant Field Values

CATEGORY_PROJECT_REPORTS

static final java.lang.String CATEGORY_PROJECT_REPORTS
Deprecated. For removal in Maven 3.0 or when reporting-api is decoupled from the core, as categories are dynamic.
See Also:
Constant Field Values
Method Detail

generate

void generate(org.codehaus.doxia.sink.Sink sink,
              java.util.Locale locale)
              throws MavenReportException
Throws:
MavenReportException

getOutputName

java.lang.String getOutputName()

getName

java.lang.String getName(java.util.Locale locale)

getCategoryName

java.lang.String getCategoryName()

getDescription

java.lang.String getDescription(java.util.Locale locale)

setReportOutputDirectory

void setReportOutputDirectory(java.io.File outputDirectory)

getReportOutputDirectory

java.io.File getReportOutputDirectory()

isExternalReport

boolean isExternalReport()

canGenerateReport

boolean canGenerateReport()


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.