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 0b16557 [VFS-738] Deprecate
org.apache.commons.vfs2.FileChangeEvent.getFile() in favor of getFileObject().
0b16557 is described below
commit 0b165579b539f272b92be6ddce585b15db7f2679
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Mon Oct 7 11:56:14 2019 -0400
[VFS-738] Deprecate org.apache.commons.vfs2.FileChangeEvent.getFile() in
favor of getFileObject().
---
.../org/apache/commons/vfs2/FileChangeEvent.java | 25 +++++++++++++++---
.../commons/vfs2/provider/AbstractFileSystem.java | 6 ++---
.../commons/vfs2/provider/DelegateFileObject.java | 6 ++---
.../apache/commons/vfs2/FileChangeEventTest.java} | 30 +++++++++-------------
.../commons/vfs2/test/ProviderWriteTests.java | 6 ++---
src/changes/changes.xml | 3 +++
6 files changed, 45 insertions(+), 31 deletions(-)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
index 6b08f1e..0dac678 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
@@ -24,18 +24,35 @@ public class FileChangeEvent {
/**
* The file object
*/
- private final FileObject file;
+ private final FileObject fileObject;
- public FileChangeEvent(final FileObject file) {
- this.file = file;
+ /**
+ * Constructs a new instance.
+ *
+ * @param fileObject the file object.
+ */
+ public FileChangeEvent(final FileObject fileObject) {
+ this.fileObject = fileObject;
}
/**
* Returns the file that changed.
*
* @return The FileObject that was changed.
+ * @deprecated Use {@link #getFileObject()}.
*/
+ @Deprecated
public FileObject getFile() {
- return file;
+ return fileObject;
+ }
+
+ /**
+ * Returns the file that changed.
+ *
+ * @return The FileObject that was changed.
+ * @since 2.5.0
+ */
+ public FileObject getFileObject() {
+ return fileObject;
}
}
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
index 6f538e5..a48ea38 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
@@ -535,10 +535,10 @@ public abstract class AbstractFileSystem extends
AbstractVfsComponent implements
*/
private void fireEvent(final AbstractFileChangeEvent event) {
FileListener[] fileListeners = null;
- final FileObject file = event.getFile();
+ final FileObject fileObject = event.getFileObject();
synchronized (listenerMap) {
- final ArrayList<?> listeners = listenerMap.get(file.getName());
+ final ArrayList<?> listeners =
listenerMap.get(fileObject.getName());
if (listeners != null) {
fileListeners = listeners.toArray(new
FileListener[listeners.size()]);
}
@@ -549,7 +549,7 @@ public abstract class AbstractFileSystem extends
AbstractVfsComponent implements
try {
event.notify(fileListener);
} catch (final Exception e) {
- final String message =
Messages.getString("vfs.provider/notify-listener.warn", file);
+ final String message =
Messages.getString("vfs.provider/notify-listener.warn", fileObject);
// getLogger().warn(message, e);
VfsLog.warn(getLogger(), LOG, message, e);
}
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
index 4e414c9..8d60dae 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
@@ -299,7 +299,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
*/
@Override
public void fileCreated(final FileChangeEvent event) throws Exception {
- if (event.getFile() != file) {
+ if (event.getFileObject() != file) {
return;
}
if (!ignoreEvent) {
@@ -315,7 +315,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
*/
@Override
public void fileDeleted(final FileChangeEvent event) throws Exception {
- if (event.getFile() != file) {
+ if (event.getFileObject() != file) {
return;
}
if (!ignoreEvent) {
@@ -334,7 +334,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
*/
@Override
public void fileChanged(final FileChangeEvent event) throws Exception {
- if (event.getFile() != file) {
+ if (event.getFileObject() != file) {
return;
}
if (!ignoreEvent) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileChangeEventTest.java
similarity index 63%
copy from
commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
copy to
commons-vfs2/src/test/java/org/apache/commons/vfs2/FileChangeEventTest.java
index 6b08f1e..54a0b68 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
+++
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileChangeEventTest.java
@@ -14,28 +14,22 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
package org.apache.commons.vfs2;
-/**
- * An event fired when a file is changed.
- */
-public class FileChangeEvent {
+import java.io.File;
- /**
- * The file object
- */
- private final FileObject file;
+import org.junit.Assert;
+import org.junit.Test;
- public FileChangeEvent(final FileObject file) {
- this.file = file;
- }
+public class FileChangeEventTest {
- /**
- * Returns the file that changed.
- *
- * @return The FileObject that was changed.
- */
- public FileObject getFile() {
- return file;
+ @Test
+ public void testFileObject() throws FileSystemException {
+ try (final FileObject baseFile = VFS.getManager().toFileObject(new
File("."))) {
+ Assert.assertNotNull(baseFile);
+ final FileChangeEvent fileChangeEvent = new
FileChangeEvent(baseFile);
+ Assert.assertEquals(fileChangeEvent.getFile(),
fileChangeEvent.getFileObject());
+ }
}
}
diff --git
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/test/ProviderWriteTests.java
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/test/ProviderWriteTests.java
index 9a8e0fe..4c34269 100644
---
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/test/ProviderWriteTests.java
+++
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/test/ProviderWriteTests.java
@@ -588,7 +588,7 @@ public class ProviderWriteTests extends
AbstractProviderTestCase {
public void fileCreated(final FileChangeEvent event) {
assertTrue("Unexpected create event", events.size() > 0);
assertSame("Expecting a create event", CREATE, events.remove(0));
- assertEquals(file, event.getFile());
+ assertEquals(file, event.getFileObject());
try {
assertTrue(file.exists());
} catch (final FileSystemException e) {
@@ -603,7 +603,7 @@ public class ProviderWriteTests extends
AbstractProviderTestCase {
public void fileDeleted(final FileChangeEvent event) {
assertTrue("Unexpected delete event", events.size() > 0);
assertSame("Expecting a delete event", DELETE, events.remove(0));
- assertEquals(file, event.getFile());
+ assertEquals(file, event.getFileObject());
try {
assertTrue(!file.exists());
} catch (final FileSystemException e) {
@@ -615,7 +615,7 @@ public class ProviderWriteTests extends
AbstractProviderTestCase {
public void fileChanged(final FileChangeEvent event) throws Exception {
assertTrue("Unexpected changed event", events.size() > 0);
assertSame("Expecting a changed event", CHANGED, events.remove(0));
- assertEquals(file, event.getFile());
+ assertEquals(file, event.getFileObject());
try {
assertTrue(!file.exists());
} catch (final FileSystemException e) {
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 6ec8a51..f0e3b21 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -92,6 +92,9 @@ The <action> type attribute can be add,update,fix,remove.
<action issue="VFS-733" dev="ggregory" type="fix" due-to="Falco, Gary
Gregory, Bruno P. Kinoshita">
Parent layer of ZipFileSystem set to null through
OnCallRefreshFileObject and DecoratedFileObject.refresh().
</action>
+ <action issue="VFS-738" dev="ggregory" type="add" due-to="Gary Gregory">
+ Deprecate org.apache.commons.vfs2.FileChangeEvent.getFile() in favor
of getFileObject().
+ </action>
</release>
<release version="2.4.1" date="2019-08-10" description="Bug fix release.">
<action issue="VFS-725" dev="ggregory" type="fix" due-to="Gary Gregory">
