org.openide.filesystems

Class Repository.LocalProvider

java.lang.Object

org.openide.filesystems.Repository.LocalProvider

Enclosing class:

Repository

public abstract static class Repository.LocalProvider
extends Object

Provides local repositories, depending on the current execution environment. The caller may use Lookups.executeWith(org.openide.util.Lookup, java.lang.Runnable) to temporarily modify the default Lookup contents and route Repository requests to a Repository private to some task. The LocalProvider is responsible for caching and lifecycle of the Repository instance; it can expire the Repository if the Provider's execution context terminates. Implementations must be prepared to handle requests for Repository already shutdown etc.

Since:

9.5

Constructor Summary

Constructors

Constructor and Description
LocalProvider()

Method Summary

Modifier and Type	Method and Description
protected Repository	delayFilesystemAttach(Callable<Repository> init) Allows to delay attaching filesystems to the Repository.
abstract Repository	getRepository() Returns the local repository instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalProvider

public LocalProvider()

Method Detail

getRepository

public abstract Repository getRepository()
                                  throws IOException

Returns the local repository instance. The method can return null to indicate the main Repository should be used. The method must return the very same instance of Repository for the whole duration of the execution context. It must return the same Repository instance even after the execution context shuts down; the contents of Repository and its FileSystems may be limited in that case.

Implementations must be reentrant (a call to getLocalRepository can be made during construction of the Repository instance) and must not recurse infinitely.

Returns:

local repository instance.

Throws:

IOException

delayFilesystemAttach

protected final Repository delayFilesystemAttach(Callable<Repository> init)
                                          throws IOException

Allows to delay attaching filesystems to the Repository. For backwards compatibility, the Repository constructor still takes the default FileSystem instance. However it is better to actually publish the FileSystem in the repository only after it is registered, and can be obtained using Repository.getDefault() or getLocalRepository().

This method wraps the Repository creation so that the default FileSystem is attached after the repository is fully constructed. The `init' callable must create a new Repository instance. This method will then add the default FS for newly created repository instances.

Parameters:

init - Callable which produces a new Repository instance or null to abort creation

Returns:

new Repository instance or null, if no instance was created.

Throws:

IOException - if the Callable fails. All exceptions are wrapped into IOException.