org.netbeans.spi.project

Interface CacheDirectoryProvider

public interface CacheDirectoryProvider

Ability for a project to permit other modules to store arbitrary cache data associated with the project.

Implementors should place an instance in Project.getLookup(). Callers should use ProjectUtils.getCacheDirectory(org.netbeans.api.project.Project, java.lang.Class<?>) rather than looking for this interface.

Method Summary

Modifier and Type	Method and Description
FileObject	getCacheDirectory() Get a directory in which modules may store disposable cached information about the project, such as an index of classes it contains.

Method Detail

getCacheDirectory

FileObject getCacheDirectory()
                      throws IOException

Get a directory in which modules may store disposable cached information about the project, such as an index of classes it contains. This directory should be considered non-sharable by SharabilityQuery. Modules are responsible for preventing name clashes in this directory by using sufficiently unique names for child files and folders.

Returns:

a cache directory

Throws:

IOException - if it cannot be created or loaded