Introduction

This document lists changes made to the MasterFileSystem API.

Index of APIs

MasterFileSystem API

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

(Mar 2 '12) fileLocked method can throw IOException
(Jan 8 '08) Fileobject instances are not issued after external changes
(Jan 8 '08) Simplify MasterFS, do not delegate on other embedded FS

All changes by date

(Jan 11 '13) A property to suspend native listeners
(Mar 2 '12) fileLocked method can throw IOException
(Dec 31 '11) External change notifiers in separate modules
(Feb 1 '11) Determine if a ProvidedExtensions instance should be used to get a files canWrite() value
(Aug 27 '10) Delegate FileObject.copy() to ProvidedExtensions
(Jun 22 '10) Guaranteed event order when deleting and creating files and new calls in ProvidedExtensions
(May 12 '10) ProvidedExtensions.priorityIO to suspend background refresh
(Apr 16 '10) ProvidedExtensions.refreshRecursively was added.
(Mar 20 '08) ProvidedExtensions.canWrite was added.
(Jan 8 '08) Fileobject instances are not issued after external changes
(Jan 8 '08) Simplify MasterFS, do not delegate on other embedded FS
(Jun 15 '07) ProvidedExtensions.fileLock and ProvidedExtensions.fileUnlock was added.
(Feb 12 '07) ProvidedExtensions.beforeChange was added.
(Aug 8 '06) ProvidedExtensions.getDeleteHandler was added.
(Apr 24 '06) ProvidedExtensions was added.

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.masterfs > 1.20

(2.42) A property to suspend native listeners
(2.37) fileLocked method can throw IOException
(2.36) External change notifiers in separate modules
(2.30) Determine if a ProvidedExtensions instance should be used to get a files canWrite() value
(2.28) Delegate FileObject.copy() to ProvidedExtensions
(2.27) Guaranteed event order when deleting and creating files and new calls in ProvidedExtensions
(2.25) ProvidedExtensions.priorityIO to suspend background refresh
(2.24) ProvidedExtensions.refreshRecursively was added.
(2.14) ProvidedExtensions.canWrite was added.
(2.13) Fileobject instances are not issued after external changes
(2.13) Simplify MasterFS, do not delegate on other embedded FS
(1.11) ProvidedExtensions.fileLock and ProvidedExtensions.fileUnlock was added.
(1.10) ProvidedExtensions.beforeChange was added.
(1.9) ProvidedExtensions.getDeleteHandler was added.
(1.9) ProvidedExtensions was added.

Changes by affected class

`org.netbeans.modules.masterfs.providers.AutoMountProvider`

(Jan 8 '08) Simplify MasterFS, do not delegate on other embedded FS

`org.netbeans.modules.masterfs.providers.FileSystemProvider`

(Jan 8 '08) Simplify MasterFS, do not delegate on other embedded FS

`org.netbeans.modules.masterfs.providers.MountSupport`

(Jan 8 '08) Simplify MasterFS, do not delegate on other embedded FS

`org.netbeans.modules.masterfs.providers.Notifier`

(Dec 31 '11) External change notifiers in separate modules

`org.netbeans.modules.masterfs.providers.ProvidedExtensions`

(Mar 2 '12) fileLocked method can throw IOException
(Feb 1 '11) Determine if a ProvidedExtensions instance should be used to get a files canWrite() value
(Aug 27 '10) Delegate FileObject.copy() to ProvidedExtensions
(Jun 22 '10) Guaranteed event order when deleting and creating files and new calls in ProvidedExtensions
(May 12 '10) ProvidedExtensions.priorityIO to suspend background refresh
(Apr 16 '10) ProvidedExtensions.refreshRecursively was added.
(Jun 15 '07) ProvidedExtensions.fileLock and ProvidedExtensions.fileUnlock was added.
(Feb 12 '07) ProvidedExtensions.beforeChange was added.
(Aug 8 '06) ProvidedExtensions.getDeleteHandler was added.
(Apr 24 '06) ProvidedExtensions was added.

Details of all changes by API and date

MasterFileSystem API

A property to suspend native listeners

Jan 11 '13; API spec. version: 2.42; made by: jtulach; issues: #222193
A way to temporarily suspend native listeners.

fileLocked method can throw `IOException`

Mar 2 '12; API spec. version: 2.37; affected top-level classes: ProvidedExtensions; made by: jtulach; issues: #208657
Changing the fileLocked method to throw IOException is source incompatible, but binary compatible. As masterfs friends are always compiled at the same time as masterfs, and even if they will not, they will link (as the change is binary compatible), we modified the method signature to throw IOException
Binary-compatible

External change notifiers in separate modules

Dec 31 '11; API spec. version: 2.36; affected top-level classes: Notifier; made by: jtulach; issues: #206434
Implementation of native listeners has been moved to separate modules, so the masterfs itself does not depend on JNA library.

Determine if a ProvidedExtensions instance should be used to get a files canWrite() value

Feb 1 '11; API spec. version: 2.30; affected top-level classes: ProvidedExtensions; made by: tstupka; issues: #194683
Introduced a new constructor parameter providesCanWrite to specify if a ProvidedExtensions instance is meant to provide the canWrite() value for a file.

Delegate FileObject.copy() to ProvidedExtensions

Aug 27 '10; API spec. version: 2.28; affected top-level classes: ProvidedExtensions; made by: tstupka; issues: #189921
ProvidedExtensions.getCopyHandler() allows to delegate a copy operation.

Guaranteed event order when deleting and creating files and new calls in ProvidedExtensions

Jun 22 '10; API spec. version: 2.27; affected top-level classes: ProvidedExtensions; made by: tstupka; issues: #133855

Guaranteed event order when deleting and creating files in atomic action - createSuccess and deleteSuccess are called imediatelly after a file is created or deleted.
new calls createdExternally, deletedExternally, fileChanged, beforeMove, moveSuccess, moveFailure

`ProvidedExtensions.priorityIO` to suspend background refresh

May 12 '10; API spec. version: 2.25; affected top-level classes: ProvidedExtensions; made by: jtulach; issues: #181684

ProvidedExtensions.priorityIO allows parsing API to suspend background I/O activity after refresh of main window.

`ProvidedExtensions.refreshRecursively` was added.

Apr 16 '10; API spec. version: 2.24; affected top-level classes: ProvidedExtensions; made by: jtulach; issues: #181684

ProvidedExtensions.refreshRecursively allows various version control providers to get better control on behavior of recursive listener.

`ProvidedExtensions.canWrite` was added.

Mar 20 '08; API spec. version: 2.14; made by: msandor; issues: #130044

ProvidedExtensions.canWrite which is called when MasterFileSystem queries the FileObject for writability.

Fileobject instances are not issued after external changes

Jan 8 '08; API spec. version: 2.13; made by: rmatous; issues: #123542
FileObject instances are not guaranteed to be issued if files, folders were not created, deleted, modified by FileSystem API and method refresh wasn't properly called. These methods were semantically changed:

FileObject.getFileObject
FileSystem.findResource
FileObject.getChildren

Method FileUtil.toFileObject should still work as before.

Simplify MasterFS, do not delegate on other embedded FS

Jan 8 '08; API spec. version: 2.13; affected top-level classes: org.netbeans.modules.masterfs.providers.MountSupport org.netbeans.modules.masterfs.providers.FileSystemProvider org.netbeans.modules.masterfs.providers.AutoMountProvider; made by: rmatous; issues: #123542
Friend contract for org.netbeans.modules.vcscore broken. Following classes deleted: MountSupport, FileSystemProvider, AutoMountProvider

`ProvidedExtensions.fileLock` and `ProvidedExtensions.fileUnlock` was added.

Jun 15 '07; API spec. version: 1.11; affected top-level classes: ProvidedExtensions; made by: rmatous; issues: #106479

ProvidedExtensions.fileLock which is called after MasterFileSystem locks FileObject

ProvidedExtensions.fileUnlock which is called after FileObject is unlocked.

`ProvidedExtensions.beforeChange` was added.

Feb 12 '07; API spec. version: 1.10; affected top-level classes: ProvidedExtensions; made by: rmatous; issues: #92676

ProvidedExtensions.beforeChangewhich is called by MasterFileSystem when FileObject is going to be modified by asking for OutputStream.

`ProvidedExtensions.getDeleteHandler` was added.

Aug 8 '06; API spec. version: 1.9; affected top-level classes: ProvidedExtensions; made by: rmatous; issues: #81510

ProvidedExtensions.getDeleteHandler was added, which is the way how to impose handlers for deleting into mastersfs implementation which was required by module org.netbeans.modules.subversion.

`ProvidedExtensions` was added.

Apr 24 '06; API spec. version: 1.9; affected top-level classes: ProvidedExtensions; made by: rmatous; issues: #73042

ProvidedExtensions was added. Registering subclass of ProvidedExtensions as a substitution of InterceptionListener is the way how to impose handlers for renaming and moving into mastersfs implementation which was required by module org.netbeans.modules.subversion.