org.apache.tools.ant.taskdefs

Class Touch


public class Touch
extends Task

Touch a file and/or fileset(s) and/or filelist(s); corresponds to the Unix touch command.

If the file to touch doesn't exist, an empty one is created.

Since:
Ant 1.1

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

Constructor Summary

Touch()
Construct a new Touch task.

Method Summary

void
add(FileNameMapper fileNameMapper)
Add a FileNameMapper.
void
addConfiguredMapper(Mapper mapper)
Add a Mapper.
void
addFilelist(FileList list)
Add a filelist to touch.
void
addFileset(FileSet set)
Add a set of files to touch.
protected void
checkConfiguration()
Check that this task has been configured properly.
void
execute()
Execute the touch operation.
void
setDatetime(String dateTime)
Set the new modification time of file(s) touched in the format "MM/DD/YYYY HH:MM AM or PM" or "MM/DD/YYYY HH:MM:SS AM or PM".
void
setFile(File file)
Sets a single source file to touch.
void
setMillis(long millis)
Set the new modification time of file(s) touched in milliseconds since midnight Jan 1 1970.
void
setMkdirs(boolean mkdirs)
Set whether nonexistent parent directories should be created when touching new files.
void
setPattern(String pattern)
Set the format of the datetime attribute.
void
setVerbose(boolean verbose)
Set whether the touch task will report every file it creates; defaults to true.
protected void
touch()
Does the actual work; assumes everything has been checked by now.
protected void
touch(File file)
Deprecated.

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

Constructor Details

Touch

public Touch()
Construct a new Touch task.

Method Details

add

public void add(FileNameMapper fileNameMapper)
            throws BuildException
Add a FileNameMapper.
Parameters:
fileNameMapper - the FileNameMapper to add.
Throws:
BuildException - if multiple mappers are added.
Since:
Ant 1.6.3

addConfiguredMapper

public void addConfiguredMapper(Mapper mapper)
Add a Mapper.
Parameters:
mapper - the Mapper to add.
Since:
Ant 1.6.3

addFilelist

public void addFilelist(FileList list)
Add a filelist to touch.
Parameters:
list - the Filelist to add.

addFileset

public void addFileset(FileSet set)
Add a set of files to touch.
Parameters:
set - the Fileset to add.

checkConfiguration

protected void checkConfiguration()
            throws BuildException
Check that this task has been configured properly.
Throws:
BuildException - if configuration errors are detected.
Since:
Ant 1.6.3

execute

public void execute()
            throws BuildException
Execute the touch operation.
Overrides:
execute in interface Task
Throws:
BuildException - if an error occurs.

setDatetime

public void setDatetime(String dateTime)
Set the new modification time of file(s) touched in the format "MM/DD/YYYY HH:MM AM or PM" or "MM/DD/YYYY HH:MM:SS AM or PM". Optional, default=now.
Parameters:
dateTime - the String date in the specified format.

setFile

public void setFile(File file)
Sets a single source file to touch. If the file does not exist an empty file will be created.
Parameters:
file - the File to touch.

setMillis

public void setMillis(long millis)
Set the new modification time of file(s) touched in milliseconds since midnight Jan 1 1970. Optional, default=now.
Parameters:
millis - the long timestamp to use.

setMkdirs

public void setMkdirs(boolean mkdirs)
Set whether nonexistent parent directories should be created when touching new files.
Parameters:
mkdirs - boolean whether to create parent directories.
Since:
Ant 1.6.3

setPattern

public void setPattern(String pattern)
Set the format of the datetime attribute.
Parameters:
pattern - the SimpleDateFormat-compatible format pattern.
Since:
Ant 1.6.3

setVerbose

public void setVerbose(boolean verbose)
Set whether the touch task will report every file it creates; defaults to true.
Parameters:
verbose - boolean flag.
Since:
Ant 1.6.3

touch

protected void touch()
            throws BuildException
Does the actual work; assumes everything has been checked by now.
Throws:
BuildException - if an error occurs.

touch

protected void touch(File file)

Deprecated.

Touch a single file with the current timestamp (this.millis). This method does not interact with any nested mappers and remains for reasons of backwards-compatibility only.
Parameters:
file - file to touch

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