public class JCSCTask
extends org.apache.tools.ant.Task
JCSCTask
Constructor and Description |
---|
JCSCTask() |
Modifier and Type | Method and Description |
---|---|
void |
addFileSet(org.apache.tools.ant.types.FileSet fs)
Add a file set include all files to parse
|
void |
execute()
Describe
execute method here. |
protected void |
executeFile(rj.tools.jcsc.ant.ParseFile file)
executeFile runs JCSC on one File |
protected void |
executeFiles(rj.tools.jcsc.ant.ParseFile[] files)
executeFiles runs JCSC on an array of Files |
protected rj.tools.jcsc.ant.ParseFile[] |
getFiles()
getFiles transforms FileSet into an File array |
void |
setCopyAssociatedFiles(java.lang.String value)
Copy associated files to destdir
|
void |
setDestdir(java.lang.String dir)
setDestdir - the folder into which the output is written to. |
void |
setFailProperty(java.lang.String name)
If this property is set JCSC will not fail directly but will set the
specified property to 'true'.
|
void |
setFailSeverity(java.lang.String level)
set the level for a found violation to cause a build fail
|
void |
setFailValue(java.lang.String value)
setFailValue set the fail value which will cause a failure if
the avg violations per ncss is higher. |
void |
setFile(java.lang.String file)
setFile - the name of the single file to check. |
void |
setIgnoreTestSeverity(java.lang.String level)
set the level for a found violation to cause a build fail
|
void |
setJcscHome(java.lang.String home)
The home of JCSC
|
void |
setResultsformatter(java.lang.String resultsFormatter)
setResultsformatter - the results formatter to use. |
void |
setRules(java.lang.String rules)
setRules - the rules file to use. |
void |
setStartDate(java.lang.String date)
setStartDate set the date/time from which files are being
considered. |
void |
setStartpackage(java.lang.String startpackage)
The name of the topmost package with the
tailing '.', For example: com.foo... would have com.
|
void |
setViolationsSorter(java.lang.String name)
Set the sorting algorithm for how the found violations have to be sorted
|
void |
setWorstCount(int count)
setWorstCount - how many files should be part of the hall of
'shame'. |
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
public void setRules(java.lang.String rules)
setRules
- the rules file to use.rules
- a String
valuepublic void setFile(java.lang.String file)
setFile
- the name of the single file to check.file
- a String
valuepublic void setStartpackage(java.lang.String startpackage)
startpackage
- public void setResultsformatter(java.lang.String resultsFormatter)
setResultsformatter
- the results formatter to use.resultsFormatter
- a String
valuepublic void setDestdir(java.lang.String dir)
setDestdir
- the folder into which the output is written to.dir
- a String
valuepublic void setWorstCount(int count)
setWorstCount
- how many files should be part of the hall of
'shame'.count
- an int
valuepublic void setStartDate(java.lang.String date)
setStartDate
set the date/time from which files are being
considered. Format YYYY-MM-DD HH:MM:SSdate
- a String
valuepublic void setFailValue(java.lang.String value)
setFailValue
set the fail value which will cause a failure if
the avg violations per ncss is higher.value
- a String
valuepublic void setViolationsSorter(java.lang.String name)
name
- of class to be uses as algorithm implementationpublic void setFailSeverity(java.lang.String level)
level
- public void setFailProperty(java.lang.String name)
name
- public void setIgnoreTestSeverity(java.lang.String level)
level
- public void setCopyAssociatedFiles(java.lang.String value)
value
- public void setJcscHome(java.lang.String home)
home
- public void addFileSet(org.apache.tools.ant.types.FileSet fs)
fs
- a FileSet
valueprotected rj.tools.jcsc.ant.ParseFile[] getFiles()
getFiles
transforms FileSet into an File arrayFile[]
valuepublic void execute() throws org.apache.tools.ant.BuildException
execute
method here.execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
- if an error occursprotected void executeFile(rj.tools.jcsc.ant.ParseFile file) throws org.apache.tools.ant.BuildException
executeFile
runs JCSC on one Filefile
- a File
valueorg.apache.tools.ant.BuildException
- if an error occursprotected void executeFiles(rj.tools.jcsc.ant.ParseFile[] files) throws org.apache.tools.ant.BuildException
executeFiles
runs JCSC on an array of Filesfiles
- a ParseFile[]
valueorg.apache.tools.ant.BuildException
- if an error occurs
JCSC is released under the terms of the GNU General Public License