Package com.io7m.jade.api.internal

Class ApplicationOverrideDirectories

java.lang.Object

com.io7m.jade.api.internal.ApplicationOverrideDirectories

All Implemented Interfaces:

ApplicationDirectoryProviderType

public final class ApplicationOverrideDirectories
extends Object
implements ApplicationDirectoryProviderType

A set of directories that override the default selection.

Constructor Summary

Constructors

Constructor	Description
ApplicationOverrideDirectories(Path inBaseDirectory)	A set of directories that override the default selection.

Method Summary

Modifier and Type	Method	Description
Path	cacheDirectory()
Path	configurationDirectory()
Path	dataDirectory()
boolean	initialize(ApplicationProviderContextType configuration, ApplicationEnvironmentType environment)	Initialize the provider, returning true if the provider is applicable to the current application environment and operating system.

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationOverrideDirectories

public ApplicationOverrideDirectories(Path inBaseDirectory)

A set of directories that override the default selection.

Parameters:

inBaseDirectory - The base directory

Method Details

initialize

public boolean initialize(ApplicationProviderContextType configuration,
 ApplicationEnvironmentType environment)

Description copied from interface: ApplicationDirectoryProviderType

Initialize the provider, returning true if the provider is applicable to the current application environment and operating system.

Specified by:

initialize in interface ApplicationDirectoryProviderType

Parameters:

configuration - The context

environment - The environment

Returns:

true if this provider is applicable

configurationDirectory

public Path configurationDirectory()

Specified by:

configurationDirectory in interface ApplicationDirectoryProviderType

Returns:

A single base directory relative to which user-specific configuration files should be written.

dataDirectory

public Path dataDirectory()

Specified by:

dataDirectory in interface ApplicationDirectoryProviderType

Returns:

The directory that contains data files

cacheDirectory

public Path cacheDirectory()

Specified by:

cacheDirectory in interface ApplicationDirectoryProviderType

Returns:

A single base directory relative to which user-specific non-essential (cached) data should be written.