Class AssertTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.taskdefs.condition.ConditionBase
org.apache.ant.antunit.AssertTask
All Implemented Interfaces:
Cloneable

public class AssertTask extends org.apache.tools.ant.taskdefs.condition.ConditionBase
Exits the active build, giving an additional message if the single nested condition fails or if there is no condition at all.

This one could as well be implemented as

 <macrodef name="assertTrue">
   <attribute name="message" default="Assertion failed"/>
   <element name="assertion" implicit="true"/>
   <sequential>
     <fail message="@{message}">
       <condition>
         <assertion/>
       </condition>
     </fail>
   </sequential>
 </macrodef>
 

but wouldn't be able to throw a specialized exception that way - and the macrodef would nest the exception in yet another BuildException.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    Message to use when the assertion fails.

    Fields inherited from class org.apache.tools.ant.ProjectComponent

    description, location, project
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    void
    Message to use when the assertion fails.

    Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase

    add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName

    Methods inherited from class org.apache.tools.ant.ProjectComponent

    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • message

      private String message
      Message to use when the assertion fails.
  • Constructor Details

    • AssertTask

      public AssertTask()
  • Method Details

    • setMessage

      public void setMessage(String value)
      Message to use when the assertion fails.
      Parameters:
      value - message to use when the assertion fails
    • execute

      public void execute() throws org.apache.tools.ant.BuildException
      Throws:
      org.apache.tools.ant.BuildException