org.apache.tools.ant.types

Class Assertions

public class Assertions extends DataType implements 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
abstract static classAssertions.BaseAssertion
base class for our assertion elements.
static classAssertions.DisabledAssertion
A disabled assertion disables things
static classAssertions.EnabledAssertion
an enabled assertion enables things
Method Summary
voidaddDisable(Assertions.DisabledAssertion assertion)
disable assertions
voidaddEnable(Assertions.EnabledAssertion assertion)
enable assertions
voidapplyAssertions(List commandList)
add the assertions to a list in a format suitable for adding to a command line
voidapplyAssertions(CommandlineJava command)
apply all the assertions to the command.
voidapplyAssertions(ListIterator commandIterator)
add the assertions to a list in a format suitable for adding to a command line
Objectclone()
clone the objects.
voidsetEnableSystemAssertions(Boolean enableSystemAssertions)
enable or disable system assertions
voidsetRefid(Reference ref)
Set the value of the refid attribute.
intsize()
how many assertions are made...will resolve references before returning

Method Detail

addDisable

public void addDisable(Assertions.DisabledAssertion assertion)
disable assertions

Parameters: assertion

addEnable

public void addEnable(Assertions.EnabledAssertion assertion)
enable assertions

Parameters: assertion

applyAssertions

public void applyAssertions(List commandList)
add the assertions to a list in a format suitable for adding to a command line

Parameters: commandList

applyAssertions

public void applyAssertions(CommandlineJava command)
apply all the assertions to the command.

Parameters: command

applyAssertions

public void applyAssertions(ListIterator commandIterator)
add the assertions to a list in a format suitable for adding to a command line

Parameters: commandIterator list of commands

clone

public Object 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.

Returns: a cli

Throws: CloneNotSupportedException

setEnableSystemAssertions

public void setEnableSystemAssertions(Boolean enableSystemAssertions)
enable or disable system assertions

Parameters: enableSystemAssertions

setRefid

public void setRefid(Reference ref)
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

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.