Package org.openstreetmap.josm.plugins

Class Plugin.PluginBaseDirectories

java.lang.Object

org.openstreetmap.josm.plugins.Plugin.PluginBaseDirectories

All Implemented Interfaces:

IBaseDirectories

Enclosing class:

Plugin

private final class Plugin.PluginBaseDirectories
extends java.lang.Object
implements IBaseDirectories

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.File	cacheDir
private java.io.File	preferencesDir
private java.io.File	userdataDir

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PluginBaseDirectories()

Method Summary

Modifier and Type	Method	Description
java.io.File	getCacheDirectory(boolean createIfMissing)	Get the directory where user-specific cached content (non-essential data) should be stored.
java.io.File	getPreferencesDirectory(boolean createIfMissing)	Get the directory where user-specific configuration and preferences should be stored.
java.io.File	getUserDataDirectory(boolean createIfMissing)	Get the directory where user-specific data files should be stored.

Methods inherited from class java.lang.Object

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

Field Detail

preferencesDir

private java.io.File preferencesDir

cacheDir

private java.io.File cacheDir

userdataDir

private java.io.File userdataDir

Constructor Detail

PluginBaseDirectories

private PluginBaseDirectories()

Method Detail

getPreferencesDirectory

public java.io.File getPreferencesDirectory(boolean createIfMissing)

Description copied from interface: IBaseDirectories

Get the directory where user-specific configuration and preferences should be stored.

Specified by:

getPreferencesDirectory in interface IBaseDirectories

Parameters:

createIfMissing - if true, automatically creates this directory, in case it is missing

Returns:

the preferences directory

getUserDataDirectory

public java.io.File getUserDataDirectory(boolean createIfMissing)

Description copied from interface: IBaseDirectories

Get the directory where user-specific data files should be stored.

Specified by:

getUserDataDirectory in interface IBaseDirectories

Parameters:

createIfMissing - if true, automatically creates this directory, in case it is missing

Returns:

the user data directory

getCacheDirectory

public java.io.File getCacheDirectory(boolean createIfMissing)

Description copied from interface: IBaseDirectories

Get the directory where user-specific cached content (non-essential data) should be stored.

Specified by:

getCacheDirectory in interface IBaseDirectories

Parameters:

createIfMissing - if true, automatically creates this directory, in case it is missing

Returns:

the cache directory