Class ConvertXmlToTextTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

edu.umd.cs.findbugs.anttask.AbstractFindBugsTask

edu.umd.cs.findbugs.anttask.ConvertXmlToTextTask

All Implemented Interfaces:

Cloneable

public class ConvertXmlToTextTask
extends AbstractFindBugsTask

Ant task to generate HTML or plain text from a saved XML analysis results file.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractFindBugsTask

AbstractFindBugsTask.SystemProperty

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	applySuppression
private boolean	failIfBugFound
private String	format
private String	input
private boolean	longBugCodes
private String	output

Fields inherited from class AbstractFindBugsTask

DEFAULT_TIMEOUT, errorProperty, execResultProperty, FINDBUGS_JAR, RESULT_PROPERTY_SUFFIX

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

Constructors

Constructor	Description
ConvertXmlToTextTask()

Method Summary

Modifier and Type	Method	Description
protected void	afterExecuteJavaProcess(int rc)
protected void	beforeExecuteJavaProcess()
protected void	checkParameters()	Check that all required attributes have been set.
protected void	configureFindbugsEngine()
void	setApplySuppression(boolean applySuppression)
void	setFailIfBugFound(boolean failIfBugFound)
void	setFormat(String format)
void	setInput(String input)
void	setInputFile(String input)
void	setLongBugCodes(boolean longBugCodes)
void	setOutput(String output)
void	setOutputFile(String output)

Methods inherited from class AbstractFindBugsTask

addArg, createClasspath, createFindbugsEngine, createPluginList, createSystemProperty, execute, getDebug, getFindbugsEngine, setClasspath, setClasspathRef, setDebug, setErrorProperty, setFailOnError, setHome, setInputString, setJvm, setJvmargs, setPluginList, setPluginListRef, setTimeout

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 Object

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

Field Details

longBugCodes

private boolean longBugCodes

applySuppression

private boolean applySuppression

failIfBugFound

private boolean failIfBugFound

input

private String input

output

private String output

format

private String format

Constructor Details

ConvertXmlToTextTask

public ConvertXmlToTextTask()

Method Details

setLongBugCodes

public void setLongBugCodes(boolean longBugCodes)

Parameters:

longBugCodes - The longBugCodes to set.

setApplySuppression

public void setApplySuppression(boolean applySuppression)

Parameters:

applySuppression - The applySuppression to set.

setInput

public void setInput(String input)

Parameters:

input - The input to set.

setOutput

public void setOutput(String output)

Parameters:

output - The output to set.

setInputFile

public void setInputFile(String input)

Parameters:

input - The input to set.

setOutputFile

public void setOutputFile(String output)

Parameters:

output - The output to set.

setFormat

public void setFormat(String format)

Parameters:

format - The format to set.

setFailIfBugFound

public void setFailIfBugFound(boolean failIfBugFound)

Parameters:

failIfBugFound - true to 'fail' at the end if at least one bug is reported

checkParameters

protected void checkParameters()

Description copied from class: AbstractFindBugsTask

Check that all required attributes have been set.

Overrides:

checkParameters in class AbstractFindBugsTask

configureFindbugsEngine

protected void configureFindbugsEngine()

Specified by:

configureFindbugsEngine in class AbstractFindBugsTask

beforeExecuteJavaProcess

protected void beforeExecuteJavaProcess()

Specified by:

beforeExecuteJavaProcess in class AbstractFindBugsTask

afterExecuteJavaProcess

protected void afterExecuteJavaProcess(int rc)

Overrides:

afterExecuteJavaProcess in class AbstractFindBugsTask