org.openide.modules

Class Places

java.lang.Object

org.openide.modules.Places

public abstract class Places
extends Object

Provides access to standard file locations.

This class should be used for limited purposes only. You might instead want to use:

• FileUtil.getConfigFile to find a file declared in an XML layer or created or overridden in the config subdirectory of the user directory.
• InstalledFileLocator to find modules installed as part of an NBM.
• someClass.getProtectionDomain().getCodeSource().getLocation() to find resources inside a module class loader.

Since:

7.26

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Places() Constructor for those who believe to know where Places.getCacheDirectory() or Places.getUserDirectory() is.

Method Summary

Modifier and Type	Method and Description
protected abstract File	findCacheDirectory() The cache directory to return from Places.getCacheDirectory().
protected abstract File	findUserDirectory() Finds location of a user directory to return from Places.getUserDirectory().
static File	getCacheDirectory() Locates the NetBeans cache directory.
static File	getCacheSubdirectory(String path) Convenience method to get a particular subdirectory within Places.getCacheDirectory().
static File	getCacheSubfile(String path) Convenience method to get a particular file within Places.getCacheDirectory().
static File	getUserDirectory() Locates the NetBeans user directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

Places

protected Places()

Constructor for those who believe to know where Places.getCacheDirectory() or Places.getUserDirectory() is. Register your subclass via ServiceProvider annotation.

Method Detail

getUserDirectory

public static File getUserDirectory()

Locates the NetBeans user directory. This may be used to persist valuable files for which the system filesystem (FileUtil.getConfigFile) is inappropriate due its being virtual. Each module is responsible for using sufficiently unique filenames within this directory. The system property #USER_DIR_PROP is used for compatibility.

Returns:

a directory location (need not yet exist), or null if unconfigured

getCacheDirectory

public static File getCacheDirectory()

Locates the NetBeans cache directory. This may be used to store pure performance caches - files which could be safely deleted, since they would be automatically recreated on demand. Each module is responsible for using sufficiently unique filenames within this directory. $userdir/var/cache/ is used as a default when Places.getUserDirectory() is configured. As a final fallback, a location in the system temporary directory will be returned.

Returns:

a directory location (never null but need not yet exist)

See Also:

Places.getCacheSubdirectory(java.lang.String), Places.getCacheSubfile(java.lang.String)

getCacheSubdirectory

public static File getCacheSubdirectory(String path)

Convenience method to get a particular subdirectory within Places.getCacheDirectory(). The directory will be created if it does not yet exist (but a warning logged if permissions do not allow this).

Parameters:

path - a subdirectory path such as stuff or mymodule/stuff (/ permitted even on Windows)

Returns:

a directory of that name within the general cache directory

getCacheSubfile

public static File getCacheSubfile(String path)

Convenience method to get a particular file within Places.getCacheDirectory(). The parent directory will be created if it does not yet exist (but a warning logged if permissions do not allow this); the file itself will not be automatically created.

Parameters:

path - a file path such as stuff.ser or mymodule/stuff.ser (/ permitted even on Windows)

Returns:

a file of that name within the general cache directory

findCacheDirectory

protected abstract File findCacheDirectory()

The cache directory to return from Places.getCacheDirectory(). If null the caches will be placed below Places.getUserDirectory().

Returns:

the file to use for caches or null

Since:

7.26

findUserDirectory

protected abstract File findUserDirectory()

Finds location of a user directory to return from Places.getUserDirectory().

Returns:

the user directory or null if no user directory is supposed to be used

Since:

7.26