org.apache.maven.model
Class ReportSet

java.lang.Object
  extended by org.apache.maven.model.ReportSet
All Implemented Interfaces:
java.io.Serializable

public class ReportSet
extends java.lang.Object
implements java.io.Serializable

Represents a set of reports and configuration to be used to generate them.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
ReportSet()
           
 
Method Summary
 void addReport(java.lang.String string)
          Method addReport.
 java.lang.Object getConfiguration()
          Get configuration of the report to be used when generating this set.
 java.lang.String getId()
          Get the unique id for this report set, to be used during POM inheritance.
 java.lang.String getInherited()
          Get whether any configuration should be propagated to child POMs.
 java.lang.String getModelEncoding()
           
 java.util.List getReports()
          Method getReports.
 boolean isInheritanceApplied()
           
 void removeReport(java.lang.String string)
          Method removeReport.
 void setConfiguration(java.lang.Object configuration)
          Set configuration of the report to be used when generating this set.
 void setId(java.lang.String id)
          Set the unique id for this report set, to be used during POM inheritance.
 void setInherited(java.lang.String inherited)
          Set whether any configuration should be propagated to child POMs.
 void setModelEncoding(java.lang.String modelEncoding)
          Set an encoding used for reading/writing the model.
 void setReports(java.util.List reports)
          Set the list of reports from this plugin which should be generated from this set.
 void unsetInheritanceApplied()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportSet

public ReportSet()
Method Detail

addReport

public void addReport(java.lang.String string)
Method addReport.

Parameters:
string -

getConfiguration

public java.lang.Object getConfiguration()
Get configuration of the report to be used when generating this set.

Returns:
Object

getId

public java.lang.String getId()
Get the unique id for this report set, to be used during POM inheritance.

Returns:
String

getInherited

public java.lang.String getInherited()
Get whether any configuration should be propagated to child POMs.

Returns:
String

getReports

public java.util.List getReports()
Method getReports.

Returns:
java.util.List

removeReport

public void removeReport(java.lang.String string)
Method removeReport.

Parameters:
string -

setConfiguration

public void setConfiguration(java.lang.Object configuration)
Set configuration of the report to be used when generating this set.

Parameters:
configuration -

setId

public void setId(java.lang.String id)
Set the unique id for this report set, to be used during POM inheritance.

Parameters:
id -

setInherited

public void setInherited(java.lang.String inherited)
Set whether any configuration should be propagated to child POMs.

Parameters:
inherited -

setReports

public void setReports(java.util.List reports)
Set the list of reports from this plugin which should be generated from this set.

Parameters:
reports -

unsetInheritanceApplied

public void unsetInheritanceApplied()

isInheritanceApplied

public boolean isInheritanceApplied()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)
Set an encoding used for reading/writing the model.

Parameters:
modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public java.lang.String getModelEncoding()
Returns:
the current encoding used when reading/writing this model.


Copyright © 2001-2009 The Apache Software Foundation. All Rights Reserved.