org.openksavi.sponge.core.util

Class ProcessConfiguration.Builder

java.lang.Object

org.openksavi.sponge.core.util.ProcessConfiguration.Builder

Enclosing class:

ProcessConfiguration

public static class ProcessConfiguration.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(String executable)

Method Summary

Modifier and Type	Method and Description
ProcessConfiguration.Builder	arguments(List<String> arguments) Add the process arguments.
ProcessConfiguration.Builder	arguments(String... arguments) Adds the process arguments.
ProcessConfiguration	build()
ProcessConfiguration.Builder	charset(Charset charset) Sets the charset of the subprocess output stream used if the redirectType is RedirectType.STRING.
ProcessConfiguration.Builder	env(Map<String,String> env) Adds the environment variables.
ProcessConfiguration.Builder	env(String name, String value) Adds the environment variable.
ProcessConfiguration.Builder	name(String name) Sets the process display name.
ProcessConfiguration.Builder	redirectType(ProcessConfiguration.RedirectType redirectType) Sets the redirect type.
ProcessConfiguration.Builder	waitForOutputLineRegexp(String waitForOutputLineRegexp) Sets the Java regular expression of a line from the process output stream.
ProcessConfiguration.Builder	waitForOutputLineTimeout(Long waitForOutputLineTimeout) Sets the timeout for waiting for a specific line from the process output stream (in seconds).
ProcessConfiguration.Builder	waitSeconds(Long waitSeconds) Sets the maximum number of seconds to wait after the start of the process.
ProcessConfiguration.Builder	workingDir(String workingDir) Sets the process working directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String executable)

Method Detail

build

public ProcessConfiguration build()

name

public ProcessConfiguration.Builder name(String name)

Sets the process display name.

Parameters:

name - the process display name.

Returns:

this builder.

arguments

public ProcessConfiguration.Builder arguments(String... arguments)

Adds the process arguments.

Parameters:

arguments - the process arguments.

Returns:

this builder.

arguments

public ProcessConfiguration.Builder arguments(List<String> arguments)

Add the process arguments.

Parameters:

arguments - the process arguments.

Returns:

this builder.

workingDir

public ProcessConfiguration.Builder workingDir(String workingDir)

Sets the process working directory.

Parameters:

workingDir - the process working directory. If null (the default value) then the current directory will be used.

Returns:

this builder.

env

public ProcessConfiguration.Builder env(String name,
                                        String value)

Adds the environment variable.

Parameters:

name - the environment variable name.

value - the environment variable value.

Returns:

this builder.

env

public ProcessConfiguration.Builder env(Map<String,String> env)

Adds the environment variables.

Parameters:

env - the environment variables.

Returns:

this builder.

waitSeconds

public ProcessConfiguration.Builder waitSeconds(Long waitSeconds)

Sets the maximum number of seconds to wait after the start of the process. The thread that started the process will be blocked until the time elapses or the subprocess exits.

Parameters:

waitSeconds - the maximum number of seconds to wait or null (the default value) if the thread shouldn't wait.

Returns:

this builder.

redirectType

public ProcessConfiguration.Builder redirectType(ProcessConfiguration.RedirectType redirectType)

Sets the redirect type. The default value is RedirectType.INHERIT.

Parameters:

redirectType - the redirect type.

Returns:

this builder.

charset

public ProcessConfiguration.Builder charset(Charset charset)

Sets the charset of the subprocess output stream used if the redirectType is RedirectType.STRING.

Parameters:

charset - the charset.

Returns:

this builder.

waitForOutputLineRegexp

public ProcessConfiguration.Builder waitForOutputLineRegexp(String waitForOutputLineRegexp)

Sets the Java regular expression of a line from the process output stream. The thread that started the process will wait (blocking) for such line.

Parameters:

waitForOutputLineRegexp - the Java regular expression or null if the thread shouldn't wait for a specific line.

Returns:

this builder.

waitForOutputLineTimeout

public ProcessConfiguration.Builder waitForOutputLineTimeout(Long waitForOutputLineTimeout)

Sets the timeout for waiting for a specific line from the process output stream (in seconds). If the timeout is exceeded, the exception will be thrown.

Parameters:

waitForOutputLineTimeout - the timeout for waiting for a specific line or null if the thread could wait indefinitely.

Returns:

this builder.