Package org.apache.tools.ant.taskdefs
Class Touch
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.Task
- 
- org.apache.tools.ant.taskdefs.Touch
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable
 
 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
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static interfaceTouch.DateFormatFactory
 - 
Field SummaryFields Modifier and Type Field Description static Touch.DateFormatFactoryDEFAULT_DF_FACTORYProvides access to DateUtils.EN_US_DATE_FORMAT_MIN (primary) and DateUtils.EN_US_DATE_FORMAT_SEC (fallback).- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description Touch()
 - 
Method SummaryModifier and Type Method Description voidadd(ResourceCollection rc)Add a collection of resources to touch.voidadd(FileNameMapper fileNameMapper)Add aFileNameMapper.voidaddConfiguredMapper(Mapper mapper)Add aMapper.voidaddFilelist(FileList list)Add a filelist to touch.voidaddFileset(FileSet set)Add a set of files to touch.protected voidcheckConfiguration()Check that this task has been configured properly.voidexecute()Execute the touch operation.voidsetDatetime(java.lang.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".voidsetFile(java.io.File file)Sets a single source file to touch.voidsetMillis(long millis)Set the new modification time of file(s) touched in milliseconds since midnight Jan 1 1970.voidsetMkdirs(boolean mkdirs)Set whether nonexistent parent directories should be created when touching new files.voidsetPattern(java.lang.String pattern)Set the format of the datetime attribute.voidsetVerbose(boolean verbose)Set whether the touch task will report every file it creates; defaults totrue.protected voidtouch()Does the actual work; assumes everything has been checked by now.protected voidtouch(java.io.File file)Deprecated.since 1.6.x.- 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Field Detail- 
DEFAULT_DF_FACTORYpublic static final Touch.DateFormatFactory DEFAULT_DF_FACTORY Provides access to DateUtils.EN_US_DATE_FORMAT_MIN (primary) and DateUtils.EN_US_DATE_FORMAT_SEC (fallback).
 
- 
 - 
Method Detail- 
setFilepublic void setFile(java.io.File file) Sets a single source file to touch. If the file does not exist an empty file will be created.- Parameters:
- file- the- Fileto touch.
 
 - 
setMillispublic 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- longtimestamp to use.
 
 - 
setDatetimepublic void setDatetime(java.lang.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- Stringdate in the specified format.
 
 - 
setMkdirspublic void setMkdirs(boolean mkdirs) Set whether nonexistent parent directories should be created when touching new files.- Parameters:
- mkdirs-- booleanwhether to create parent directories.
- Since:
- Ant 1.6.3
 
 - 
setVerbosepublic void setVerbose(boolean verbose) Set whether the touch task will report every file it creates; defaults totrue.- Parameters:
- verbose-- booleanflag.
- Since:
- Ant 1.6.3
 
 - 
setPatternpublic void setPattern(java.lang.String pattern) Set the format of the datetime attribute.- Parameters:
- pattern- the- SimpleDateFormat-compatible format pattern.
- Since:
- Ant 1.6.3
 
 - 
addConfiguredMapperpublic void addConfiguredMapper(Mapper mapper) Add aMapper.- Parameters:
- mapper- the- Mapperto add.
- Since:
- Ant 1.6.3
 
 - 
addpublic void add(FileNameMapper fileNameMapper) throws BuildException Add aFileNameMapper.- Parameters:
- fileNameMapper- the- FileNameMapperto add.
- Throws:
- BuildException- if multiple mappers are added.
- Since:
- Ant 1.6.3
 
 - 
addFilesetpublic void addFileset(FileSet set) Add a set of files to touch.- Parameters:
- set- the- Filesetto add.
 
 - 
addFilelistpublic void addFilelist(FileList list) Add a filelist to touch.- Parameters:
- list- the- Filelistto add.
 
 - 
addpublic void add(ResourceCollection rc) Add a collection of resources to touch.- Parameters:
- rc- the collection to add.
- Since:
- Ant 1.7
 
 - 
checkConfigurationprotected void checkConfiguration() throws BuildExceptionCheck that this task has been configured properly.- Throws:
- BuildException- if configuration errors are detected.
- Since:
- Ant 1.6.3
 
 - 
executepublic void execute() throws BuildExceptionExecute the touch operation.- Overrides:
- executein class- Task
- Throws:
- BuildException- if an error occurs.
 
 - 
touchprotected void touch() throws BuildExceptionDoes the actual work; assumes everything has been checked by now.- Throws:
- BuildException- if an error occurs.
 
 - 
touch@Deprecated protected void touch(java.io.File file) Deprecated.since 1.6.x.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
- Throws:
- BuildException- on error
 
 
- 
 
-