You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2021/11/27 13:41:34 UTC
[commons-vfs] 02/06: Add missing Javadocs and use better parameter names.
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
commit c0e289984b200a239d219dc3e44aa12e2891f6ad
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Nov 27 08:36:37 2021 -0500
Add missing Javadocs and use better parameter names.
---
.../commons/vfs2/events/AbstractFileChangeEvent.java | 17 ++++++++++++++---
.../org/apache/commons/vfs2/events/ChangedEvent.java | 9 +++++++--
.../org/apache/commons/vfs2/events/CreateEvent.java | 9 +++++++--
.../org/apache/commons/vfs2/events/DeleteEvent.java | 9 +++++++--
4 files changed, 35 insertions(+), 9 deletions(-)
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java
index 7db6728..1e9e360 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java
@@ -25,9 +25,20 @@ import org.apache.commons.vfs2.FileObject;
*/
public abstract class AbstractFileChangeEvent extends FileChangeEvent {
- public AbstractFileChangeEvent(final FileObject file) {
- super(file);
+ /**
+ * Constructs a new instance.
+ *
+ * @param fileObject the file object.
+ */
+ public AbstractFileChangeEvent(final FileObject fileObject) {
+ super(fileObject);
}
- public abstract void notify(final FileListener listener) throws Exception;
+ /**
+ * Notifies the given file listener of this event.
+ *
+ * @param fileListener The file listener to notify.
+ * @throws Exception Anything can happen.
+ */
+ public abstract void notify(final FileListener fileListener) throws Exception;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/ChangedEvent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/ChangedEvent.java
index 5445be7..dc05fdd 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/ChangedEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/ChangedEvent.java
@@ -24,8 +24,13 @@ import org.apache.commons.vfs2.FileObject;
*/
public class ChangedEvent extends AbstractFileChangeEvent {
- public ChangedEvent(final FileObject file) {
- super(file);
+ /**
+ * Constructs a new instance.
+ *
+ * @param fileObject the file object.
+ */
+ public ChangedEvent(final FileObject fileObject) {
+ super(fileObject);
}
@Override
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/CreateEvent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/CreateEvent.java
index c428785..cb0429c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/CreateEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/CreateEvent.java
@@ -24,8 +24,13 @@ import org.apache.commons.vfs2.FileObject;
*/
public class CreateEvent extends AbstractFileChangeEvent {
- public CreateEvent(final FileObject file) {
- super(file);
+ /**
+ * Constructs a new instance.
+ *
+ * @param fileObject the file object.
+ */
+ public CreateEvent(final FileObject fileObject) {
+ super(fileObject);
}
@Override
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/DeleteEvent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/DeleteEvent.java
index ef23119..9846a8c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/DeleteEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/DeleteEvent.java
@@ -24,8 +24,13 @@ import org.apache.commons.vfs2.FileObject;
*/
public class DeleteEvent extends AbstractFileChangeEvent {
- public DeleteEvent(final FileObject file) {
- super(file);
+ /**
+ * Constructs a new instance.
+ *
+ * @param fileObject the file object.
+ */
+ public DeleteEvent(final FileObject fileObject) {
+ super(fileObject);
}
@Override