Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.apache.tools.ant.taskdefs.optional.IContract
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>
Field Summary |
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask | |
fileset |
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 |
Method Summary | |
Path |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask | |
XsetIgnore , XsetItems , add , addAnd , addContains , addContainsRegexp , addCustom , addDate , addDepend , addDepth , addDifferent , addFilename , addMajority , addModified , addNone , addNot , addOr , addPresent , addSelector , addSize , addType , appendSelector , createExclude , createExcludesFile , createInclude , createIncludesFile , createPatternSet , getDirectoryScanner , getImplicitFileSet , getSelectors , hasSelectors , selectorCount , selectorElements , setCaseSensitive , setDefaultexcludes , setExcludes , setExcludesfile , setFollowSymlinks , setIncludes , setIncludesfile , setProject |
Methods inherited from class org.apache.tools.ant.Task | |
execute , getDescription , getLocation , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , maybeConfigure , perform , reconfigure , setDescription , setLocation , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent | |
getProject , log , log , setProject |
public Path createClasspath()
Sets the classpath.
- Returns:
- the nested classpath element
To do:
- this overwrites the classpath so only one effective classpath element would work. This is not how we do this elsewhere.
public void execute() throws BuildException
Executes the task
- Throws:
BuildException
- if the instrumentation fails
public void setBuilddir(File buildDir)
Sets the build directory for instrumented classes.
- Parameters:
buildDir
- the build directory
public void setClassdir(File classDir)
Sets the class directory (uninstrumented classes).
- Parameters:
classDir
- the source directory
public void setClasspath(Path path)
Sets the classpath to be used for invocation of iContract.
- Parameters:
path
- the classpath
public void setClasspathRef(Reference reference)
Adds a reference to a classpath defined elsewhere.
- Parameters:
reference
- referenced classpath
public void setControlfile(File controlFile)
Sets the control file to pass to iContract.
- Parameters:
controlFile
- the control file
public void setFailthrowable(String clazz)
Sets the Throwable (Exception) to be thrown on assertion violation.
- Parameters:
clazz
- the fully qualified Throwable class name
public void setInstrumentdir(File instrumentDir)
Sets the instrumentation directory.
- Parameters:
instrumentDir
- the source directory
public void setInvariant(boolean invariant)
Turns on/off invariant instrumentation.
- Parameters:
invariant
- true turns it on
public void setPost(boolean post)
Turns on/off postcondition instrumentation.
- Parameters:
post
- true turns it on
public void setPre(boolean pre)
Turns on/off precondition instrumentation.
- Parameters:
pre
- true turns it on
public void setQuiet(boolean quiet)
Tells iContract to be quiet.
- Parameters:
quiet
- true if iContract should be quiet.
public void setRepbuilddir(File repBuildDir)
Sets the build directory for instrumented classes.
- Parameters:
repBuildDir
- the build directory
public void setRepositorydir(File repositoryDir)
Sets the build directory for repository classes.
- Parameters:
repositoryDir
- the source directory
public void setSrcdir(File srcDir)
Sets the source directory.
- Parameters:
srcDir
- the source directory
public void setTargets(File targets)
Sets the name of the file where targets will be written. That is the file that tells iContract what files to process.
- Parameters:
targets
- the targets file name
public void setUpdateicontrol(boolean updateIcontrol)
If true, updates iControl properties file
- Parameters:
updateIcontrol
- true if iControl properties file should be updated
public void setVerbosity(String verbosity)
Sets the verbosity level of iContract. Any combination of error*,warning*,note*,info*,progress*,debug* (comma separated) can be used. Defaults to error*,warning*
- Parameters:
verbosity
- verbosity level