peterreilly 2005/01/06 04:06:41
Modified: src/main/org/apache/tools/ant/taskdefs Sync.java
Log:
javadoc
Revision Changes Path
1.18 +25 -2 ant/src/main/org/apache/tools/ant/taskdefs/Sync.java
Index: Sync.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Sync.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- Sync.java 6 Jan 2005 11:55:03 -0000 1.17
+++ Sync.java 6 Jan 2005 12:06:41 -0000 1.18
@@ -56,6 +56,9 @@
private MyCopy myCopy;
// Override Task#init
+ /**
+ * @see Task#init()
+ */
public void init()
throws BuildException {
// Instantiate it
@@ -76,6 +79,9 @@
}
// Override Task#execute
+ /**
+ * @see Task#execute()
+ */
public void execute()
throws BuildException {
// The destination of the files to copy
@@ -224,6 +230,7 @@
/**
* Sets the destination directory.
+ * @param destDir the destination directory
*/
public void setTodir(File destDir) {
myCopy.setTodir(destDir);
@@ -231,6 +238,7 @@
/**
* Used to force listing of all names of copied files.
+ * @param verbose if true force listing of all names of copied files.
*/
public void setVerbose(boolean verbose) {
myCopy.setVerbose(verbose);
@@ -238,6 +246,7 @@
/**
* Overwrite any existing destination file(s).
+ * @param overwrite if true overwrite any existing destination file(s).
*/
public void setOverwrite(boolean overwrite) {
myCopy.setOverwrite(overwrite);
@@ -245,6 +254,7 @@
/**
* Used to copy empty directories.
+ * @param includeEmpty If true copy empty directories.
*/
public void setIncludeEmptyDirs(boolean includeEmpty) {
myCopy.setIncludeEmptyDirs(includeEmpty);
@@ -260,6 +270,7 @@
/**
* Adds a set of files to copy.
+ * @param set a fileset
*/
public void addFileset(FileSet set) {
myCopy.addFileset(set);
@@ -270,7 +281,7 @@
* target is out of date.
*
* <p>Default is 0 milliseconds, or 2 seconds on DOS systems.</p>
- *
+ * @param granularity a <code>long</code> value
* @since Ant 1.6.2
*/
public void setGranularity(long granularity) {
@@ -286,9 +297,13 @@
// fact that they are newer or not than the destination.
private Set nonOrphans = new HashSet();
+ /** Constructor for MyCopy. */
public MyCopy() {
}
+ /**
+ * @see Copy#scan(File, File, String[], String[])
+ */
protected void scan(File fromDir, File toDir, String[] files,
String[] dirs) {
assertTrue("No mapper", mapperElement == null);
@@ -303,10 +318,18 @@
}
}
+ /**
+ * Get the destination directory.
+ * @return the destination directory
+ */
public File getToDir() {
return destDir;
}
+ /**
+ * Get the includeEmptyDirs attribute.
+ * @return true if emptyDirs are to be included
+ */
public boolean getIncludeEmptyDirs() {
return includeEmpty;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
