Line | |
---|
1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.spi.preferences;
|
---|
3 |
|
---|
4 | import java.io.File;
|
---|
5 |
|
---|
6 | /**
|
---|
7 | * Interface for a provider of certain base directory locations.
|
---|
8 | * <p>
|
---|
9 | * Depending on the OS and preferred layout, some directories may coincide.
|
---|
10 | * @since 12855
|
---|
11 | */
|
---|
12 | public interface IBaseDirectories {
|
---|
13 |
|
---|
14 | /**
|
---|
15 | * Get the directory where user-specific configuration and preferences
|
---|
16 | * should be stored.
|
---|
17 | * @param createIfMissing if true, automatically creates this directory,
|
---|
18 | * in case it is missing
|
---|
19 | * @return the preferences directory
|
---|
20 | * @since 12856
|
---|
21 | */
|
---|
22 | File getPreferencesDirectory(boolean createIfMissing);
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * Get the directory where user-specific data files should be stored.
|
---|
26 | * @param createIfMissing if true, automatically creates this directory,
|
---|
27 | * in case it is missing
|
---|
28 | * @return the user data directory
|
---|
29 | * @since 12856
|
---|
30 | */
|
---|
31 | File getUserDataDirectory(boolean createIfMissing);
|
---|
32 |
|
---|
33 | /**
|
---|
34 | * Get the directory where user-specific cached content (non-essential data)
|
---|
35 | * should be stored.
|
---|
36 | * @param createIfMissing if true, automatically creates this directory,
|
---|
37 | * in case it is missing
|
---|
38 | * @return the cache directory
|
---|
39 | * @since 12856
|
---|
40 | */
|
---|
41 | File getCacheDirectory(boolean createIfMissing);
|
---|
42 | }
|
---|
Note:
See
TracBrowser
for help on using the repository browser.