Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
IFoldersContainer |
|
| 1.0;1 |
1 | package org.jtheque.core.managers.core.io; | |
2 | ||
3 | /* | |
4 | * This file is part of JTheque. | |
5 | * | |
6 | * JTheque is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License. | |
9 | * | |
10 | * JTheque is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
16 | * along with JTheque. If not, see <http://www.gnu.org/licenses/>. | |
17 | */ | |
18 | ||
19 | import java.io.File; | |
20 | ||
21 | /** | |
22 | * @author Baptiste Wicht | |
23 | */ | |
24 | public interface IFoldersContainer { | |
25 | /** | |
26 | * Return the application folder. It seems the root folder where the application is launched. | |
27 | * | |
28 | * @return The File object who denotes the application folder. | |
29 | */ | |
30 | File getApplicationFolder(); | |
31 | ||
32 | /** | |
33 | * Return the skins folder. It seems the folder where the skins are located. | |
34 | * | |
35 | * @return The File object who denotes the skins folder. | |
36 | */ | |
37 | File getSkinsFolder(); | |
38 | ||
39 | /** | |
40 | * Returns the logs folder. It seems the folder where the logs are located. | |
41 | * | |
42 | * @return the File object who denotes the logs folder. | |
43 | */ | |
44 | File getLogsFolder(); | |
45 | ||
46 | /** | |
47 | * Return the libraries folder. It seems the folder where the libraries are located. | |
48 | * | |
49 | * @return The File object who denotes the libraries folder. | |
50 | */ | |
51 | File getLibrariesFolder(); | |
52 | ||
53 | /** | |
54 | * Return the modules folder. It seems the folder where the modules are located. | |
55 | * | |
56 | * @return The File object who denotes the modules folder. | |
57 | */ | |
58 | File getModulesFolder(); | |
59 | ||
60 | /** | |
61 | * Return the cache folder. It seems the folder where the cache are located. | |
62 | * | |
63 | * @return The File object who denotes the cache folder. | |
64 | */ | |
65 | File getCacheFolder(); | |
66 | ||
67 | /** | |
68 | * Return the path to the temporary folder. | |
69 | * | |
70 | * @return The path to the temporary folder. | |
71 | */ | |
72 | String getTempFolderPath(); | |
73 | } |