An implementation of a ANT task for calling checkstyle. See the documentation
of the task for usage.
addFileset
public void addFileset(FileSet aFS)
Adds a set of files (nested fileset attribute).
aFS
- the file set to add
addFormatter
public void addFormatter(CheckStyleTask.Formatter aFormatter)
Add a formatter.
aFormatter
- the formatter to add for logging.
addProperty
public void addProperty(CheckStyleTask.Property aProperty)
Add an override property.
aProperty
- the property to add
createClasspath
public Path createClasspath()
- a created path for locating classes
execute
public void execute()
throws BuildException
Actually checks the files specified. All errors are reported to
System.out. Will fail if any errors occurred.
getListeners
protected AuditListener[] getListeners()
throws ClassNotFoundException,
InstantiationException,
IllegalAccessException,
IOException
Return the list of listeners set in this task.
- the list of listeners.
scanFileSets
protected File[] scanFileSets()
returns the list of files (full path name) to process.
- the list of files included via the filesets.
setClasspath
public void setClasspath(Path aClasspath)
Set the class path.
aClasspath
- the path to locate classes
setClasspathRef
public void setClasspathRef(Reference aClasspathRef)
Set the class path from a reference defined elsewhere.
aClasspathRef
- the reference to an instance defining the classpath
setConfig
public void setConfig(File aFile)
aFile
- the configuration file to use
setConfigURL
public void setConfigURL(URL aURL)
aURL
- the URL of the configuration to use
setFailOnViolation
public void setFailOnViolation(boolean aFail)
aFail
- whether to fail if a violation is found
setFailureProperty
public void setFailureProperty(String aPropertyName)
Tells this task to set the named property to "true" when there
is a violation.
aPropertyName
- the name of the property to set
in the event of an failure.
setFile
public void setFile(File aFile)
aFile
- the file to be checked
setMaxErrors
public void setMaxErrors(int aMaxErrors)
Sets the maximum number of errors allowed. Default is 0.
aMaxErrors
- the maximum number of errors allowed.
setMaxWarnings
public void setMaxWarnings(int aMaxWarnings)
Sets the maximum number of warings allowed. Default is
Integer.MAX_VALUE
.
aMaxWarnings
- the maximum number of warnings allowed.
setPackageNamesFile
public void setPackageNamesFile(File aFile)
aFile
- the package names file to use
setProperties
public void setProperties(File aProps)
Sets a properties file for use instead
of individually setting them.
aProps
- the properties File to use