de.smartics.properties.report
Class ReportConfiguration

java.lang.Object
  de.smartics.properties.report.ReportConfiguration

public final class ReportConfiguration
     
     

      
      extends 
      
      Object
     
     

Provides information to control the creation of the report.

Constructor Summary

ReportConfiguration()
Default constructor.

Method Summary

void	addSourceTree(File sourceTree) Adds the given source tree to the list of source tree.
String	getEncoding() Returns the encoding to use to read the source files.
ClassLoader	getProjectClassLoader() Returns the class loader to instantiate classes of the project.
List<File>	getSourceTrees() Returns the list of source trees to be added for parsing.
void	setEncoding(String encoding) Sets the encoding to use to read the source files.
void	setProjectClassLoader(ClassLoader projectClassLoader) Sets the class loader to instantiate classes of the project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportConfiguration

public ReportConfiguration()

Default constructor.

Method Detail

getSourceTrees

public List<File> getSourceTrees()

Returns the list of source trees to be added for parsing.

Returns:

the list of source trees to be added for parsing.

getProjectClassLoader

public ClassLoader getProjectClassLoader()

Returns the class loader to instantiate classes of the project. The class loader is also required to instantiate classes from dependencies.

Returns:

the class loader to instantiate classes of the project.

setProjectClassLoader

public void setProjectClassLoader(ClassLoader projectClassLoader)

Sets the class loader to instantiate classes of the project. The class loader is also required to instantiate classes from dependencies.

Parameters:

projectClassLoader - the class loader to instantiate classes of the project.

getEncoding

public String getEncoding()

Returns the encoding to use to read the source files. Defaults to UTF-8.

Returns:

the encoding to use to read the source files.

setEncoding

public void setEncoding(String encoding)

Sets the encoding to use to read the source files. Defaults to UTF-8.

Parameters:

encoding - the encoding to use to read the source files.

addSourceTree

public void addSourceTree(File sourceTree)
                   throws de.smartics.util.lang.NullArgumentException

Adds the given source tree to the list of source tree.

Parameters:

sourceTree - the source tree to add.

Throws:

de.smartics.util.lang.NullArgumentException - if sourceTree is null.