A B C D E F G H I P S T V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractDirectories - Class in com.io7m.jade.vanilla
- AbstractDirectories() - Constructor for class com.io7m.jade.vanilla.AbstractDirectories
- 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
- ApplicationDirectoriesUnix() - Constructor for class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
- ApplicationDirectoriesWindows - Class in com.io7m.jade.vanilla
- ApplicationDirectoriesWindows() - Constructor for class com.io7m.jade.vanilla.ApplicationDirectoriesWindows
- ApplicationDirectoryConfiguration - Class in com.io7m.jade.spi
-
The type of application directory configurations.
- ApplicationDirectoryConfiguration.Builder - Class in com.io7m.jade.spi
-
Builds instances of type
ApplicationDirectoryConfiguration. - ApplicationDirectoryConfigurationType - Interface in com.io7m.jade.spi
-
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
- applicationName() - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration
-
The name of the application.
- applicationName() - Method in interface com.io7m.jade.spi.ApplicationDirectoryConfigurationType
-
The name of the application.
- ApplicationNames - Class in com.io7m.jade.spi
-
Application names.
B
- build() - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder
-
Builds a new
ApplicationDirectoryConfiguration. - builder() - Static method in class com.io7m.jade.spi.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 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.spi.ApplicationDirectoryConfigurationType
-
Check preconditions for the type.
- checkValid(String) - Static method in class com.io7m.jade.spi.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.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 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.spi.ApplicationDirectoryConfiguration
-
Creates an immutable copy of a
ApplicationDirectoryConfigurationTypevalue.
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 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 interface com.io7m.jade.spi.ApplicationEnvironmentType
- equals(Object) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration
-
This instance is equal to all instances of
ApplicationDirectoryConfigurationthat have equal attribute values.
F
- filesystem() - Method in interface com.io7m.jade.spi.ApplicationEnvironmentType
- from(ApplicationDirectoryConfigurationType) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder
-
Fill a builder with attribute values from the provided
ApplicationDirectoryConfigurationTypeinstance. - 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.spi.ApplicationDirectoryConfiguration
-
Computes a hash code from attributes:
applicationName,portablePropertyName.
I
- initialize(ApplicationDirectoryConfiguration, ApplicationEnvironmentType) - Method in interface com.io7m.jade.spi.ApplicationDirectoryProviderType
-
Initialize the provider, returning
trueif the provider is applicable to the current application environment and operating system. - initialize(ApplicationDirectoryConfiguration, ApplicationEnvironmentType) - Method in class com.io7m.jade.vanilla.ApplicationDirectoriesUnix
- initialize(ApplicationDirectoryConfiguration, 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.spi.ApplicationNames
-
Check that the given name is a valid application name.
- isWindows() - Method in class com.io7m.jade.vanilla.SystemSelection
P
- portablePropertyName() - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration
-
The name of a system property which, if present, will be used to enable portable mode.
- portablePropertyName() - Method in interface com.io7m.jade.spi.ApplicationDirectoryConfigurationType
-
The name of a system property which, if present, will be used to enable portable mode.
S
- setApplicationName(String) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder
-
Initializes the value for the
applicationNameattribute. - setPortablePropertyName(String) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder
-
Initializes the optional value
portablePropertyNameto portablePropertyName. - setPortablePropertyName(Optional<String>) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder
-
Initializes the optional value
portablePropertyNameto portablePropertyName. - setSystemSelection(SystemSelection) - Method in class com.io7m.jade.vanilla.AbstractDirectories
- setUnix(boolean) - Method in class com.io7m.jade.vanilla.SystemSelection
- setWindows(boolean) - Method in class com.io7m.jade.vanilla.SystemSelection
- systemProperty(String) - Method in interface com.io7m.jade.spi.ApplicationEnvironmentType
- systemSelection() - Method in class com.io7m.jade.vanilla.AbstractDirectories
- SystemSelection - Class in com.io7m.jade.vanilla
- SystemSelection() - Constructor for class com.io7m.jade.vanilla.SystemSelection
T
- toString() - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration
-
Prints the immutable value
ApplicationDirectoryConfigurationwith attribute values.
V
- VALID_NAMES - Static variable in class com.io7m.jade.spi.ApplicationNames
-
The pattern that defines a valid application name.
W
- withApplicationName(String) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration
-
Copy the current immutable object by setting a value for the
applicationNameattribute. - withPortablePropertyName(String) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration
-
Copy the current immutable object by setting a present value for the optional
portablePropertyNameattribute. - withPortablePropertyName(Optional<String>) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration
-
Copy the current immutable object by setting an optional value for the
portablePropertyNameattribute.
All Classes All Packages