JavaProcessBuilder (core 2.2.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jlibs.core.lang
Class JavaProcessBuilder

java.lang.Object
  jlibs.core.lang.JavaProcessBuilder

public class JavaProcessBuilder
extends Object
extends Object

Similar to ProcessBuilder, this class makes the java process creation easier.

This class simply manages collection of java process attributes and help your to create command out of it.

 JavaProcessBuilder jvm = new JavaProcessBuilder();

JavaProcessBuilder is pre-configured with current java home and current working directory initially.
you can change them as below:

 jvm.javaHome(new File("c:/jdk5")); // to configure java home
 jvm.workingDir(new File("c:/myProject")); // to configure working directory

To configure various attributes:

 // to configure classpath
 jvm.classpath("lib/jlibs-core.jar") // relative path from configured working dir
    .classpath(new File("c:/myproject/lib/jlibs-xml.jar");

 // to get configured classpath
 List classpath = jvm.classpath();

 // to configure additional classpath
 jvm.endorsedDir("lib/endorsed")
    .extDir("lib/ext")
    .libraryPath("lib/native")
    .bootClasspath("lib/boot/xerces.jar")
    .appendBootClasspath("lib/boot/xalan.jar")
    .prependBootClasspath("lib/boot/dom.jar");

 // to configure System Properties
 jvm.systemProperty("myprop", "myvalue")
    .systemProperty("myflag");

 // to configure heap and vmtype
 jvm.initialHeap(512); // or jvm.initialHeap("512m");
 jvm.maxHeap(1024); // or jvm.maxHeap("1024m");
 jvm.client(); // to use -client
 jvm.server(); // to use -server

 // to configure remote debugging
 jvm.debugPort(7000)
    .debugSuspend(true);

 // to configure any additional jvm args
 jvm.jvmArg("-Xgc:somealgo");

 // to configure mainclass and its arguments
 jvm.mainClass("example.MyTest")
    .arg("-xvf")
    .arg("testDir");

To get the created command:

 String command[] = jvm.command();

Any relative paths specified, will get resolved relative to working directory during command creation.

To launch it:

 Process p = jvm.launch(System.out, System.err);

the two arguments to launch(...) specify to which process output and error streams to be redirected. These arguments can be null, if you don't want them to be redirected.

Author:: Santhosh Kumar T

Constructor Summary
`JavaProcessBuilder()`

Method Summary
`List<File>`	`appendBootClasspath()`
`JavaProcessBuilder`	`appendBootClasspath(File resource)`
`JavaProcessBuilder`	`appendBootClasspath(String resource)`
`JavaProcessBuilder`	`arg(String arg)`
`List<String>`	`args()`
`List<File>`	`bootClasspath()`
`JavaProcessBuilder`	`bootClasspath(File resource)`
`JavaProcessBuilder`	`bootClasspath(String resource)`
`List<File>`	`classpath()`
`JavaProcessBuilder`	`classpath(File resource)`
`JavaProcessBuilder`	`classpath(String resource)`
`JavaProcessBuilder`	`client()`
`String[]`	`command()` Returns command with all its arguments
`int`	`debugPort()`
`JavaProcessBuilder`	`debugPort(int port)`
`boolean`	`debugSuspend()`
`JavaProcessBuilder`	`debugSuspend(boolean suspend)`
`JavaProcessBuilder`	`endorsedDir(File dir)`
`JavaProcessBuilder`	`endorsedDir(String dir)`
`List<File>`	`endorsedDirs()`
`JavaProcessBuilder`	`extDir(File dir)`
`JavaProcessBuilder`	`extDir(String dir)`
`List<File>`	`extDirs()`
`String`	`initialHeap()`
`JavaProcessBuilder`	`initialHeap(int mb)`
`JavaProcessBuilder`	`initialHeap(String size)`
`File`	`javaHome()`
`JavaProcessBuilder`	`javaHome(File javaHome)`
`JavaProcessBuilder`	`jvmArg(String arg)`
`List<String>`	`jvmArgs()`
`Process`	`launch(OutputStream output, OutputStream error)` launches jvm with current configuration.
`List<File>`	`libraryPath()`
`JavaProcessBuilder`	`libraryPath(File dir)`
`JavaProcessBuilder`	`libraryPath(String dir)`
`String`	`mainClass()`
`JavaProcessBuilder`	`mainClass(String mainClass)`
`String`	`maxHeap()`
`JavaProcessBuilder`	`maxHeap(int mb)`
`JavaProcessBuilder`	`maxHeap(String size)`
`List<File>`	`prependBootClasspath()`
`JavaProcessBuilder`	`prependBootClasspath(File resource)`
`JavaProcessBuilder`	`prependBootClasspath(String resource)`
`JavaProcessBuilder`	`server()`
`Map<String,String>`	`systemProperties()`
`JavaProcessBuilder`	`systemProperty(String name)`
`JavaProcessBuilder`	`systemProperty(String name, String value)`
`String`	`vmType()`
`File`	`workingDir()`
`JavaProcessBuilder`	`workingDir(File dir)`
`JavaProcessBuilder`	`workingDir(String dir)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail