org.apache.maven.model
Class ReportSet

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

public class ReportSet
extends Object
implements Serializable, Cloneable, InputLocationTracker

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(String string)
          Method addReport.
 ReportSet clone()
          Method clone.
 Object getConfiguration()
          Get configuration of the report to be used when generating this set.
 String getId()
          Get the unique id for this report set, to be used during POM inheritance and profile injection for merging of report sets.
 String getInherited()
          Get whether any configuration should be propagated to child POMs.
 InputLocation getLocation(Object key)
          Gets the location of the specified field in the input source.
 List<String> getReports()
          Method getReports.
 boolean isInheritanceApplied()
           
 void removeReport(String string)
          Method removeReport.
 void setConfiguration(Object configuration)
          Set configuration of the report to be used when generating this set.
 void setId(String id)
          Set the unique id for this report set, to be used during POM inheritance and profile injection for merging of report sets.
 void setInherited(String inherited)
          Set whether any configuration should be propagated to child POMs.
 void setLocation(Object key, InputLocation location)
          Sets the location of the specified field.
 void setReports(List<String> reports)
          Set the list of reports from this plugin which should be generated from this set.
 String toString()
           
 void unsetInheritanceApplied()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReportSet

public ReportSet()
Method Detail

addReport

public void addReport(String string)
Method addReport.

Parameters:
string -

clone

public ReportSet clone()
Method clone.

Overrides:
clone in class Object
Returns:
ReportSet

getConfiguration

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

Returns:
Object

getId

public String getId()
Get the unique id for this report set, to be used during POM inheritance and profile injection for merging of report sets.

Returns:
String

getInherited

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

Returns:
String

getLocation

public InputLocation getLocation(Object key)
Description copied from interface: InputLocationTracker
Gets the location of the specified field in the input source.

Specified by:
getLocation in interface InputLocationTracker
Parameters:
key -
Returns:
InputLocation

getReports

public List<String> getReports()
Method getReports.

Returns:
List

removeReport

public void removeReport(String string)
Method removeReport.

Parameters:
string -

setConfiguration

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

Parameters:
configuration -

setId

public void setId(String id)
Set the unique id for this report set, to be used during POM inheritance and profile injection for merging of report sets.

Parameters:
id -

setInherited

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

Parameters:
inherited -

setLocation

public void setLocation(Object key,
                        InputLocation location)
Description copied from interface: InputLocationTracker
Sets the location of the specified field.

Specified by:
setLocation in interface InputLocationTracker
Parameters:
key -
location -

setReports

public void setReports(List<String> 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()

toString

public String toString()
Overrides:
toString in class Object


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