Package com.io7m.jade.api
Class ApplicationDirectories
java.lang.Object
com.io7m.jade.api.ApplicationDirectories
- All Implemented Interfaces:
ApplicationDirectoriesType
The primary API used to get access to application directories.
-
Method Summary
Modifier and TypeMethodDescriptionThe directory to be used for user-specific non-essential (cached) data.The directory to be used for configuration files.The directory to be used for user-specific data files.static ApplicationDirectoriesType
get
(ApplicationDirectoryConfiguration configuration) Retrieve the application directories.static ApplicationDirectoriesType
get
(ApplicationDirectoryConfiguration configuration, ApplicationEnvironmentType environment) Retrieve the application directories.
-
Method Details
-
get
Retrieve the application directories.- Parameters:
configuration
- The application configuration- Returns:
- The application directories
-
get
public static ApplicationDirectoriesType get(ApplicationDirectoryConfiguration configuration, ApplicationEnvironmentType environment) Retrieve the application directories. This method allows for providing a custom application environment and is primarily useful for testing purposes.- Parameters:
environment
- The application environmentconfiguration
- The application configuration- Returns:
- The application directories
-
configurationDirectory
Description copied from interface:ApplicationDirectoriesType
The directory to be used for configuration files.- Specified by:
configurationDirectory
in interfaceApplicationDirectoriesType
- Returns:
- The directory to be used for user-specific configuration files
-
dataDirectory
Description copied from interface:ApplicationDirectoriesType
The directory to be used for user-specific data files.- Specified by:
dataDirectory
in interfaceApplicationDirectoriesType
- Returns:
- The directory to be used for user-specific data files
-
cacheDirectory
Description copied from interface:ApplicationDirectoriesType
The directory to be used for user-specific non-essential (cached) data.- Specified by:
cacheDirectory
in interfaceApplicationDirectoriesType
- Returns:
- The directory to be used for user-specific non-essential (cached) data.
-