Class AntVersion

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.condition.AntVersion

All Implemented Interfaces:

Cloneable, Condition

public class AntVersion
extends Task
implements Condition

An Ant version condition.

Since:

Ant 1.7

Field Summary

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
AntVersion()

Method Summary

Modifier and Type	Method	Description
boolean	eval()	Evaluate the condition.
void	execute()	Run as a task.
String	getAtLeast()	Get the atleast attribute.
String	getExactly()	Get the exactly attribute.
String	getProperty()	Get the name of the property to hold the ant version.
void	setAtLeast(String atLeast)	Set the atleast attribute.
void	setExactly(String exactly)	Set the exactly attribute.
void	setProperty(String propertyname)	Set the name of the property to hold the ant version.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

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

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AntVersion

public AntVersion()

Method Details

execute

public void execute()
             throws BuildException

Run as a task.

Overrides:

execute in class Task

Throws:

BuildException - if an error occurs.

eval

public boolean eval()
             throws BuildException

Evaluate the condition.

Specified by:

eval in interface Condition

Returns:

true if the condition is true.

Throws:

BuildException - if an error occurs.

getAtLeast

public String getAtLeast()

Get the atleast attribute.

Returns:

the atleast attribute.

setAtLeast

public void setAtLeast(String atLeast)

Set the atleast attribute. This is of the form major.minor.point. For example 1.7.0.

Parameters:

atLeast - the version to check against.

getExactly

public String getExactly()

Get the exactly attribute.

Returns:

the exactly attribute.

setExactly

public void setExactly(String exactly)

Set the exactly attribute. This is of the form major.minor.point. For example 1.7.0.

Parameters:

exactly - the version to check against.

getProperty

public String getProperty()

Get the name of the property to hold the ant version.

Returns:

the name of the property.

setProperty

public void setProperty(String propertyname)

Set the name of the property to hold the ant version.

Parameters:

propertyname - the name of the property.