org.jcoderz.phoenix.report
Class JcReportAntTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.jcoderz.phoenix.report.JcReportAntTask

All Implemented Interfaces:

Cloneable

public class JcReportAntTask
extends org.apache.tools.ant.Task

This is the Ant task for the Jcoderz Report. This task forks all processing steps as separate processes so that memory for each process can be controlled separately. TODO: Why are the inner classes static + take a JcReportAntTask?

Author:

Michael Rumpf

Nested Class Summary

static class	JcReportAntTask.NestedCheckstyleElement
static class	JcReportAntTask.NestedCoberturaElement
static class	JcReportAntTask.NestedCpdElement
static class	JcReportAntTask.NestedEmmaElement
static class	JcReportAntTask.NestedFilterElement
static class	JcReportAntTask.NestedFiltersElement
static class	JcReportAntTask.NestedFindbugsElement
static class	JcReportAntTask.NestedLogfileElement
static class	JcReportAntTask.NestedLogfilesElement
static class	JcReportAntTask.NestedMappingElement
static class	JcReportAntTask.NestedMappingsElement
static class	JcReportAntTask.NestedPmdElement
static class	JcReportAntTask.NestedReportElement This class represents a <report> tag in an Ant build.xml file.
static class	JcReportAntTask.NestedReportsElement
static class	JcReportAntTask.NestedToolElement This is the base class for all tool elements.
static class	JcReportAntTask.NestedToolsElement

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

JcReportAntTask()

Method Summary

org.apache.tools.ant.types.Path	createClasspath()
JcReportAntTask.NestedFiltersElement	createFilters() This method is called by Ant to create an instance of the NestedFiltersElement class when the 'filters' tag is read.
JcReportAntTask.NestedLogfilesElement	createLogfiles() This method is called by Ant to create an instance of the NestedLogfilesElement class when the 'logfiles' tag is read.
JcReportAntTask.NestedMappingsElement	createMappings() This method is called by Ant to create an instance of the NestedMappingsElement class when the 'mappings' tag is read.
JcReportAntTask.NestedReportsElement	createReports() This method is called by Ant to create an instance of the NestedReportsElement class when the 'reports' tag is read.
JcReportAntTask.NestedToolsElement	createTools() This method is called by Ant to create an instance of the NestedToolsElement class when the 'tools' tag is read.
void	execute() This method is called by Ant for executing this task.
int	getCpus()
String	getEncoding()
File	getWorkingDir() Returns the working directory.
void	log(String msg) Overwrites the method from the super class in order to check for debug mode.
void	setCpus(int cpus)
void	setDebug(Boolean debug) Sets the debug parameter.
void	setDest(String dest) Sets the destination of the report.
void	setEncoding(String encoding)
void	setMaxHeap(String maxheap) Sets the maximum heap value.
void	setName(String name) Sets the name of the report.
void	setOldReportFile(String oldReportFile)
void	setPackageBase(String packageBase)
void	setProjectBase(String projectBase)
void	setStylesheet(String stylesheet) Sets the stylesheet to be used for the report.
void	setTempfolder(String tempfolder) Sets the temporary folder.
void	setWebRcsBase(String webRcsBase)
void	setWebRcsSuffix(String webRcsSuffix)
void	setWikiBase(String wikiBase)

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, 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

JcReportAntTask

public JcReportAntTask()

Method Detail

getCpus

public int getCpus()

Returns:

the number of cpus to put load on.

setCpus

public void setCpus(int cpus)

Parameters:

cpus - the cpus to set

getEncoding

public String getEncoding()

Returns:

the sourceEncoding

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - the sourceEncoding to set

getWorkingDir

public File getWorkingDir()

Returns the working directory.

Returns:

the working directory.

setMaxHeap

public void setMaxHeap(String maxheap)

Sets the maximum heap value. If not defined in the Ant task the default value of 512MB will be used.

Parameters:

maxheap - the max heap value.

setName

public void setName(String name)

Sets the name of the report.

Parameters:

name - the report name.

setDest

public void setDest(String dest)

Sets the destination of the report.

Parameters:

dest - the report destination.

setPackageBase

public void setPackageBase(String packageBase)

setProjectBase

public void setProjectBase(String projectBase)

setWebRcsBase

public void setWebRcsBase(String webRcsBase)

setWebRcsSuffix

public void setWebRcsSuffix(String webRcsSuffix)

setWikiBase

public void setWikiBase(String wikiBase)

setOldReportFile

public void setOldReportFile(String oldReportFile)

setStylesheet

public void setStylesheet(String stylesheet)

Sets the stylesheet to be used for the report.

Parameters:

stylesheet - the report stylesheet.

setTempfolder

public void setTempfolder(String tempfolder)

Sets the temporary folder.

Parameters:

tempfolder - the temporary folder.

setDebug

public void setDebug(Boolean debug)

Sets the debug parameter.

Parameters:

debug - the debug parameter.

createClasspath

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

execute

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

This method is called by Ant for executing this task.

Overrides:

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

Throws:

org.apache.tools.ant.BuildException - whenever a problem occurs.

createReports

public JcReportAntTask.NestedReportsElement createReports()

This method is called by Ant to create an instance of the NestedReportsElement class when the 'reports' tag is read.

Returns:

the new instance of type NestedReportsElement.

createMappings

public JcReportAntTask.NestedMappingsElement createMappings()

This method is called by Ant to create an instance of the NestedMappingsElement class when the 'mappings' tag is read.

Returns:

the new instance of type NestedMappingsElement.

createTools

public JcReportAntTask.NestedToolsElement createTools()

This method is called by Ant to create an instance of the NestedToolsElement class when the 'tools' tag is read.

Returns:

the new instance of type NestedToolsElement.

createLogfiles

public JcReportAntTask.NestedLogfilesElement createLogfiles()

This method is called by Ant to create an instance of the NestedLogfilesElement class when the 'logfiles' tag is read.

Returns:

the new instance of type NestedFiltersElement.

createFilters

public JcReportAntTask.NestedFiltersElement createFilters()

This method is called by Ant to create an instance of the NestedFiltersElement class when the 'filters' tag is read.

Returns:

the new instance of type NestedFiltersElement.

log

public void log(String msg)

Overwrites the method from the super class in order to check for debug mode.

Overrides:

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

Parameters:

msg - the message to log.