dev.jeka.core.api.java

Class JkJavaProcess

java.lang.Object

dev.jeka.core.api.system.JkAbstractProcess<JkJavaProcess>

dev.jeka.core.api.java.JkJavaProcess

All Implemented Interfaces:

java.lang.Runnable

public class JkJavaProcess
extends JkAbstractProcess<JkJavaProcess>

Offers fluent interface for launching Java processes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.file.Path	CURRENT_JAVA_EXEC_DIR
static java.nio.file.Path	CURRENT_JAVA_HOME

Fields inherited from class dev.jeka.core.api.system.JkAbstractProcess

CURRENT_JAVA_DIR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JkJavaProcess()
protected	JkJavaProcess(JkJavaProcess other)

Method Summary

Modifier and Type	Method and Description
JkJavaProcess	addAgent(java.nio.file.Path agentLib, java.lang.String agentOption) Adds the specified agent to the command line.
JkJavaProcess	addJavaOptions(java.util.Collection<java.lang.String> options) Adds the specified java options to the command line.
JkJavaProcess	addJavaOptions(java.lang.String... options) Adds the specified java options to the command line.
JkJavaProcess	addJavaOptionsIf(boolean condition, java.lang.String... options) Adds the specified Java options to the command line if the given condition is true.
JkJavaProcess	addSystemProperty(java.lang.String key, java.lang.String value) Adds a system property to the command line parameters.
JkJavaProcess	copy() Creates a copy of the current JkJavaProcess instance with the same properties.
protected void	customizeCommand() Modifies the command and its execution parameters.
static JkJavaProcess	ofJava(java.lang.String className) Creates a process launching the current JDK java command on the specified class.
static JkJavaProcess	ofJavaJar(java.nio.file.Path jar) Creates a process launching the current JDK java command to execute the specified jar.
static JkJavaProcess	ofJavaJar(java.nio.file.Path jar, java.lang.String className) Creates a process launching the current JDK java command to execute the specified jar.
JkJavaProcess	setClasspath(java.lang.Iterable<java.nio.file.Path> paths) Convenient method to set classpath option.
JkJavaProcess	setInheritSystemProperties(boolean inheritSystemProperties) Sets whether the process should inherit system properties from the parent process.

Methods inherited from class dev.jeka.core.api.system.JkAbstractProcess

addParams, addParams, addParamsAsCmdLine, addParamsAt, addParamsAt, addParamsIf, exec, execAsync, execCmd, execCmdLine, getParamAt, getParams, getWorkingDir, inheritJkLogOptions, isFailOnError, redirectErrorStream, removeParam, run, setCollectStderr, setCollectStdout, setDestroyAtJvmShutdown, setEnv, setFailOnError, setInheritIO, setLogCommand, setLogWithJekaDecorator, setParamAt, setWorkingDir, setWorkingDir, toString

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_JAVA_HOME

public static final java.nio.file.Path CURRENT_JAVA_HOME

CURRENT_JAVA_EXEC_DIR

public static final java.nio.file.Path CURRENT_JAVA_EXEC_DIR

Constructor Detail

JkJavaProcess

protected JkJavaProcess()

JkJavaProcess

protected JkJavaProcess(JkJavaProcess other)

Method Detail

ofJava

public static JkJavaProcess ofJava(java.lang.String className)

Creates a process launching the current JDK java command on the specified class.

ofJavaJar

public static JkJavaProcess ofJavaJar(java.nio.file.Path jar,
                                      java.lang.String className)

Creates a process launching the current JDK java command to execute the specified jar.

Parameters:

className - Can be null.

ofJavaJar

public static JkJavaProcess ofJavaJar(java.nio.file.Path jar)

Creates a process launching the current JDK java command to execute the specified jar. This method assumes that a main method is specified in the jar manifest.

addAgent

public JkJavaProcess addAgent(java.nio.file.Path agentLib,
                              java.lang.String agentOption)

Adds the specified agent to the command line.

Parameters:

agentOption - Can be null

addJavaOptions

public JkJavaProcess addJavaOptions(java.util.Collection<java.lang.String> options)

Adds the specified java options to the command line. Options are command line parameters prepending the Java class parameter.

addJavaOptionsIf

public JkJavaProcess addJavaOptionsIf(boolean condition,
                                      java.lang.String... options)

Adds the specified Java options to the command line if the given condition is true.

See Also:

addJavaOptions(Collection)

addJavaOptions

public JkJavaProcess addJavaOptions(java.lang.String... options)

Adds the specified java options to the command line.

See Also:

addJavaOptions(Collection)

setClasspath

public JkJavaProcess setClasspath(java.lang.Iterable<java.nio.file.Path> paths)

Convenient method to set classpath option.

addSystemProperty

public JkJavaProcess addSystemProperty(java.lang.String key,
                                       java.lang.String value)

Adds a system property to the command line parameters.

setInheritSystemProperties

public JkJavaProcess setInheritSystemProperties(boolean inheritSystemProperties)

Sets whether the process should inherit system properties from the parent process.

copy

public JkJavaProcess copy()

Creates a copy of the current JkJavaProcess instance with the same properties.

Overrides:

copy in class JkAbstractProcess<JkJavaProcess>

customizeCommand

protected void customizeCommand()

Description copied from class: JkAbstractProcess

Modifies the command and its execution parameters.

This method provides a way for subclasses to adjust the process before it is run.

Overrides:

customizeCommand in class JkAbstractProcess<JkJavaProcess>