de.smartics.maven.exceptions.conf
Class DefaultProjectConfiguration.Builder<O>

java.lang.Object
  de.smartics.maven.exceptions.conf.DefaultProjectConfiguration.Builder<O>

Enclosing class:

DefaultProjectConfiguration< O>

public static final class DefaultProjectConfiguration.Builder<O>
     
     

      
      extends 
      
      Object
     
     

The configuration builder.

Constructor Summary

DefaultProjectConfiguration.Builder(String projectName)
Default constructor.

Method Summary

de.smartics.exceptions.report.data.ProjectConfiguration<O>	build() Creates the project configuration.
void	setBundle(ResourceBundle bundle) Sets the bundle set for this report execution.
void	setBundleMapperClassName(String bundleMapperClassName) Sets the class of the mapper to the resource bundles of a given item class.
void	setClassRootDirectoryNames(Collection<String> classRootDirectoryNames) Sets the list of class path root elements of this project.
void	setExcludes(List<String> excludes) Sets the excludes for the scanner.
void	setIncludes(List<String> includes) Sets the includes for the scanner.
void	setJavadocDir(File javadocDir) Sets the directory where the Javadoc pages are found.
void	setReport(String report) Sets the name of the file the report will be written to.
void	setReportEncoding(String reportEncoding) Sets the encoding of the generated report.
void	setReporter(String reporterClass) Sets the class name of the reporter.
void	setSourceEncoding(String sourceEncoding) Sets the encoding of the source files in this project.
void	setSourceRootDirectoryNames(Collection<String> sourceRootDirectoryNames) Sets the list of source path root elements of this project.
void	setSourceVersion(String sourceVersion) Sets the Java version specified for the sources in the project.
void	setStyleSheet(String styleSheet) Sets the reference to the style sheet to add as link element to the head of the XHTML document.
void	setToolClassPath(List<String> toolClassPath) Sets the classpath used by the tool.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProjectConfiguration.Builder

public DefaultProjectConfiguration.Builder(String projectName)

Default constructor.

Parameters:

projectName - the name of the project this configuration is for.

Method Detail

setToolClassPath

public void setToolClassPath(List<String> toolClassPath)

Sets the classpath used by the tool.

Parameters:

toolClassPath - the classpath used by the tool.

setClassRootDirectoryNames

public void setClassRootDirectoryNames(Collection<String> classRootDirectoryNames)

Sets the list of class path root elements of this project.

Parameters:

classRootDirectoryNames - the list of class path root elements of this project.

setSourceRootDirectoryNames

public void setSourceRootDirectoryNames(Collection<String> sourceRootDirectoryNames)

Sets the list of source path root elements of this project.

Parameters:

sourceRootDirectoryNames - the list of source path root elements of this project.

setIncludes

public void setIncludes(List<String> includes)

Sets the includes for the scanner.

Parameters:

includes - the includes for the scanner.

setExcludes

public void setExcludes(List<String> excludes)

Sets the excludes for the scanner.

Parameters:

excludes - the excludes for the scanner.

setSourceEncoding

public void setSourceEncoding(String sourceEncoding)

Sets the encoding of the source files in this project.

Parameters:

sourceEncoding - the encoding of the source files in this project.

setSourceVersion

public void setSourceVersion(String sourceVersion)

Sets the Java version specified for the sources in the project.

Parameters:

sourceEncoding - the Java version specified for the sources in the project.

setReportEncoding

public void setReportEncoding(String reportEncoding)

Sets the encoding of the generated report.

Parameters:

reportEncoding - the encoding of the generated report.

setReporter

public void setReporter(String reporterClass)

Sets the class name of the reporter.

Parameters:

reporterClass - the class name of the reporter.

setReport

public void setReport(String report)

Sets the name of the file the report will be written to.

Parameters:

report - the name of the file the report will be written to.

setBundle

public void setBundle(ResourceBundle bundle)

Sets the bundle set for this report execution.

Parameters:

bundle - the bundle set for this report execution.

setJavadocDir

public void setJavadocDir(File javadocDir)

Sets the directory where the Javadoc pages are found. This information is used to make relative links from the exceptions report to the Javadocs.

Parameters:

javadocDir - the directory where the Javadoc pages are found.

setStyleSheet

public void setStyleSheet(String styleSheet)

Sets the reference to the style sheet to add as link element to the head of the XHTML document.

Parameters:

styleSheet - the reference to the style sheet to add as link element to the head of the XHTML document.

setBundleMapperClassName

public void setBundleMapperClassName(String bundleMapperClassName)

Sets the class of the mapper to the resource bundles of a given item class. The item is to be documented.

Parameters:

bundleMapperClassName - the class of the mapper to the resource bundles of a given item class.

build

public de.smartics.exceptions.report.data.ProjectConfiguration<O> build()
                                                                 throws IllegalArgumentException

Creates the project configuration.

Returns:

the project configuration.

Throws:

IllegalArgumentException - if any property is not valid.