| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Sync
public class Sync
Synchronize a local target directory from the files defined in one or more filesets.
Uses a <copy> task internally, but forbidding the use of mappers and filter chains. Files of the destination directory not present in any of the source fileset are removed.
| Nested Class Summary | |
|---|---|
| static class | Sync.MyCopySubclass Copy in order to access it's file/dir maps. | 
| static class | Sync.SyncTargetInner class used to hold exclude patterns and selectors to save stuff that happens to live in the target directory but should not get removed. | 
| 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 | |
|---|---|
| Sync() | |
| Method Summary | |
|---|---|
|  void | add(ResourceCollection rc)Adds a collection of filesystem resources to copy. | 
|  void | addFileset(FileSet set)Adds a set of files to copy. | 
|  void | addPreserveInTarget(Sync.SyncTarget s)A container for patterns and selectors that can be used to specify files that should be kept in the target even if they are not present in any source directory. | 
|  void | execute()Execute the sync task. | 
|  void | init()Initialize the sync task. | 
|  void | setFailOnError(boolean failonerror)If false, note errors to the output but keep going. | 
|  void | setGranularity(long granularity)The number of milliseconds leeway to give before deciding a target is out of date. | 
|  void | setIncludeEmptyDirs(boolean includeEmpty)Used to copy empty directories. | 
|  void | setOverwrite(boolean overwrite)Overwrite any existing destination file(s). | 
|  void | setTodir(java.io.File destDir)Sets the destination directory. | 
|  void | setVerbose(boolean verbose)Used to force listing of all names of copied files. | 
| Methods inherited from class org.apache.tools.ant.Task | 
|---|
| bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, 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 | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public Sync()
| Method Detail | 
|---|
public void init()
          throws BuildException
init in class TaskBuildException - if there is a problem.Task.init()
public void execute()
             throws BuildException
execute in class TaskBuildException - if there is an error.Task.execute()public void setTodir(java.io.File destDir)
destDir - the destination directorypublic void setVerbose(boolean verbose)
verbose - if true force listing of all names of copied files.public void setOverwrite(boolean overwrite)
overwrite - if true overwrite any existing destination file(s).public void setIncludeEmptyDirs(boolean includeEmpty)
includeEmpty - If true copy empty directories.public void setFailOnError(boolean failonerror)
failonerror - true or falsepublic void addFileset(FileSet set)
set - a filesetpublic void add(ResourceCollection rc)
rc - a resource collectionpublic void setGranularity(long granularity)
Default is 0 milliseconds, or 2 seconds on DOS systems.
granularity - a long valuepublic void addPreserveInTarget(Sync.SyncTarget s)
You must not invoke this method more than once.
s - a preserveintarget nested element| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||