Apache Ant 1.10.14 · org.apache.tools.ant.taskdefs.Exit

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).

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Exit.NestedCondition

Field Summary

Modifier and Type	Field and Description
private Object	ifCondition
private String	message
private Exit.NestedCondition	nestedCondition
private Integer	status
private Object	unlessCondition

Inherited from org.apache.tools.ant.Task:: target taskName taskType wrapper

Constructor Summary

Access	Constructor and Description
public	Exit()

Method Summary

Modifier and Type	Method and Description
public void	addText(String the message to display msg) Set a multiline message.
public ConditionBase	Returns: `ConditionBase`. createCondition() Add a condition element.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Throw a `BuildException` to exit (fail) the build.
private boolean	isNullOrEmpty(Object value)
private boolean	Returns: `boolean`. nestedConditionPresent() test whether there is a nested condition.
public void	setIf(Object property name or evaluated expression c) Only fail if the given expression evaluates to true or the name of an existing property.
public void	setIf(String property name or evaluated expression c) Only fail if the given expression evaluates to true or the name of an existing property.
public void	setMessage(String message to output value) A message giving further information on why the build exited.
public void	setStatus(int the `int` status i) Set the status code to associate with the thrown Exception.
public void	setUnless(Object property name or evaluated expression c) Only fail if the given expression evaluates to false or tno property of the given name exists.
public void	setUnless(String property name or evaluated expression c) Only fail if the given expression evaluates to false or tno property of the given name exists.
private boolean	Returns: true if there is no if condition, or the named property exists testIfCondition() test the if condition
private boolean	Returns: true if there is none, or it evaluates to true testNestedCondition() test the nested condition
private boolean	Returns: true if there is no unless condition, or there is a named property but it doesn't exist testUnlessCondition() test the unless condition

Field Detail

ifCondition	back to summary
private Object ifCondition

message	back to summary
private String message

nestedCondition	back to summary
private Exit.NestedCondition nestedCondition

status	back to summary
private Integer status

unlessCondition	back to summary
private Object unlessCondition

Constructor Detail

Exit	back to summary
public Exit()

Method Detail

addText	back to summary
public void addText(String msg) Set a multiline message. Parameters msg:String the message to display

addText

back to summary

public void addText(String msg)

Set a multiline message.

Parameters

msg:String: the message to display

createCondition back to summary

createCondition	back to summary
public ConditionBase createCondition() Add a condition element. Returns:ConditionBase `ConditionBase`. Since Ant 1.6.2

public ConditionBase createCondition()

Add a condition element.

Returns:ConditionBase: ConditionBase.
Since: Ant 1.6.2

execute back to summary

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. 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). Annotations @Override Exceptions BuildException: on error

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

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).

Annotations

@Override

Exceptions

BuildException:: on error

isNullOrEmpty	back to summary
private boolean isNullOrEmpty(Object value)

nestedConditionPresent back to summary

nestedConditionPresent	back to summary
private boolean nestedConditionPresent() test whether there is a nested condition. Returns:boolean `boolean`.

private boolean nestedConditionPresent()

test whether there is a nested condition.

Returns:boolean: boolean.

setIf	back to summary
public void setIf(Object c) Only fail if the given expression evaluates to true or the name of an existing property. Parameters c:Object property name or evaluated expression Since Ant 1.8.0

setIf

back to summary

public void setIf(Object c)

Only fail if the given expression evaluates to true or the name of an existing property.

Parameters

c:Object: property name or evaluated expression

Since

Ant 1.8.0

setIf	back to summary
public void setIf(String c) Only fail if the given expression evaluates to true or the name of an existing property. Parameters c:String property name or evaluated expression

setIf

back to summary

public void setIf(String c)

Only fail if the given expression evaluates to true or the name of an existing property.

Parameters

c:String: property name or evaluated expression

setMessage	back to summary
public void setMessage(String value) A message giving further information on why the build exited. Parameters value:String message to output

setMessage

back to summary

public void setMessage(String value)

A message giving further information on why the build exited.

Parameters

value:String: message to output

setStatus back to summary

setStatus	back to summary
public void setStatus(int i) Set the status code to associate with the thrown Exception. Parameters i:int the `int` status

public void setStatus(int i)

Set the status code to associate with the thrown Exception.

Parameters

i:int: the int status

setUnless	back to summary
public void setUnless(Object c) Only fail if the given expression evaluates to false or tno property of the given name exists. Parameters c:Object property name or evaluated expression Since Ant 1.8.0

setUnless

back to summary

public void setUnless(Object c)

Only fail if the given expression evaluates to false or tno property of the given name exists.

Parameters

c:Object: property name or evaluated expression

Since

Ant 1.8.0

setUnless	back to summary
public void setUnless(String c) Only fail if the given expression evaluates to false or tno property of the given name exists. Parameters c:String property name or evaluated expression

setUnless

back to summary

public void setUnless(String c)

Only fail if the given expression evaluates to false or tno property of the given name exists.

Parameters

c:String: property name or evaluated expression

testIfCondition	back to summary
private boolean testIfCondition() test the if condition Returns:boolean true if there is no if condition, or the named property exists

testIfCondition

back to summary

private boolean testIfCondition()

test the if condition

Returns:boolean: true if there is no if condition, or the named property exists

testNestedCondition	back to summary
private boolean testNestedCondition() test the nested condition Returns:boolean true if there is none, or it evaluates to true

testNestedCondition

back to summary

private boolean testNestedCondition()

test the nested condition

Returns:boolean: true if there is none, or it evaluates to true

testUnlessCondition	back to summary
private boolean testUnlessCondition() test the unless condition Returns:boolean true if there is no unless condition, or there is a named property but it doesn't exist

testUnlessCondition

back to summary

private boolean testUnlessCondition()

test the unless condition

Returns:boolean: true if there is no unless condition, or there is a named property but it doesn't exist

public Class Exit

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Exit.NestedCondition

Constructor Summary

Method Summary

Constructor Detail

Method Detail