Class UpToDate

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.UpToDate

All Implemented Interfaces:

Cloneable, Condition

public class UpToDate
extends Task
implements Condition

Sets the given property if the specified target has a timestamp greater than all of the source files.

Since:

Ant 1.2

Field Summary

Fields

Modifier and Type	Field	Description
protected Mapper	mapperElement

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
UpToDate()

Method Summary

Modifier and Type	Method	Description
void	add(FileNameMapper fileNameMapper)	A nested filenamemapper
void	addSrcfiles(FileSet fs)	Nested <srcfiles> element.
Mapper	createMapper()	Defines the FileNameMapper to use (nested mapper element).
Union	createSrcResources()	Nested resource collections as sources.
boolean	eval()	Evaluate (all) target and source file(s) to see if the target(s) is/are up-to-date.
void	execute()	Sets property to true if target file(s) have a more recent timestamp than (each of) the corresponding source file(s).
protected boolean	scanDir(File srcDir, String[] files)	Scan a directory for files to check for "up to date"ness
void	setProperty(String property)	The property to set if the target file is more up-to-date than (each of) the source file(s).
void	setSrcfile(File file)	The file that must be older than the target file if the property is to be set.
void	setTargetFile(File file)	The file which must be more up-to-date than (each of) the source file(s) if the property is to be set.
void	setValue(String value)	The value to set the named property to if the target file is more up-to-date than (each of) the source file(s).

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

Field Details

mapperElement

protected Mapper mapperElement

Constructor Details

UpToDate

public UpToDate()

Method Details

setProperty

public void setProperty(String property)

The property to set if the target file is more up-to-date than (each of) the source file(s).

Parameters:

property - the name of the property to set if Target is up-to-date.

setValue

public void setValue(String value)

The value to set the named property to if the target file is more up-to-date than (each of) the source file(s). Defaults to 'true'.

Parameters:

value - the value to set the property to if Target is up-to-date

setTargetFile

public void setTargetFile(File file)

The file which must be more up-to-date than (each of) the source file(s) if the property is to be set.

Parameters:

file - the file we are checking against.

setSrcfile

public void setSrcfile(File file)

The file that must be older than the target file if the property is to be set.

Parameters:

file - the file we are checking against the target file.

addSrcfiles

public void addSrcfiles(FileSet fs)

Nested <srcfiles> element.

Parameters:

fs - the source files

createSrcResources

public Union createSrcResources()

Nested resource collections as sources.

Returns:

the source resources to configure.

Since:

Ant 1.7

createMapper

public Mapper createMapper()
                    throws BuildException

Defines the FileNameMapper to use (nested mapper element).

Returns:

a mapper to be configured

Throws:

BuildException - if more than one mapper is defined

add

public void add(FileNameMapper fileNameMapper)

A nested filenamemapper

Parameters:

fileNameMapper - the mapper to add

Since:

Ant 1.6.3

eval

public boolean eval()

Evaluate (all) target and source file(s) to see if the target(s) is/are up-to-date.

Specified by:

eval in interface Condition

Returns:

true if the target(s) is/are up-to-date

execute

public void execute()
             throws BuildException

Sets property to true if target file(s) have a more recent timestamp than (each of) the corresponding source file(s).

Overrides:

execute in class Task

Throws:

BuildException - on error

scanDir

protected boolean scanDir(File srcDir,
 String[] files)

Scan a directory for files to check for "up to date"ness

Parameters:

srcDir - the directory

files - the files to scan for

Returns:

true if the files are up to date