Class Move


public class Move
extends Copy

Moves a file or directory to a new file or directory. By default, the destination file is overwritten if it already exists. When overwrite is turned off, then files are only moved if the source file is newer than the destination file, or when the destination file does not exist.

Source files and directories are only deleted when the file or directory has been copied to the destination successfully. Filtering also works.

This implementation is based on Arnout Kuiper's initial design document, the following mailing list discussions, and the copyfile/copydir tasks.

Ant 1.2

Field Summary
Fields inherited from class
completeDirMap, destDir, destFile, dirCopyMap, failonerror, file, fileCopyMap, filesets, filtering, flatten, forceOverwrite, includeEmpty, mapperElement, preserveLastModified, verbosity
Fields inherited from class
description, location, target, taskName, taskType, wrapper
Fields inherited from class
Constructor Summary
          Constructor of object.
Method Summary
protected  void deleteDir( d)
          Go and delete the directory tree.
protected  void doFileOperations()
          Override copy's doFileOperations to move the files instead of copying them.
 void execute()
          Performs the move operation.
protected  boolean okToDelete( d)
          Its only ok to delete a directory tree if there are no files in it.
protected  boolean renameFile( sourceFile, destFile, boolean filtering, boolean overwrite)
          Attempts to rename a file from a source to a destination.
Methods inherited from class
add, addFileset, buildMap, createFilterChain, createFilterSet, createMapper, getEncoding, getFileUtils, getFilterChains, getFilterSets, getOutputEncoding, getPreserveLastModified, isEnableMultipleMapping, scan, setEnableMultipleMappings, setEncoding, setFailOnError, setFile, setFiltering, setFlatten, setGranularity, setIncludeEmptyDirs, setOutputEncoding, setOverwrite, setPreserveLastModified, setPreserveLastModified, setTodir, setTofile, setVerbose, validateAttributes
Methods inherited from class
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
getProject, setProject
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public Move()
Constructor of object. This sets the forceOverwrite attribute of the Copy parent class to true.

Method Detail


public void execute()
             throws BuildException
Performs the move operation.

execute in class Copy
BuildException - if an error occurs


protected void doFileOperations()
Override copy's doFileOperations to move the files instead of copying them.

doFileOperations in class Copy


protected boolean okToDelete( d)
Its only ok to delete a directory tree if there are no files in it.

d - the directory to check
true if a deletion can go ahead


protected void deleteDir( d)
Go and delete the directory tree.

d - the directory to delete


protected boolean renameFile( sourceFile,
                             boolean filtering,
                             boolean overwrite)
Attempts to rename a file from a source to a destination. If overwrite is set to true, this method overwrites existing file even if the destination file is newer. Otherwise, the source file is renamed only if the destination file is older than it. Method then checks if token filtering is used. If it is, this method returns false assuming it is the responsibility to the copyFile method.

sourceFile - the file to rename
destFile - the destination file
filtering - if true, filtering is in operation, file will be copied/deleted instead of renamed
overwrite - if true force overwrite even if destination file is newer than source file
true if the file was renamed
Throws: - if an error occurs
BuildException - if an error occurs

Copyright 2000-2005 Apache Software Foundation. All Rights Reserved.