Package org.apache.tools.ant.types
Class Assertions
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Assertions
- All Implemented Interfaces:
Cloneable
The assertion datatype. This type describes
assertion settings for the <java> task and others.
One can set the system assertions, and enable/disable those in
packages and classes.
Assertions can only be enabled or disabled when forking Java.
Example: set system assertions and all org.apache packages except
for ant, and the class org.apache.tools.ant.Main.
<assertions enableSystemAssertions="true" > <enable package="org.apache" /> <disable package="org.apache.ant" /> <enable class="org.apache.tools.ant.Main"/> </assertions>Disable system assertions; enable those in the anonymous package
<assertions enableSystemAssertions="false" > <enable package="..." /> </assertions>enable assertions in a class called Test
<assertions > <enable class="Test" /> </assertions>This type is a datatype, so you can declare assertions and use them later
<assertions id="project.assertions" > <enable project="org.apache.test" /> </assertions> <assertions refid="project.assertions" />
- Since:
- Ant 1.6
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classbase class for our assertion elements.static classA disabled assertion disables thingsstatic classan enabled assertion enables things -
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDisable(Assertions.DisabledAssertion assertion) disable assertionsvoidaddEnable(Assertions.EnabledAssertion assertion) enable assertionsvoidapplyAssertions(List<String> commandList) add the assertions to a list in a format suitable for adding to a command linevoidapplyAssertions(ListIterator<String> commandIterator) add the assertions to a list in a format suitable for adding to a command linevoidapplyAssertions(CommandlineJava command) apply all the assertions to the command.clone()clone the objects.voidsetEnableSystemAssertions(Boolean enableSystemAssertions) enable or disable system assertions.voidSet the value of the refid attribute.intsize()how many assertions are made...will resolve references before returningMethods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toStringMethods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Constructor Details
-
Assertions
public Assertions()
-
-
Method Details
-
addEnable
enable assertions- Parameters:
assertion- an enable assertion nested element
-
addDisable
disable assertions- Parameters:
assertion- a disable assertion nested element
-
setEnableSystemAssertions
enable or disable system assertions. Default is not set (neither -enablesystemassertions or -disablesytemassertions are used on the command line).- Parameters:
enableSystemAssertions- if true enable system assertions
-
setRefid
Set the value of the refid attribute.Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do the must call
super.setRefid. -
size
public int size()how many assertions are made...will resolve references before returning- Returns:
- total # of commands to make
-
applyAssertions
add the assertions to a list in a format suitable for adding to a command line- Parameters:
commandList- the command line to format
-
applyAssertions
apply all the assertions to the command.- Parameters:
command- the command line to format
-
applyAssertions
add the assertions to a list in a format suitable for adding to a command line- Parameters:
commandIterator- list of commands
-
clone
clone the objects. This is not a full depth clone; the list of assertions is cloned, but it does not clone the underlying assertions.- Overrides:
clonein classDataType- Returns:
- a cli
- Throws:
CloneNotSupportedException- if the super class does not support cloning
-