|
MAudit (Apache Ant API)
org.apache.tools.ant.taskdefs.optional.metamata
|
Field Summary |
Fields inherited from class org.apache.tools.ant.taskdefs.optional.metamata.AbstractMetamataTask |
classPath, cmdl, fileSets, includedFiles, metamataHome, optionsFile, sourcePath |
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
Constructor Summary | |
MAudit()
default constructor |
Method Summary | |
protected void |
checkOptions()
validate the settings |
protected void |
cleanUp()
clean up all the mess that we did with temporary objects |
Path |
createRulespath()
classpath for additional audit rules these must be placed before metamata.jar !! |
Path |
createSearchpath()
search path to use for unused global declarations; required when unused is set. |
protected ExecuteStreamHandler |
createStreamHandler()
create a stream handler that will be used to get the output since metamata tools do not report with convenient files such as XML. |
protected java.util.Vector |
getOptions()
create the option vector for the command |
void |
setExit(boolean flag)
flag to tell the task to exit after the first error. |
void |
setFix(boolean flag)
Automatically fix certain errors (those marked as fixable in the manual); optional, default=false |
void |
setFullsemanticize(boolean flag)
internal/testing only |
void |
setList(boolean flag)
Creates listing file for each audited file; optional, default false. |
void |
setOffsets(boolean flag)
internal/testing only |
void |
setQuiet(boolean flag)
flag to suppress copyright and summary messages; default false. |
void |
setTofile(java.io.File outFile)
The XML file to which the Audit result should be written to; required |
void |
setUnused(boolean flag)
Finds declarations unused in search paths; optional, default false. |
void |
setVerbose(boolean flag)
flag to print all messages; optional, default false. |
Methods inherited from class org.apache.tools.ant.taskdefs.optional.metamata.AbstractMetamataTask |
addAllVector, addFileSet, createClasspath, createJvmarg, createSourcepath, createTmpFile, execute, execute0, generateOptionsFile, getFileMapping, getMetamataJar, scanSources, scanSources, setHome, setMaxmemory, setMetamatahome, setUp |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public MAudit()
Method Detail |
public void setTofile(java.io.File outFile)
public void setFix(boolean flag)
public void setList(boolean flag)
public void setUnused(boolean flag)
public void setQuiet(boolean flag)
public void setExit(boolean flag)
public void setOffsets(boolean flag)
public void setVerbose(boolean flag)
public void setFullsemanticize(boolean flag)
public Path createRulespath()
public Path createSearchpath()
protected java.util.Vector getOptions()
getOptions
in class AbstractMetamataTask
protected void checkOptions() throws BuildException
checkOptions
in class AbstractMetamataTask
protected ExecuteStreamHandler createStreamHandler() throws BuildException
AbstractMetamataTask
createStreamHandler
in class AbstractMetamataTask
protected void cleanUp() throws BuildException
AbstractMetamataTask
cleanUp
in class AbstractMetamataTask
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |