A B C E F G H I L M N O P S T V

A

addTempFile(Path) - Method in class Capsule

ATTR_APP_ARTIFACT - Static variable in class Capsule

ATTR_APP_CLASS - Static variable in class Capsule

ATTR_APP_CLASS_PATH - Static variable in class Capsule

ATTR_APP_ID - Static variable in class Capsule

The application's unique ID.

ATTR_APP_NAME - Static variable in class Capsule

The application's name.

ATTR_APP_VERSION - Static variable in class Capsule

ATTR_BOOT_CLASS_PATH - Static variable in class Capsule

ATTR_BOOT_CLASS_PATH_A - Static variable in class Capsule

ATTR_BOOT_CLASS_PATH_P - Static variable in class Capsule

ATTR_CAPLETS - Static variable in class Capsule

ATTR_CAPSULE_IN_CLASS_PATH - Static variable in class Capsule

ATTR_DEPENDENCIES - Static variable in class Capsule

ATTR_JAVA_AGENTS - Static variable in class Capsule

ATTR_JAVA_VERSION - Static variable in class Capsule

ATTR_JDK_REQUIRED - Static variable in class Capsule

ATTR_JVM_ARGS - Static variable in class Capsule

ATTR_LIBRARY_PATH_A - Static variable in class Capsule

ATTR_LIBRARY_PATH_P - Static variable in class Capsule

ATTR_MIN_JAVA_VERSION - Static variable in class Capsule

ATTR_MIN_UPDATE_VERSION - Static variable in class Capsule

ATTR_NATIVE_AGENTS - Static variable in class Capsule

ATTR_NATIVE_DEPENDENCIES - Static variable in class Capsule

ATTR_SECURITY_MANAGER - Static variable in class Capsule

ATTR_SECURITY_POLICY - Static variable in class Capsule

ATTR_SECURITY_POLICY_A - Static variable in class Capsule

ATTR_SYSTEM_PROPERTIES - Static variable in class Capsule

ATTRIBUTE(String, T, T, boolean, String) - Static method in class Capsule

Registers a manifest attribute.

attribute(Map.Entry<String, T>) - Method in class Capsule

CAPLET OVERRIDE ONLY: Returns the value of the given capsule attribute with consideration to the capsule's mode.

B

buildAppCacheDir() - Method in class Capsule

Returns the path of the application cache (this is the directory where the capsule is extracted if necessary).

buildArgs(List<String>) - Method in class Capsule

Returns a list of command line arguments to pass to the application.

buildEnvironmentVariables(Map<String, String>) - Method in class Capsule

Returns a map of environment variables (property-value pairs).

buildProcess() - Method in class Capsule

Constructs a ProcessBuilder that is later used to launch the capsule.

C

Capsule - Class in <Unnamed>

An application capsule.

Capsule(Path) - Constructor for class Capsule

Constructs a capsule.

Capsule(Capsule) - Constructor for class Capsule

Caplets that will be listed on the manifest's Caplets attribute must use this constructor.

chooseJavaHome() - Method in class Capsule

Chooses which Java installation to use for running the app.

chooseLogLevel() - Method in class Capsule

Chooses and returns the capsules log level.

chooseMode() - Method in class Capsule

Chooses this capsule's mode.

cleanup() - Method in class Capsule

Called when the capsule exits after a successful or failed attempt to launch the application.

compareVersions(String, String, int) - Static method in class Capsule

Compares two dotted software versions, regarding only the first several version components.

compareVersions(String, String) - Static method in class Capsule

Compares two dotted software versions.

E

exec(String...) - Static method in class Capsule

Executes a command and returns its output as a list of lines.

exec(int, String...) - Static method in class Capsule

Executes a command and returns its output as a list of lines.

exec(ProcessBuilder) - Static method in class Capsule

Executes a command and returns its output as a list of lines.

exec(int, ProcessBuilder) - Static method in class Capsule

Executes a command and returns its output as a list of lines.

extractCapsule(Path) - Method in class Capsule

Extracts the capsule's contents into the app cache directory.

F

finalizeCapsule() - Method in class Capsule

Called once the capsule construction has been completed (after loading of wrapped capsule, if applicable).

G

getAppCache() - Method in class Capsule

This capsule's cache directory, or null if capsule has been configured not to extract, or the app cache dir hasn't been set up yet.

getAppId() - Method in class Capsule

Returns the app's ID.

getAttribute(Map.Entry<String, T>) - Method in class Capsule

Returns the value of the given manifest attribute with consideration to the capsule's mode.

getCallTarget(Class<T>) - Method in class Capsule

getEntryInputStream(Path, String) - Static method in class Capsule

getenv(String) - Static method in class Capsule

