org.apache.tools.ant.taskdefs

Class Exit


public class Exit
extends Task

Exits the active build, giving an additional message if available. The if and unless attributes make the failure conditional -both probe for the named property being defined. The if tests for the property being defined, the unless for a property being undefined. If both attributes are set, then the test fails only if both tests are true. i.e.
fail := defined(ifProperty) && !defined(unlessProperty)
A single nested<condition> element can be specified instead of using if/unless (a combined effect can be achieved using isset conditions).

Since:
Ant 1.2

Field Summary

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

void
addText(String msg)
Set a multiline message.
ConditionBase
createCondition()
Add a condition element.
void
execute()
Throw a BuildException to exit (fail) the build.
void
setIf(String c)
Only fail if a property of the given name exists in the current project.
void
setMessage(String value)
A message giving further information on why the build exited.
void
setStatus(int i)
Set the status code to associate with the thrown Exception.
void
setUnless(String c)
Only fail if a property of the given name does not exist in the current project.

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

Method Details

addText

public void addText(String msg)
Set a multiline message.

Parameters:
msg - the message to display


createCondition

public ConditionBase createCondition()
Add a condition element.

Returns:
ConditionBase.

Since:
Ant 1.6.2


execute

public void execute()
            throws BuildException
Throw a BuildException to exit (fail) the build. If specified, evaluate conditions: A single nested condition is accepted, but requires that the if/unless attributes be omitted. If the nested condition evaluates to true, or the ifCondition is true or unlessCondition is false, the build will exit. The error message is constructed from the text fields, from the nested condition (if specified), or finally from the if and unless parameters (if present).
Overrides:
execute in interface Task

Throws:
BuildException - on error


setIf

public void setIf(String c)
Only fail if a property of the given name exists in the current project.

Parameters:
c - property name


setMessage

public void setMessage(String value)
A message giving further information on why the build exited.

Parameters:
value - message to output


setStatus

public void setStatus(int i)
Set the status code to associate with the thrown Exception.

Parameters:
i - the int status


setUnless

public void setUnless(String c)
Only fail if a property of the given name does not exist in the current project.

Parameters:
c - property name


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