Index
All Classes and Interfaces|All Packages
A
- ApplicationDirectories - Class in com.io7m.jade.api
-
The primary API used to get access to application directories.
- ApplicationDirectoriesType - Interface in com.io7m.jade.api
-
The directories available to the application.
- ApplicationDirectoriesUnix - Class in com.io7m.jade.vanilla
-
Application directories on UNIX-like platforms.
- ApplicationDirectoriesUnix() - Constructor for class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
-
Application directories on UNIX-like platforms.
- ApplicationDirectoriesWindows - Class in com.io7m.jade.vanilla
-
Application directories on the Windows platform.
- ApplicationDirectoriesWindows() - Constructor for class com.io7m.jade.vanilla.ApplicationDirectoriesWindows
-
Application directories on the Windows platform.
- ApplicationDirectoryConfiguration - Class in com.io7m.jade.api
-
The type of application directory configurations.
- ApplicationDirectoryConfiguration.Builder - Class in com.io7m.jade.api
-
Builds instances of type
ApplicationDirectoryConfiguration
. - ApplicationDirectoryConfigurationType - Interface in com.io7m.jade.api
-
The type of application directory configurations.
- ApplicationDirectoryProviderType - Interface in com.io7m.jade.spi
-
A provider of application directories.
- ApplicationEnvironmentType - Interface in com.io7m.jade.spi
-
An abstraction over the application's execution environment.
- applicationName() - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
The name of the application.
- applicationName() - Method in interface com.io7m.jade.api.ApplicationDirectoryConfigurationType
-
The name of the application.
- applicationName() - Method in class com.io7m.jade.api.internal.ApplicationProviderContext
- applicationName() - Method in interface com.io7m.jade.spi.ApplicationProviderContextType
-
The name of the application.
- ApplicationNames - Class in com.io7m.jade.api
-
Application names.
- ApplicationOverrideDirectories - Class in com.io7m.jade.api.internal
-
A set of directories that override the default selection.
- ApplicationOverrideDirectories(Path) - Constructor for class com.io7m.jade.api.internal.ApplicationOverrideDirectories
-
A set of directories that override the default selection.
- ApplicationPortableDirectories - Class in com.io7m.jade.api.internal
-
A set of "portable" directories.
- ApplicationPortableDirectories() - Constructor for class com.io7m.jade.api.internal.ApplicationPortableDirectories
-
A set of "portable" directories.
- ApplicationProviderContext - Class in com.io7m.jade.api.internal
-
An application provider context.
- ApplicationProviderContext(ApplicationDirectoryConfiguration) - Constructor for class com.io7m.jade.api.internal.ApplicationProviderContext
-
An application provider context.
- ApplicationProviderContextType - Interface in com.io7m.jade.spi
-
The type of application directory configurations.
- ApplicationRealEnvironment - Class in com.io7m.jade.api.internal
-
An application environment based on the real system environment.
- ApplicationRealEnvironment() - Constructor for class com.io7m.jade.api.internal.ApplicationRealEnvironment
-
An application environment based on the real system environment.
B
- build() - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration.Builder
-
Builds a new
ApplicationDirectoryConfiguration
. - builder() - Static method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Creates a builder for
ApplicationDirectoryConfiguration
.
C
- cacheDirectory() - Method in class com.io7m.jade.api.ApplicationDirectories
- cacheDirectory() - Method in interface com.io7m.jade.api.ApplicationDirectoriesType
-
The directory to be used for user-specific non-essential (cached) data.
- cacheDirectory() - Method in class com.io7m.jade.api.internal.ApplicationOverrideDirectories
- cacheDirectory() - Method in class com.io7m.jade.api.internal.ApplicationPortableDirectories
- cacheDirectory() - Method in interface com.io7m.jade.spi.ApplicationDirectoryProviderType
- cacheDirectory() - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
- cacheDirectory() - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesWindows
- checkPreconditions() - Method in interface com.io7m.jade.api.ApplicationDirectoryConfigurationType
-
Check preconditions for the type.
- checkValid(String) - Static method in class com.io7m.jade.api.ApplicationNames
-
Check that the given name is a valid application name.
- com.io7m.jade.api - package com.io7m.jade.api
-
Java application directory etiquette (API)
- com.io7m.jade.api.internal - package com.io7m.jade.api.internal
-
Java application directory etiquette (API internal classes)
- com.io7m.jade.spi - package com.io7m.jade.spi
-
Java application directory etiquette (SPI)
- com.io7m.jade.vanilla - package com.io7m.jade.vanilla
-
Java application directory etiquette (Vanilla implementations)
- configurationDirectory() - Method in class com.io7m.jade.api.ApplicationDirectories
- configurationDirectory() - Method in interface com.io7m.jade.api.ApplicationDirectoriesType
-
The directory to be used for configuration files.
- configurationDirectory() - Method in class com.io7m.jade.api.internal.ApplicationOverrideDirectories
- configurationDirectory() - Method in class com.io7m.jade.api.internal.ApplicationPortableDirectories
- configurationDirectory() - Method in interface com.io7m.jade.spi.ApplicationDirectoryProviderType
- configurationDirectory() - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
- configurationDirectory() - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesWindows
- copyOf(ApplicationDirectoryConfigurationType) - Static method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Creates an immutable copy of a
ApplicationDirectoryConfigurationType
value.
D
- dataDirectory() - Method in class com.io7m.jade.api.ApplicationDirectories
- dataDirectory() - Method in interface com.io7m.jade.api.ApplicationDirectoriesType
-
The directory to be used for user-specific data files.
- dataDirectory() - Method in class com.io7m.jade.api.internal.ApplicationOverrideDirectories
- dataDirectory() - Method in class com.io7m.jade.api.internal.ApplicationPortableDirectories
- dataDirectory() - Method in interface com.io7m.jade.spi.ApplicationDirectoryProviderType
- dataDirectory() - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
- dataDirectory() - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesWindows
E
- environmentVariable(String) - Method in class com.io7m.jade.api.internal.ApplicationRealEnvironment
- environmentVariable(String) - Method in interface com.io7m.jade.spi.ApplicationEnvironmentType
-
Retrieve the value of an environment variable.
- equals(Object) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
This instance is equal to all instances of
ApplicationDirectoryConfiguration
that have equal attribute values.
F
- filesystem() - Method in class com.io7m.jade.api.internal.ApplicationRealEnvironment
- filesystem() - Method in interface com.io7m.jade.spi.ApplicationEnvironmentType
- from(ApplicationDirectoryConfigurationType) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration.Builder
-
Fill a builder with attribute values from the provided
ApplicationDirectoryConfigurationType
instance. - fromSystem() - Static method in class com.io7m.jade.vanilla.SystemSelection
G
- get(ApplicationDirectoryConfiguration) - Static method in class com.io7m.jade.api.ApplicationDirectories
-
Retrieve the application directories.
- get(ApplicationDirectoryConfiguration, ApplicationEnvironmentType) - Static method in class com.io7m.jade.api.ApplicationDirectories
-
Retrieve the application directories.
H
- hashCode() - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Computes a hash code from attributes:
applicationName
,portablePropertyName
,overridePropertyName
.
I
- initialize(ApplicationProviderContextType, ApplicationEnvironmentType) - Method in class com.io7m.jade.api.internal.ApplicationOverrideDirectories
- initialize(ApplicationProviderContextType, ApplicationEnvironmentType) - Method in class com.io7m.jade.api.internal.ApplicationPortableDirectories
- initialize(ApplicationProviderContextType, ApplicationEnvironmentType) - Method in interface com.io7m.jade.spi.ApplicationDirectoryProviderType
-
Initialize the provider, returning
true
if the provider is applicable to the current application environment and operating system. - initialize(ApplicationProviderContextType, ApplicationEnvironmentType) - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
- initialize(ApplicationProviderContextType, ApplicationEnvironmentType) - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesWindows
- isUnix() - Method in class com.io7m.jade.vanilla.SystemSelection
- isValid(String) - Static method in class com.io7m.jade.api.ApplicationNames
-
Check that the given name is a valid application name.
- isWindows() - Method in class com.io7m.jade.vanilla.SystemSelection
O
- overridePropertyName() - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
The name of a system property which, if present, will be used to specify a fixed base directory against which all other application directories will be resolved.
- overridePropertyName() - Method in interface com.io7m.jade.api.ApplicationDirectoryConfigurationType
-
The name of a system property which, if present, will be used to specify a fixed base directory against which all other application directories will be resolved.
P
- portablePropertyName() - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
The name of a system property which, if present, will be used to enable portable mode.
- portablePropertyName() - Method in interface com.io7m.jade.api.ApplicationDirectoryConfigurationType
-
The name of a system property which, if present, will be used to enable portable mode.
S
- servicesFor(Class<S>) - Method in class com.io7m.jade.api.internal.ApplicationRealEnvironment
- servicesFor(Class<S>) - Method in interface com.io7m.jade.spi.ApplicationEnvironmentType
- setApplicationName(String) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration.Builder
-
Initializes the value for the
applicationName
attribute. - setOverridePropertyName(String) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration.Builder
-
Initializes the optional value
overridePropertyName
to overridePropertyName. - setOverridePropertyName(Optional<String>) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration.Builder
-
Initializes the optional value
overridePropertyName
to overridePropertyName. - setPortablePropertyName(String) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration.Builder
-
Initializes the optional value
portablePropertyName
to portablePropertyName. - setPortablePropertyName(Optional<String>) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration.Builder
-
Initializes the optional value
portablePropertyName
to portablePropertyName. - setSystemSelection(SystemSelection) - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
- setUnix(boolean) - Method in class com.io7m.jade.vanilla.SystemSelection
-
Set whether or not the current platform is UNIX-like.
- setWindows(boolean) - Method in class com.io7m.jade.vanilla.SystemSelection
-
Set whether or not the current platform is Windows.
- systemProperty(String) - Method in class com.io7m.jade.api.internal.ApplicationRealEnvironment
- systemProperty(String) - Method in interface com.io7m.jade.spi.ApplicationEnvironmentType
-
Retrieve the value of a system property.
- systemSelection() - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
- SystemSelection - Class in com.io7m.jade.vanilla
-
The system selection function.
- SystemSelection() - Constructor for class com.io7m.jade.vanilla.SystemSelection
-
The system selection function.
T
- toString() - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Prints the immutable value
ApplicationDirectoryConfiguration
with attribute values.
V
- VALID_NAMES - Static variable in class com.io7m.jade.api.ApplicationNames
-
The pattern that defines a valid application name.
W
- withApplicationName(String) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Copy the current immutable object by setting a value for the
applicationName
attribute. - withOverridePropertyName(String) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Copy the current immutable object by setting a present value for the optional
overridePropertyName
attribute. - withOverridePropertyName(Optional<String>) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Copy the current immutable object by setting an optional value for the
overridePropertyName
attribute. - withPortablePropertyName(String) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Copy the current immutable object by setting a present value for the optional
portablePropertyName
attribute. - withPortablePropertyName(Optional<String>) - Method in class com.io7m.jade.api.ApplicationDirectoryConfiguration
-
Copy the current immutable object by setting an optional value for the
portablePropertyName
attribute.
All Classes and Interfaces|All Packages