Master Filesystem
Friend, Private or Third Party

MasterFileSystem exports SPI for versioning support.

See:
Description

Master Filesystem

org.netbeans.modules.masterfs.providers

MasterFileSystem exports SPI for versioning support. There is expected that module that provides implementation of FileSystem that should be plugable into MasterFileSystem must implement at least FileSystemProvider. MasterFileSystem doesn't provide pure client API but has tiny API that is intended just for SPI providers (slightly disputable if it should be called API or SPI). All SPI are plugable, registred by Lookup.

What is New (see all changes)?

• Dec 31 '11 External change notifiers in separate modules

  Implementation of native listeners has been moved to separate modules, so the masterfs itself does not depend on JNA library.

• Feb 1 '11 Determine if a ProvidedExtensions instance should be used to get a files canWrite() value

  Introduced a new constructor parameter providesCanWrite to specify if a ProvidedExtensions instance is meant to provide the canWrite() value for a file.

• Aug 27 '10 Delegate FileObject.copy() to ProvidedExtensions

  ProvidedExtensions.getCopyHandler() allows to delegate a copy operation.

• Jun 22 '10 Guaranteed event order when deleting and creating files and new calls in ProvidedExtensions
  • 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

• May 12 '10 ProvidedExtensions.priorityIO to suspend background refresh

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

Use Cases

MasterFileSystem is just implementation of FileSystem. There are no special use cases. FileObjects erlier returned from URLMapper or FileUtil.fromFile provided by LocalFileSystem or CvsFileSystem will be now provided by MasterFileSystem. There will be guaranteed that there won't be more instances of FileObject addressing one java.ioFile.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
MasterFileSystemAPI	Exported	Friend	.../masterfs/providers/package-summary.html

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
refreshSlow	Exported	Private	One can ask FileObject.getAttribute("refreshSlow") and obtain an instance of Runnable with intricate behavior. This is a private contract used from core.ui module to show refresh progress and tested in masterfs/test/unit/src/org/netbeans/modules/masterfs/SlowRefreshTest.java.

Group of systemproperty interfaces

Interface Name	In/Out	Stability	Specified in What Document?
org.netbeans.modules.masterfs.watcher.disable	Exported	Private	It is possible to disable native listening on filesystem changes. Useful mostly in testing environment, but it may be interesting for some users too. Don't rely (much) on this property from production code however.
org.netbeans.modules.masterfs.watcher.FAM	Exported	Private	It is possible to enable use of FAM notifier on Solaris disabled by default. Useful mostly in testing environment, but it may be interesting for some users too. Don't rely (much) on this property from production code however.

Implementation Details

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

Nothing currently. Most "clients" are really callers of FileUtil.toFileObject and so on, and thus implicitly depend on the existence of this module. In the future a provide-require token might make sense.

Read more about the implementation in the answers to architecture questions.