org.apache.tools.ant.taskdefs.optional
public class IContract extends MatchingTask
Attribute | Description | Required |
srcdir | Location of the java files. | Yes |
instrumentdir | Indicates where the instrumented source files should go. | Yes |
repositorydir | Indicates where the repository source files should go. | Yes |
builddir | Indicates where the compiled instrumented classes should go. Defaults to the value of instrumentdir. NOTE: Don't use the same directory for compiled instrumented classes and uninstrumented classes. It will break the dependency checking. (Classes will not be reinstrumented if you change them). | No |
repbuilddir | Indicates where the compiled repository classes should go. Defaults to the value of repositorydir. | No |
pre | Indicates whether or not to instrument for
preconditions. Defaults to true unless
controlfile is specified, in which case it defaults
to false . |
No |
post | Indicates whether or not to instrument for
postconditions. Defaults to true unless
controlfile is specified, in which case it defaults
to false . |
No |
invariant | Indicates whether or not to instrument for invariants.
Defaults to true unless controlfile is
specified, in which case it defaults to
false . |
No |
failthrowable | The full name of the Throwable (Exception) that
should be thrown when an assertion is violated.
Defaults to java.lang.Error |
No |
verbosity | Indicates the verbosity level of iContract.
Any combination of
error*,warning*,note*,info*,progress*,debug*
(comma separated) can be used. Defaults to error* |
No |
quiet | Indicates if iContract should be quiet. Turn it off
if many your classes extend uninstrumented classes and you don't
want warnings about this. Defaults to false |
No |
updateicontrol | If set to true, it indicates that the properties
file for iControl in the current directory should be updated
(or created if it doesn't exist). Defaults to false .
|
No |
controlfile | The name of the control file to pass to iContract. Consider using iControl to generate the file. Default is not to pass a file. |
Only if updateicontrol=true |
classdir | Indicates where compiled (unistrumented) classes are located. This is required in order to properly update the icontrol.properties file, not for instrumentation. | Only if
updateicontrol=true |
targets | Name of the file that will be generated by this task, which lists all the classes that iContract will instrument. If specified, the file will not be deleted after execution. If not specified, a file will still be created, but it will be deleted after execution. | No |
build.compiler
property. See documentation of the Javac task for
more information.
Nested includes and excludes are also supported.
Example:
<icontract srcdir="${build.src}" instrumentdir="${build.instrument}" repositorydir="${build.repository}" builddir="${build.instrclasses}" updateicontrol="true" classdir="${build.classes}" controlfile="control" targets="targets" verbosity="error*,warning*" quiet="true" > <classpath refid="compile-classpath"/> </icontract>
Method Summary | |
---|---|
Path | createClasspath()
Sets the classpath.
|
void | execute()
Executes the task
|
void | setBuilddir(File buildDir)
Sets the build directory for instrumented classes.
|
void | setClassdir(File classDir)
Sets the class directory (uninstrumented classes).
|
void | setClasspath(Path path)
Sets the classpath to be used for invocation of iContract.
|
void | setClasspathRef(Reference reference)
Adds a reference to a classpath defined elsewhere.
|
void | setControlfile(File controlFile)
Sets the control file to pass to iContract.
|
void | setFailthrowable(String clazz)
Sets the Throwable (Exception) to be thrown on assertion violation.
|
void | setInstrumentdir(File instrumentDir)
Sets the instrumentation directory.
|
void | setInvariant(boolean invariant)
Turns on/off invariant instrumentation.
|
void | setPost(boolean post)
Turns on/off postcondition instrumentation.
|
void | setPre(boolean pre)
Turns on/off precondition instrumentation.
|
void | setQuiet(boolean quiet)
Tells iContract to be quiet.
|
void | setRepbuilddir(File repBuildDir)
Sets the build directory for instrumented classes.
|
void | setRepositorydir(File repositoryDir)
Sets the build directory for repository classes.
|
void | setSrcdir(File srcDir)
Sets the source directory.
|
void | setTargets(File targets)
Sets the name of the file where targets will be written. |
void | setUpdateicontrol(boolean updateIcontrol)
If true, updates iControl properties file
|
void | setVerbosity(String verbosity)
Sets the verbosity level of iContract. |
Returns: the nested classpath element
UNKNOWN: this overwrites the classpath so only one effective classpath element would work. This is not how we do this elsewhere.
Throws: BuildException if the instrumentation fails
Parameters: buildDir the build directory
Parameters: classDir the source directory
Parameters: path the classpath
Parameters: reference referenced classpath
Parameters: controlFile the control file
Parameters: clazz the fully qualified Throwable class name
Parameters: instrumentDir the source directory
Parameters: invariant true turns it on
Parameters: post true turns it on
Parameters: pre true turns it on
Parameters: quiet true if iContract should be quiet.
Parameters: repBuildDir the build directory
Parameters: repositoryDir the source directory
Parameters: srcDir the source directory
Parameters: targets the targets file name
Parameters: updateIcontrol true if iControl properties file should be updated
Parameters: verbosity verbosity level