de.smartics.exceptions.ant
Class ExceptionCodesReportTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          de.smartics.exceptions.ant.ExceptionCodesReportTask

All Implemented Interfaces:

Cloneable

public class ExceptionCodesReportTask
     
     

      
      extends org.apache.tools.ant.Task
     
     

Ant task implementation to run exception codes report.

Author:

Robert Reiner

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

ExceptionCodesReportTask()

Method Summary

void	execute() Runs the Ant task to generate an exception codes report.
org.apache.tools.ant.types.Path	getClasspath() Returns the classpath to search for exception code classes.
String	getCssFile() Returns the link reference to the CSS file to add to the head element of the generated HTML document.
String	getProjectName() Returns the name of the project to collect information for.
String	getReportEncoding() Returns the encoding of the report documentation.
String	getReportExcludes() Returns the semicolon separated excluded directories.
String	getReportFile() Returns the name of the report file to write.
String	getReportGeneratorClass() Returns the class name of the report generator instance to use.
String	getReportIncludes() Returns the semicolon separated included directories.
String	getSourceEncoding() Returns the encoding of the Java source files.
org.apache.tools.ant.types.Path	getSourcepath() Returns the source path to search for Javadoc for the exception code classes found on the classpath.
void	run(de.smartics.report.conf.ProjectConfiguration<XMLStreamWriter> config) Delegates call to run(ProjectConfiguration,XMLStreamWriter) .
void	run(de.smartics.report.conf.ProjectConfiguration<XMLStreamWriter> configuration, XMLStreamWriter output) Runs the reporting with the given configuration and writer.
void	setClasspath(org.apache.tools.ant.types.Path classpath) Sets the classpath to search for exception code classes.
void	setClasspathRef(org.apache.tools.ant.types.Reference reference) Sets the classpath via an Ant reference to search for exception code classes.
void	setCssFile(String cssFile) Sets the link reference to the CSS file to add to the head element of the generated HTML document.
void	setProjectName(String projectName) Sets the name of the project to collect information for.
void	setReportEncoding(String reportEncoding) Sets the encoding of the report documentation.
void	setReportExcludes(String reportExcludes) Sets the semicolon separated excluded directories.
void	setReportFile(String reportFile) Sets the name of the report file to write.
void	setReportGeneratorClass(String reportGeneratorClass) Sets the class name of the report generator instance to use.
void	setReportIncludes(String reportIncludes) Sets the semicolon separated included directories.
void	setSourceEncoding(String sourceEncoding) Sets the encoding of the Java source files.
void	setSourcepath(org.apache.tools.ant.types.Path sourcepath) Sets the source path to search for Javadoc for the exception code classes found on the classpath.
void	setSourcepathRef(org.apache.tools.ant.types.Reference reference) Sets the source path via an Ant reference to search for Javadoc for the exception code classes found on the classpath.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionCodesReportTask

public ExceptionCodesReportTask()

Method Detail

getProjectName

public String getProjectName()

Returns the name of the project to collect information for.

Returns:

the name of the project to collect information for.

See Also:

getProjectName(), getProjectName()

setProjectName

public void setProjectName(String projectName)

Sets the name of the project to collect information for.

Parameters:

projectName - the name of the project to collect information for.

getReportFile

public String getReportFile()

Returns the name of the report file to write.

Returns:

the name of the report file to write.

setReportFile

public void setReportFile(String reportFile)

Sets the name of the report file to write.

Parameters:

reportFile - the name of the report file to write.

getReportGeneratorClass

public String getReportGeneratorClass()

Returns the class name of the report generator instance to use.

Returns:

the class name of the report generator instance to use.

setReportGeneratorClass

public void setReportGeneratorClass(String reportGeneratorClass)

Sets the class name of the report generator instance to use.

Parameters:

reportGeneratorClass - the class name of the report generator instance to use.

getReportEncoding

public String getReportEncoding()

Returns the encoding of the report documentation.

Returns:

the encoding of the report documentation.

setReportEncoding

public void setReportEncoding(String reportEncoding)

Sets the encoding of the report documentation.

Parameters:

reportEncoding - the encoding of the report documentation.

getReportExcludes

public String getReportExcludes()

Returns the semicolon separated excluded directories. Use Ant syntax.

Returns:

the semicolon separated excluded directories.

setReportExcludes

public void setReportExcludes(String reportExcludes)

Sets the semicolon separated excluded directories. Use Ant syntax.

Parameters:

reportExcludes - the semicolon separated excluded directories.

getReportIncludes

public String getReportIncludes()

Returns the semicolon separated included directories. Use Ant syntax.

Returns:

the semicolon separated included directories.

setReportIncludes

public void setReportIncludes(String reportIncludes)

Sets the semicolon separated included directories. Use Ant syntax.

Parameters:

reportIncludes - the semicolon separated included directories.

getSourceEncoding

public String getSourceEncoding()

Returns the encoding of the Java source files.

Returns:

the encoding of the Java source files.

setSourceEncoding

public void setSourceEncoding(String sourceEncoding)

Sets the encoding of the Java source files.

Parameters:

sourceEncoding - the encoding of the Java source files.

getCssFile

public String getCssFile()

Returns the link reference to the CSS file to add to the head element of the generated HTML document.

Returns:

the link reference to the CSS file to add to the head element of the generated HTML document.

setCssFile

public void setCssFile(String cssFile)

Sets the link reference to the CSS file to add to the head element of the generated HTML document.

Parameters:

cssFile - the link reference to the CSS file to add to the head element of the generated HTML document.

getClasspath

public org.apache.tools.ant.types.Path getClasspath()

Returns the classpath to search for exception code classes.

Returns:

the classpath to search for exception code classes.

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path classpath)

Sets the classpath to search for exception code classes.

Parameters:

classpath - the classpath to search for exception code classes.

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference reference)

Sets the classpath via an Ant reference to search for exception code classes.

Parameters:

reference - the classpath reference to search for exception code classes.

getSourcepath

public org.apache.tools.ant.types.Path getSourcepath()

Returns the source path to search for Javadoc for the exception code classes found on the classpath.

Returns:

the source path to search for Javadoc for the exception code classes found on the classpath.

setSourcepath

public void setSourcepath(org.apache.tools.ant.types.Path sourcepath)

Sets the source path to search for Javadoc for the exception code classes found on the classpath.

Parameters:

sourcepath - the source path to search for Javadoc for the exception code classes found on the classpath.

setSourcepathRef

public void setSourcepathRef(org.apache.tools.ant.types.Reference reference)

Sets the source path via an Ant reference to search for Javadoc for the exception code classes found on the classpath.

Parameters:

reference - the source path reference to search for Javadoc for the exception code classes found on the classpath.

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Runs the Ant task to generate an exception codes report.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - if the report cannot be generated successfully.

run

public void run(de.smartics.report.conf.ProjectConfiguration<XMLStreamWriter> config)
         throws de.smartics.report.ReportException

Delegates call to run(ProjectConfiguration,XMLStreamWriter) .

Parameters:

config - the configuration to control the discovery process.

Throws:

de.smartics.report.ReportException - on any problem generating the report.

See Also:

run(ProjectConfiguration,XMLStreamWriter)

run

public void run(de.smartics.report.conf.ProjectConfiguration<XMLStreamWriter> configuration,
                XMLStreamWriter output)
         throws de.smartics.report.ReportException

Runs the reporting with the given configuration and writer.

Parameters:

configuration - the configuration to control the discovery process.

output - the writer to write to. This overrules the report file in the configuration. If the writer is null the report file is required to be set.

Throws:

de.smartics.report.ReportException - on any problem generating the report.