Returns the value of an environment variable - should be used instead of System.getenv(envName).

getJarFile() - Method in class Capsule

This capsule's JAR file.

getJavaExecutable() - Method in class Capsule

Returns the path to the executable that will be used to launch Java.

getJavaExecutable(Path) - Static method in class Capsule

Finds the path to the executable that will be used to launch Java within the given javaHome.

getJavaHome() - Method in class Capsule

The path to the Java installation this capsule's app will use.

getJavaHomes() - Static method in class Capsule

Returns all found Java installations.

getLogLevel() - Static method in class Capsule

Capsule's log level

getMode() - Method in class Capsule

This capsule's current mode.

getModeDescription(String) - Method in class Capsule

Returns the description of the given mode.

getModes() - Method in class Capsule

Returns the names of all modes defined in this capsule's manifest.

getNativeLibExtension() - Static method in class Capsule

The suffix of a native library on this OS.

getPermissions(Path) - Static method in class Capsule

Returns the permissions of the given file or directory.

getPlatformNativeLibraryPath() - Method in class Capsule

Returns the default native library path for the Java platform the application uses.

getProperty(String) - Static method in class Capsule

Returns a system property - should be used instead of System.getProperty(propName).

getVarValue(String) - Method in class Capsule

Resolves $VARNAME or ${VARNAME} in attribute values.

getWritableAppCache() - Method in class Capsule

Returns a writable directory that can be used to store files related to launching the capsule.

H

hasAttribute(Map.Entry<String, ?>) - Method in class Capsule

Tests whether the given attribute is found in the manifest.

hasCaplet(String) - Method in class Capsule

Checks whether a caplet with the given class name is installed.

I

isEmptyCapsule() - Method in class Capsule

isLogging(int) - Static method in class Capsule

Tests if the given log level is currently being logged.

isMac() - Static method in class Capsule

Tests whether the current OS is MacOS.

isUnix() - Static method in class Capsule

Tests whether the current OS is UNIX/Linux.

isWindows() - Static method in class Capsule

Tests whether the current OS is Windows.

isWrapperCapsule() - Method in class Capsule

Whether or not this is an empty capsule

L

listDir(Path, String, boolean) - Static method in class Capsule

Returns the contents of a directory.

loadTargetCapsule(ClassLoader, Path) - Method in class Capsule

Loads the wrapped capsule when this capsule is the wrapper.

log(int, String) - Static method in class Capsule

Prints a message to stderr if the given log-level is being logged.

LOG_DEBUG - Static variable in class Capsule

LOG_NONE - Static variable in class Capsule

LOG_QUIET - Static variable in class Capsule

LOG_VERBOSE - Static variable in class Capsule

M

main(String[]) - Static method in class Capsule

move(Path, Path, Path) - Static method in class Capsule

Returns a path to a file or directory moved from fromDir to toDir.

N

name(Map.Entry<String, ?>) - Method in class Capsule

Returns an attribute's name.

O

onError(Throwable) - Method in class Capsule

Called when an unhandled exception is thrown, to display error information to the user before shutting down.

OPTION(String, String, String, boolean, String) - Static method in class Capsule

Registers a capsule command-line option.

OPTION(String, String, String, String) - Static method in class Capsule

Same as OPTION(optionName, defaultValue, methodName, wrapperOnly, description).

P

postlaunch(Process) - Method in class Capsule

Called after the application is launched by the capsule.

prelaunch(List<String>, List<String>) - Method in class Capsule

Returns a configured ProcessBuilder that is later used to launch the capsule.

processOutgoingPath(Path) - Method in class Capsule

Every path emitted by the capsule to the app's command line, system properties or environment variables is first passed through this method.

S

setProperty(String, String) - Static method in class Capsule

Sets a system property.

STDERR - Static variable in class Capsule

STDOUT - Static variable in class Capsule

sup(Class<T>) - Method in class Capsule

The first caplet in the caplet chain starting with the current one and going up (back) that is of the requested type.

T

T_BOOL() - Static method in class Capsule

Represents the attribute type Boolean

T_DOUBLE() - Static method in class Capsule

Represents the attribute type Double

T_LIST(E) - Static method in class Capsule

A List of type type

T_LONG() - Static method in class Capsule

Represents the attribute type Long

T_MAP(E, E) - Static method in class Capsule

A Map from String to type type

T_SET(E) - Static method in class Capsule

A Set of type type

T_STRING() - Static method in class Capsule

Represents the attribute type String

toString() - Method in class Capsule

V

verifyAppCache() - Method in class Capsule

Returns this capsule's cache directory.

VERSION - Static variable in class Capsule

A B C E F G H I L M N O P S T V