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

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

Type Parameters:

O - the type of the output instance that handles the writing.

All Implemented Interfaces:

de.smartics.exceptions.report.data.ProjectConfiguration<O>

public final class DefaultProjectConfiguration<O>
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements de.smartics.exceptions.report.data.ProjectConfiguration<O>
     
     

Default implementation.

Nested Class Summary

static class

DefaultProjectConfiguration.Builder<O> The configuration builder.

Method Summary

ResourceBundle	getBundle()
de.smartics.messages.core.BundleMapper	getBundleMapper()
Collection<String>	getClassRootDirectoryNames()
List<String>	getExcludes() Returns the excludes for the scanner.
List<String>	getIncludes() Returns the includes for the scanner.
File	getJavadocDir() Returns the directory where the Javadoc pages are found.
String	getJavadocRelativeDir() This value is optional and may be null.
ClassLoader	getProjectClassLoader() Returns the class loader to load project classes.
String	getProjectName()
String	getReport()
String	getReportEncoding()
String	getReporter()
de.smartics.exceptions.report.generator.ReportGenerator<O>	getReporterInstance()
String	getSourceEncoding()
Collection<String>	getSourceRootDirectoryNames()
String	getSourceVersion()
String	getStyleSheet() Returns the reference to the style sheet to add as link element to the head of the XHTML document.
List<String>	getToolClassPath() Returns the classpath used by the tool.

Methods inherited from class java.lang.Object

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

Method Detail

getToolClassPath

public List<String> getToolClassPath()

Returns the classpath used by the tool.

Returns:

the classpath used by the tool.

getClassRootDirectoryNames

public Collection<String> getClassRootDirectoryNames()

Specified by:

getClassRootDirectoryNames in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getClassRootDirectoryNames()

getProjectClassLoader

public ClassLoader getProjectClassLoader()

Returns the class loader to load project classes.

Returns:

the class loader to load project classes.

getSourceRootDirectoryNames

public Collection<String> getSourceRootDirectoryNames()

Specified by:

getSourceRootDirectoryNames in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getSourceRootDirectoryNames()

getProjectName

public String getProjectName()

Specified by:

getProjectName in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getProjectName()

getIncludes

public List<String> getIncludes()

Returns the includes for the scanner.

Specified by:

getIncludes in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

Returns:

the includes for the scanner.

getExcludes

public List<String> getExcludes()

Returns the excludes for the scanner.

Specified by:

getExcludes in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

Returns:

the excludes for the scanner.

getSourceEncoding

public String getSourceEncoding()

Specified by:

getSourceEncoding in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getSourceEncoding()

getReportEncoding

public String getReportEncoding()

Specified by:

getReportEncoding in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getReportEncoding()

getReporter

public String getReporter()

Specified by:

getReporter in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

getReporterInstance

public de.smartics.exceptions.report.generator.ReportGenerator<O> getReporterInstance()

Specified by:

getReporterInstance in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getReporterInstance()

getReport

public String getReport()

Specified by:

getReport in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getReport()

getBundle

public ResourceBundle getBundle()

Specified by:

getBundle in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getBundle()

getJavadocDir

public File getJavadocDir()

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

Specified by:

getJavadocDir in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

Returns:

the directory where the Javadoc pages are found.

getJavadocRelativeDir

public String getJavadocRelativeDir()

This value is optional and may be null.

Specified by:

getJavadocRelativeDir in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getJavadocRelativeDir()

getStyleSheet

public String getStyleSheet()

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

Specified by:

getStyleSheet in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

Returns:

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

getSourceVersion

public String getSourceVersion()

getBundleMapper

public de.smartics.messages.core.BundleMapper getBundleMapper()

Specified by:

getBundleMapper in interface de.smartics.exceptions.report.data.ProjectConfiguration<O>

See Also:

de.smartics.report.conf.ProjectConfiguration#getBundleMapper()