Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
dev.dirs.ProjectDirectories Maven / Gradle / Ivy
package dev.dirs;
import static dev.dirs.Util.*;
/** {@code ProjectDirectories} computes the location of cache, config or data directories for a specific application,
* which are derived from the standard directories and the name of the project/organization.
*
* Examples
* All examples on this page are computed with a user named Alice ,
* and a {@code ProjectDirectories} instance created with the following information:
* {@code ProjectDirectories.from("com", "Foo Corp", "Bar App")}
*
* Example of {@link ProjectDirectories#configDir} value in different operating systems:
*
* Linux/BSD: {@code /home/alice/.config/barapp}macOS: {@code /Users/Alice/Library/Preferences/com.Foo-Corp.Bar-App}Windows: {@code C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App}
*/
public final class ProjectDirectories {
private ProjectDirectories(
final String projectPath,
final String cacheDir,
final String configDir,
final String dataDir,
final String dataLocalDir,
final String preferenceDir,
final String runtimeDir) {
requireNonNull(projectPath);
this.projectPath = projectPath;
this.cacheDir = cacheDir;
this.configDir = configDir;
this.dataDir = dataDir;
this.dataLocalDir = dataLocalDir;
this.preferenceDir = preferenceDir;
this.runtimeDir = runtimeDir;
}
/** Returns the project path fragment used to compute the project's cache/config/data directories.
*
* The value is derived from the arguments provided to the {@link ProjectDirectories#from} call and is platform-dependent.
*/
public final String projectPath;
/** Returns the path to the project's cache directory,
* in which {@code } is the value of {@link ProjectDirectories#projectPath}.
*
*
* Platform
* Value
* Example
*
*
* Linux/BSD
* {@code $XDG_CACHE_HOME}/{@code } or {@code $HOME}/.cache/{@code }
* /home/alice/.cache/barapp
*
*
* macOS
* {@code $HOME}/Library/Caches/{@code }
* /Users/Alice/Library/Caches/com.Foo-Corp.Bar-App
*
*
* Windows
* {@code {FOLDERID_LocalAppData}}\{@code }\cache
* C:\Users\Alice\AppData\Local\Foo Corp\Bar App\cache
*
*
*/
public final String cacheDir;
/** Returns the path to the project's configuration directory,
* in which {@code } is the value of {@link ProjectDirectories#projectPath}.
*
*
* Platform
* Value
* Example
*
*
* Linux/BSD
* {@code $XDG_CONFIG_HOME}/{@code } or {@code $HOME}/.config/{@code }
* /home/alice/.config/barapp
*
*
* macOS
* {@code $HOME}/Library/Application Support/{@code }
* /Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App
*
*
* Windows
* {@code {FOLDERID_RoamingAppData}}\{@code }\config
* C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\config
*
*
*/
public final String configDir;
/** Returns the path to the project's data directory,
* in which {@code } is the value of {@link ProjectDirectories#projectPath}.
*
*
* Platform
* Value
* Example
*
*
* Linux/BSD
* {@code $XDG_DATA_HOME}/{@code } or {@code $HOME}/.local/share/{@code }
* /home/alice/.local/share/barapp
*
*
* macOS
* {@code $HOME}/Library/Application Support/{@code }
* /Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App
*
*
* Windows
* {@code {FOLDERID_RoamingAppData}}\{@code }\data
* C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\data
*
*
*/
public final String dataDir;
/** Returns the path to the project's local data directory,
* in which {@code } is the value of {@link ProjectDirectories#projectPath}.
*
*
* Platform
* Value
* Example
*
*
* Linux/BSD
* {@code $XDG_DATA_HOME}/{@code } or {@code $HOME}/.local/share/{@code }
* /home/alice/.local/share/barapp
*
*
* macOS
* {@code $HOME}/Library/Application Support/{@code }
* /Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App
*
*
* Windows
* {@code {FOLDERID_LocalAppData}}\{@code }\data
* C:\Users\Alice\AppData\Local\Foo Corp\Bar App\data
*
*
*/
public final String dataLocalDir;
/** Returns the path to the project's preference directory,
* in which {@code } is the value of {@link ProjectDirectories#projectPath}.
*
*
* Platform
* Value
* Example
*
*
* Linux/BSD
* {@code $XDG_CONFIG_HOME}/{@code } or {@code $HOME}/.config/{@code }
* /home/alice/.config/barapp
*
*
* macOS
* {@code $HOME}/Library/Preferences/{@code }
* /Users/Alice/Library/Preferences/com.Foo-Corp.Bar-App
*
*
* Windows
* {@code {FOLDERID_RoamingAppData}}\{@code }\config
* C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\config
*
*
*/
public final String preferenceDir;
/** Returns the path to the project's runtime directory.
*
*
* Platform
* Value
* Example
*
*
* Linux/BSD
* {@code $XDG_RUNTIME_DIR}
* /run/user/1001/barapp
*
*
* macOS
* –
* {@code null}
*
*
* Windows
* –
* {@code null}
*
*
*/
public final String runtimeDir;
/** Creates a {@code ProjectDirectories} instance directly from a path.
*
* The argument is used verbatim and is not adapted to operating system standards.
* The use of {@link ProjectDirectories#fromPath} is strongly discouraged, as its results will
* not follow operating system standards on at least two of three platforms.
*
* @param path A string used verbatim as the path fragment to derive the directory field values.
*
* @return A new {@code ProjectDirectories} instance, whose directory field values are directly derived from the {@code path} argument.
*/
public static ProjectDirectories fromPath(String path) {
return fromPath(path, GetWinDirs.powerShellBased);
}
public static ProjectDirectories fromPath(String path, GetWinDirs getWinDirs) {
String homeDir;
String cacheDir;
String configDir;
String dataDir;
String dataLocalDir;
String preferenceDir;
String runtimeDir = null;
switch (operatingSystem) {
case LIN:
case BSD:
case SOLARIS:
homeDir = System.getProperty("user.home");
cacheDir = defaultIfNullOrEmptyExtended(System.getenv("XDG_CACHE_HOME"), path, homeDir + "/.cache/", path);
configDir = defaultIfNullOrEmptyExtended(System.getenv("XDG_CONFIG_HOME"), path, homeDir + "/.config/", path);
dataDir = defaultIfNullOrEmptyExtended(System.getenv("XDG_DATA_HOME"), path, homeDir + "/.local/share/", path);
dataLocalDir = dataDir;
preferenceDir = configDir;
runtimeDir = linuxRuntimeDir(path);
break;
case MAC:
homeDir = System.getProperty("user.home");
cacheDir = homeDir + "/Library/Caches/" + path;
configDir = homeDir + "/Library/Application Support/" + path;
dataDir = homeDir + "/Library/Application Support/" + path;
dataLocalDir = dataDir;
preferenceDir = homeDir + "/Library/Preferences/" + path;
break;
case WIN:
String[] winDirs = getWinDirs.getWinDirs("3EB685DB-65F9-4CF6-A03A-E3EF65729F3D", "F1B32785-6FBA-4FCF-9D55-7B8E7F157091");
String appDataRoaming = winDirs[0] + '\\' + path;
String appDataLocal = winDirs[1] + '\\' + path;
dataDir = appDataRoaming + "\\data";
dataLocalDir = appDataLocal + "\\data";
configDir = appDataRoaming + "\\config";
cacheDir = appDataLocal + "\\cache";
preferenceDir = configDir;
break;
default:
throw new UnsupportedOperatingSystemException("Project directories are not supported on " + operatingSystemName);
}
return new ProjectDirectories(path, cacheDir, configDir, dataDir, dataLocalDir, preferenceDir, runtimeDir);
}
/** Creates a {@code ProjectDirectories} instance from values describing the project.
*
* The use of {@link ProjectDirectories#from} – instead of {@link ProjectDirectories#fromPath} – is strongly encouraged,
* as its results will follow operating system standards on Linux, macOS and Windows.
*
* @param qualifier The reverse domain name notation of the application, excluding the
* organization or application name itself.
