co.paralleluniverse.capsule

Class CapsuleUtils

java.lang.Object

co.paralleluniverse.capsule.CapsuleUtils

public final class CapsuleUtils
extends Object

A utility class that can be used by code launched in a capsule to interact with the capsule.

Method Summary

Modifier and Type	Method and Description
static String	getAppId() Returns this capsule's app ID.
static Path	getCapsuleAppDir() Returns the full path to the capsule's app cache directory.
static Path	getCapsuleJar() Returns the full path to the capsule's JAR.
static boolean	isRunningInCapsule() Tests if we're running in a capsule.

Methods inherited from class java.lang.Object

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

Method Detail

isRunningInCapsule

public static boolean isRunningInCapsule()

Tests if we're running in a capsule.

Returns:

true if this code has been launched in a capsule, or false otherwise.

getAppId

public static String getAppId()

Returns this capsule's app ID.

Throws:

IllegalStateException - if this code has not been launched in a capsule.

getCapsuleJar

public static Path getCapsuleJar()

Returns the full path to the capsule's JAR.

Throws:

IllegalStateException - if this code has not been launched in a capsule.

getCapsuleAppDir

public static Path getCapsuleAppDir()

Returns the full path to the capsule's app cache directory. The app's cache directory is where this app's capsule has been extracted.

Returns:

the full path to the capsule's app cache directory or null, if the capsule has not been extracted.

Throws:

IllegalStateException - if this code has not been launched in a capsule.