Package org.apache.commons.vfs.tasks
Class AbstractSyncTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.commons.vfs.tasks.VfsTask
org.apache.commons.vfs.tasks.AbstractSyncTask
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
CopyTask
An abstract file synchronization task. Scans a set of source files and
folders, and a destination folder, and performs actions on missing and
out-of-date files. Specifically, performs actions on the following:
- Missing destination file.
- Missing source file.
- Out-of-date destination file.
- Up-to-date destination file.
- Version:
- $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Wed, 29 Nov 2006) $
- Author:
- Adam Murdoch
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Information about a source file. -
Field Summary
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a nestedelement. protected boolean
Check if this task cares about destination files with a missing source file.void
execute()
Executes this task.protected void
handleMissingSourceFile
(FileObject destFile) Handles a destination for which there is no corresponding source file.protected void
handleOutOfDateFile
(FileObject srcFile, FileObject destFile) Handles an out-of-date file (a file where the destination file either doesn't exist, or is older than the source file).protected void
handleUpToDateFile
(FileObject srcFile, FileObject destFile) Handles an up-to-date file (where the destination file exists and is newer than the source file).boolean
Sets whether we should fail if there was an error or notprotected void
void
setDestDir
(String destDir) Sets the destination directory.void
setDestFile
(String destFile) Sets the destination file.void
setFailonerror
(boolean failonerror) Sets whether we should fail if there was an error or notvoid
setIncludes
(String filesList) Sets the files to includesvoid
Sets the source filevoid
Sets the source directoryvoid
setSrcDirIsBase
(boolean srcDirIsBase) Sets whether the source directory should be consider as the base directory.Methods inherited from class org.apache.commons.vfs.tasks.VfsTask
closeManager, resolveFile
Methods inherited from class org.apache.tools.ant.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
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
AbstractSyncTask
public AbstractSyncTask()
-
-
Method Details
-
setDestFile
Sets the destination file. -
setDestDir
Sets the destination directory. -
setSrc
Sets the source file -
setSrcDir
Sets the source directory -
setSrcDirIsBase
public void setSrcDirIsBase(boolean srcDirIsBase) Sets whether the source directory should be consider as the base directory. -
setFailonerror
public void setFailonerror(boolean failonerror) Sets whether we should fail if there was an error or not -
isFailonerror
public boolean isFailonerror()Sets whether we should fail if there was an error or not -
setIncludes
Sets the files to includes -
addConfiguredSrc
public void addConfiguredSrc(AbstractSyncTask.SourceInfo srcInfo) throws org.apache.tools.ant.BuildException Adds a nestedelement. - Throws:
org.apache.tools.ant.BuildException
-
execute
public void execute() throws org.apache.tools.ant.BuildExceptionExecutes this task.- Overrides:
execute
in classorg.apache.tools.ant.Task
- Throws:
org.apache.tools.ant.BuildException
-
logOrDie
-
handleOutOfDateFile
Handles an out-of-date file (a file where the destination file either doesn't exist, or is older than the source file). This implementation does nothing.- Throws:
Exception
-
handleUpToDateFile
Handles an up-to-date file (where the destination file exists and is newer than the source file). This implementation does nothing.- Throws:
Exception
-
handleMissingSourceFile
Handles a destination for which there is no corresponding source file. This implementation does nothing.- Throws:
Exception
-
detectMissingSourceFiles
protected boolean detectMissingSourceFiles()Check if this task cares about destination files with a missing source file. This implementation returns false.
-