co.paralleluniverse.capsule

Interface Capsule

public interface Capsule

A capsule.

Method Summary

Modifier and Type	Method and Description
String	getAppId() Returns a capsule's ID..
<T> T	getAttribute(Attribute<T> attr) Returns the value of the given manifest attribute with consideration to the capsule's mode.
List<Class<?>>	getCaplets() Returns a list of all caplet classes, in order.
Set<String>	getModes() Returns the capsule's supported modes.
Properties	getProperties() The properties used by the capsule.
String	getVersion() Returns the capsule's version.
boolean	hasAttribute(Attribute<?> attr) Tests whether the given attribute is found in the manifest.
boolean	hasCaplet(String name) Checks whether a caplet with the given class name is installed.
ProcessBuilder	prepareForLaunch(List<String> jvmArgs, List<String> args) Creates a ProcessBuilder ready to use for launching the capsule.

Method Detail

getVersion

String getVersion()

Returns the capsule's version.

getProperties

Properties getProperties()

The properties used by the capsule. These may be set to change the capsule's behavior.

getAppId

String getAppId()

Returns a capsule's ID..

getModes

Set<String> getModes()

Returns the capsule's supported modes.

hasAttribute

boolean hasAttribute(Attribute<?> attr)

Tests whether the given attribute is found in the manifest.

getAttribute

<T> T getAttribute(Attribute<T> attr)

Returns the value of the given manifest attribute with consideration to the capsule's mode. If the attribute is not defined, its default value will be returned.

hasCaplet

boolean hasCaplet(String name)

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

getCaplets

List<Class<?>> getCaplets()

Returns a list of all caplet classes, in order.

prepareForLaunch

ProcessBuilder prepareForLaunch(List<String> jvmArgs,
                                List<String> args)

Creates a ProcessBuilder ready to use for launching the capsule.

Parameters:

jvmArgs - JVM arguments to use for launching the capsule

args - command line arguments to pass to the capsule.

Returns:

a ProcessBuilder for launching the capsule process