Capsule (capsule 0.7.1 API)

java.lang.Object
- Capsule

All Implemented Interfaces:: Runnable

public class Capsule
extends Object
implements Runnable

Constructor Summary

Constructors
Modifier Constructor and Description

protected Capsule(Path jarFile, Path cacheDir)
Constructs a capsule from the given JAR file

Constructors
Modifier	Constructor and Description
`protected`	`Capsule(Path jarFile, Path cacheDir)` Constructs a capsule from the given JAR file

Method Summary

Methods
Modifier and Type	Method and Description
`protected List<String>`	`buildArgs(String[] args)` Returns a list of command line arguments to pass to the application.
`protected List<Path>`	`buildBootClassPath()` Compiles and returns the application's boot classpath as a list of paths.
`protected List<Path>`	`buildBootClassPathA()` Compiles and returns the paths to be appended to the application's boot classpath.
`protected List<Path>`	`buildBootClassPathP()` Compiles and returns the paths to be prepended to the application's boot classpath.
`protected List<Path>`	`buildClassPath()` Compiles and returns the application's classpath as a list of paths.
`protected void`	`buildEnvironmentVariables(Map<String,String> env)` Returns a map of environment variables (property-value pairs).
`protected List<String>`	`buildJVMArgs()` Returns a list of JVM arguments.
`protected Map<String,String>`	`buildSystemProperties()` Returns a map of system properties (property-value pairs).
`protected Object`	`clone()`
`protected Manifest`	`configureManifest(Manifest manifest)`
`boolean`	`equals(Object obj)`
`protected String`	`expand(String str)` Expands occurrences of `$VARNAME` in attribute values.
`protected String`	`getAppId()`
`protected String`	`getAttribute(String attr)`
`protected List<String>`	`getDependencies()` Returns a list of dependencies, each in the format `groupId:artifactId:version[:classifier]` (classifier is optional)
`protected List<String>`	`getListAttribute(String attr)`
`protected Map<String,String>`	`getMapAttribute(String attr, String defaultValue)`
`protected List<String>`	`getNativeDependenciesAndRename()` Returns a list of dependencies, each in the format `groupId:artifactId:version[:classifier][,renameTo]` (classifier and renameTo are optional)
`protected boolean`	`hasAttribute(String attr)`
`int`	`hashCode()`
`protected static boolean`	`isMac()`
`protected static boolean`	`isUnix()`
`protected static boolean`	`isWindows()`
`protected static List<Path>`	`listDir(Path dir)`
`static void`	`main(String[] args)` Launches the application
`void`	`run()`
`protected List<String>`	`stripNativeDependencies(List<String> nativeDepsAndRename)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Capsule
```
protected Capsule(Path jarFile,
       Path cacheDir)
```
    Constructs a capsule from the given JAR file
    
    Parameters:
    jarFile - the path to the JAR file
    cacheDir - the path to the (shared) Capsule cache directory
- Method Detail
  - main
```
public static final void main(String[] args)
```
    Launches the application
    
    Parameters:
    args - the program's command-line arguments
  - configureManifest
```
protected Manifest configureManifest(Manifest manifest)
                              throws IOException
```
    Throws:
    
    IOException
  - buildArgs
```
protected List<String> buildArgs(String[] args)
```
    Returns a list of command line arguments to pass to the application.
    
    Parameters:
    args - The command line arguments passed to the capsule at launch
  - buildEnvironmentVariables
```
protected void buildEnvironmentVariables(Map<String,String> env)
```
    Returns a map of environment variables (property-value pairs).
    
    Parameters:
    env - the current environment
  - getAppId
```
protected String getAppId()
```
  - buildClassPath
```
protected List<Path> buildClassPath()
```
    Compiles and returns the application's classpath as a list of paths.
  - getDependencies
```
protected List<String> getDependencies()
```
    Returns a list of dependencies, each in the format groupId:artifactId:version[:classifier] (classifier is optional)
  - buildBootClassPath
```
protected List<Path> buildBootClassPath()
```
    Compiles and returns the application's boot classpath as a list of paths.
  - buildBootClassPathP
```
protected List<Path> buildBootClassPathP()
```
    Compiles and returns the paths to be prepended to the application's boot classpath.
  - buildBootClassPathA
```
protected List<Path> buildBootClassPathA()
```
    Compiles and returns the paths to be appended to the application's boot classpath.
  - buildSystemProperties
```
protected Map<String,String> buildSystemProperties()
```
    Returns a map of system properties (property-value pairs).
  - getNativeDependenciesAndRename
```
protected List<String> getNativeDependenciesAndRename()
```
    Returns a list of dependencies, each in the format groupId:artifactId:version[:classifier][,renameTo] (classifier and renameTo are optional)
  - stripNativeDependencies
```
protected final List<String> stripNativeDependencies(List<String> nativeDepsAndRename)
```
  - buildJVMArgs
```
protected List<String> buildJVMArgs()
```
    Returns a list of JVM arguments.
  - getAttribute
```
protected final String getAttribute(String attr)
```
  - hasAttribute
```
protected final boolean hasAttribute(String attr)
```
  - getListAttribute
```
protected final List<String> getListAttribute(String attr)
```
  - getMapAttribute
```
protected final Map<String,String> getMapAttribute(String attr,
                                 String defaultValue)
```
  - isWindows
```
protected static final boolean isWindows()
```
  - isMac
```
protected static final boolean isMac()
```
  - isUnix
```
protected static final boolean isUnix()
```
  - listDir
```
protected static final List<Path> listDir(Path dir)
```
  - expand
```
protected String expand(String str)
```
    Expands occurrences of $VARNAME in attribute values.
    
    Parameters:
    str - the original string
    
    Returns:
    the expanded string
  - run
```
public final void run()
```
    Specified by:
    
    run in interface Runnable
  - clone
```
protected final Object clone()
                      throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Capsule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Capsule

Method Detail

main

configureManifest

buildArgs

buildEnvironmentVariables

getAppId

buildClassPath

getDependencies

buildBootClassPath

buildBootClassPathP

buildBootClassPathA

buildSystemProperties

getNativeDependenciesAndRename

stripNativeDependencies

buildJVMArgs

getAttribute

hasAttribute

getListAttribute

getMapAttribute

isWindows

isMac

isUnix

listDir

expand

run

clone

hashCode

equals

toString