Index

A B C D E F G H I O P S T V W
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: An abstraction over the application's execution environment.
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 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 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: Retrieve the value of an environment variable.
equals(Object) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration: This instance is equal to all instances of ApplicationDirectoryConfiguration that 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 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.spi.ApplicationDirectoryConfiguration: Computes a hash code from attributes: applicationName, portablePropertyName, overridePropertyName.

I

initialize(ApplicationDirectoryConfiguration, 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(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

O

overridePropertyName() - Method in class com.io7m.jade.spi.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.spi.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.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

servicesFor(Class<S>) - Method in interface com.io7m.jade.spi.ApplicationEnvironmentType
setApplicationName(String) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder: Initializes the value for the applicationName attribute.
setOverridePropertyName(String) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder: Initializes the optional value overridePropertyName to overridePropertyName.
setOverridePropertyName(Optional<String>) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder: Initializes the optional value overridePropertyName to overridePropertyName.
setPortablePropertyName(String) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder: Initializes the optional value portablePropertyName to portablePropertyName.
setPortablePropertyName(Optional<String>) - Method in class com.io7m.jade.spi.ApplicationDirectoryConfiguration.Builder: Initializes the optional value portablePropertyName to 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: Retrieve the value of a system property.
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 ApplicationDirectoryConfiguration with 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 applicationName attribute.
withOverridePropertyName(String) - Method in class com.io7m.jade.spi.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.spi.ApplicationDirectoryConfiguration: Copy the current immutable object by setting an optional value for the overridePropertyName attribute.
withPortablePropertyName(String) - Method in class com.io7m.jade.spi.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.spi.ApplicationDirectoryConfiguration: Copy the current immutable object by setting an optional value for the portablePropertyName attribute.

A B C D E F G H I O P S T V W
All Classes All Packages