This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
The following commit(s) were added to refs/heads/master by this push:
new 861188f98 Javadoc: Add missing comments
861188f98 is described below
commit 861188f9844deb673cbc8c61d8ecd2c609beeeaf
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Dec 24 10:35:33 2024 -0500
Javadoc: Add missing comments
---
.../apache/commons/vfs2/tasks/AbstractSyncTask.java | 16 ++++++++++++++++
.../org/apache/commons/vfs2/tasks/CopyTask.java | 13 ++++++++++++-
.../org/apache/commons/vfs2/tasks/DeleteTask.java | 8 ++++++++
.../org/apache/commons/vfs2/tasks/MkdirTask.java | 7 +++++++
.../org/apache/commons/vfs2/tasks/MoveTask.java | 8 ++++++++
.../org/apache/commons/vfs2/tasks/ShowFileTask.java | 7 +++++++
.../org/apache/commons/vfs2/tasks/SyncTask.java | 7 +++++++
.../java/org/apache/commons/vfs2/tasks/VfsTask.java | 7 +++++++
pom.xml | 21 ++++++++++++++++++++-
9 files changed, 92 insertions(+), 2 deletions(-)
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
index 9aaaf1be2..c6b31bf11 100644
---
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
+++
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
@@ -51,12 +51,21 @@ import org.apache.tools.ant.Project;
* </ul>
*/
public abstract class AbstractSyncTask extends VfsTask {
+
/**
* Information about a source file.
*/
public static class SourceInfo {
+
private String file;
+ /**
+ * Constructs a new instance.
+ */
+ public SourceInfo() {
+ // empty
+ }
+
/**
* Sets the file.
*
@@ -75,6 +84,13 @@ public abstract class AbstractSyncTask extends VfsTask {
private String filesList;
+ /**
+ * Constructs a new instance.
+ */
+ public AbstractSyncTask() {
+ // empty
+ }
+
/**
* Adds a nested <src> element.
*
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
index 94d7e3a19..c90132439 100644
--- a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
+++ b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
@@ -32,6 +32,13 @@ public class CopyTask extends AbstractSyncTask {
private boolean overwrite;
private boolean preserveLastModified = true;
+ /**
+ * Constructs a new instance.
+ */
+ public CopyTask() {
+ // empty
+ }
+
/**
* Handles an out-of-date file.
*
@@ -64,6 +71,8 @@ public class CopyTask extends AbstractSyncTask {
}
/**
+ * Tests whether overwrite is enabled.
+ *
* @return the current value of overwrite
*/
public boolean isOverwrite() {
@@ -71,6 +80,8 @@ public class CopyTask extends AbstractSyncTask {
}
/**
+ * Tests whether preserve last modified is enabled.
+ *
* @return the current value of preserveLastModified
*/
public boolean isPreserveLastModified() {
@@ -87,7 +98,7 @@ public class CopyTask extends AbstractSyncTask {
}
/**
- * Enable/disable preserving last modified time of copied files.
+ * Sets preserving last modified time of copied files.
*
* @param preserveLastModified true if the last modified time should be
preserved.
*/
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
index 7372344c8..15121cce0 100644
---
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
+++
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
@@ -29,10 +29,18 @@ import org.apache.tools.ant.BuildException;
* </p>
*/
public class DeleteTask extends VfsTask {
+
private String file;
private String srcDirUrl;
private String filesList;
+ /**
+ * Constructs a new instance.
+ */
+ public DeleteTask() {
+ // empty
+ }
+
/**
* Executes this task.
*
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java
index 2a62d3ccb..a1873508d 100644
---
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java
+++
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java
@@ -28,6 +28,13 @@ public class MkdirTask extends VfsTask {
private String dirName;
+ /**
+ * Constructs a new instance.
+ */
+ public MkdirTask() {
+ // empty
+ }
+
/**
* Executes the task.
*
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
index f924b328c..04951a175 100644
--- a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
+++ b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
@@ -28,8 +28,16 @@ import org.apache.commons.vfs2.Selectors;
* </p>
*/
public class MoveTask extends CopyTask {
+
private boolean tryRename;
+ /**
+ * Constructs a new instance.
+ */
+ public MoveTask() {
+ // empty
+ }
+
/**
* Handles a single source file.
*/
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java
index c86b1ff58..d0375f597 100644
---
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java
+++
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java
@@ -37,6 +37,13 @@ public class ShowFileTask extends VfsTask {
private boolean showContent;
private boolean recursive;
+ /**
+ * Constructs a new instance.
+ */
+ public ShowFileTask() {
+ // empty
+ }
+
/**
* Executes the task.
*
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java
index 220f633cb..1dc1f8529 100644
--- a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java
+++ b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java
@@ -23,6 +23,13 @@ import org.apache.commons.vfs2.FileObject;
*/
public class SyncTask extends CopyTask {
+ /**
+ * Constructs a new instance.
+ */
+ public SyncTask() {
+ // empty
+ }
+
/**
* Check if this task cares about destination files with a missing source
file.
*/
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
index 6090e6cf2..ece0d3553 100644
--- a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
+++ b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
@@ -31,6 +31,13 @@ import org.apache.tools.ant.Task;
*/
public class VfsTask extends Task {
+ /**
+ * Constructs a new instance.
+ */
+ public VfsTask() {
+ // empty
+ }
+
/**
* A commons-logging wrapper for Ant logging.
*/
diff --git a/pom.xml b/pom.xml
index 6fd95269b..8edc7d69a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -314,8 +314,27 @@
<head>To Do:</head>
</tag>
</tags>
- <aggregate>true</aggregate>
</configuration>
+ <reportSets>
+ <reportSet>
+ <id>non-aggregate</id>
+ <configuration>
+ <!-- Specific configuration for the non aggregate report -->
+ </configuration>
+ <reports>
+ <report>javadoc</report>
+ </reports>
+ </reportSet>
+ <reportSet>
+ <id>aggregate</id>
+ <configuration>
+ <!-- Specific configuration for the aggregate report -->
+ </configuration>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ </reportSet>
+ </reportSets>
</plugin>
<plugin>
<groupId>com.github.spotbugs</groupId>
