Package com.io7m.jade.api

Class ApplicationDirectories

java.lang.Object

com.io7m.jade.api.ApplicationDirectories

All Implemented Interfaces:

ApplicationDirectoriesType

public final class ApplicationDirectories
extends java.lang.Object
implements ApplicationDirectoriesType

The primary API used to get access to application directories.

Method Summary

Modifier and Type	Method	Description
java.nio.file.Path	cacheDirectory()	The directory to be used for user-specific non-essential (cached) data.
java.nio.file.Path	configurationDirectory()	The directory to be used for configuration files.
java.nio.file.Path	dataDirectory()	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.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static ApplicationDirectoriesType get(ApplicationDirectoryConfiguration configuration)

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 environment

configuration - The application configuration

Returns:

The application directories

configurationDirectory

public java.nio.file.Path configurationDirectory()

Description copied from interface: ApplicationDirectoriesType

The directory to be used for configuration files.

Specified by:

configurationDirectory in interface ApplicationDirectoriesType

Returns:

The directory to be used for user-specific configuration files

dataDirectory

public java.nio.file.Path dataDirectory()

Description copied from interface: ApplicationDirectoriesType

The directory to be used for user-specific data files.

Specified by:

dataDirectory in interface ApplicationDirectoriesType

Returns:

The directory to be used for user-specific data files

cacheDirectory

public java.nio.file.Path cacheDirectory()

Description copied from interface: ApplicationDirectoriesType

The directory to be used for user-specific non-essential (cached) data.

Specified by:

cacheDirectory in interface ApplicationDirectoriesType

Returns:

The directory to be used for user-specific non-essential (cached) data.