jodd.util

Class CommandLine

java.lang.Object

jodd.util.CommandLine

public class CommandLine
extends java.lang.Object

Simple user-friendly wrapper over ProcessBuilder. Has the following:

• fluent interface
• no exception is throw
• output is collected to string
• easy environment manipulation

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cleanEnvironment
protected java.util.List<java.lang.String>	cmdLine
protected java.util.Map<java.lang.String,java.lang.String>	env
protected java.io.OutputStream	err
protected java.lang.String	errPrefix
static int	OK
protected java.io.OutputStream	out
protected java.lang.String	outPrefix
protected java.io.File	workingDirectory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandLine(java.lang.String command)

Method Summary

Modifier and Type	Method and Description
CommandLine	arg(java.lang.String argument) Adds single argument.
CommandLine	args(java.lang.String... arguments) Adds several arguments.
static CommandLine	cmd(java.lang.String command) Creates command line with given command.
CommandLine	env(java.lang.String key, java.lang.String value) Sets environment variable.
CommandLine	err(java.io.OutputStream err)
CommandLine	errPrefix(java.lang.String prefix) Defines error prefix.
CommandLine	newEnv(boolean clean) When set to true, environment will not be copied from the parent process and will be completly empty.
CommandLine	out(java.io.OutputStream out)
CommandLine	outPrefix(java.lang.String prefix) Defines output prefix.
ProcessRunner.ProcessResult	run() Runs command and returns process result.
CommandLine	workingDirectory(java.io.File workDirectory) Defines working directory.
CommandLine	workingDirectory(java.lang.String workDirectory) Defines working directory.

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final int OK

See Also:

Constant Field Values

cmdLine

protected final java.util.List<java.lang.String> cmdLine

env

protected java.util.Map<java.lang.String,java.lang.String> env

cleanEnvironment

protected boolean cleanEnvironment

workingDirectory

protected java.io.File workingDirectory

outPrefix

protected java.lang.String outPrefix

errPrefix

protected java.lang.String errPrefix

out

protected java.io.OutputStream out

err

protected java.io.OutputStream err

Constructor Detail

CommandLine

protected CommandLine(java.lang.String command)

Method Detail

cmd

public static CommandLine cmd(java.lang.String command)

Creates command line with given command.

workingDirectory

public CommandLine workingDirectory(java.io.File workDirectory)

Defines working directory.

workingDirectory

public CommandLine workingDirectory(java.lang.String workDirectory)

Defines working directory.

arg

public CommandLine arg(java.lang.String argument)

Adds single argument.

args

public CommandLine args(java.lang.String... arguments)

Adds several arguments.

outPrefix

public CommandLine outPrefix(java.lang.String prefix)

Defines output prefix.

errPrefix

public CommandLine errPrefix(java.lang.String prefix)

Defines error prefix.

out

public CommandLine out(java.io.OutputStream out)

err

public CommandLine err(java.io.OutputStream err)

env

public CommandLine env(java.lang.String key,
                       java.lang.String value)

Sets environment variable.

newEnv

public CommandLine newEnv(boolean clean)

When set to true, environment will not be copied from the parent process and will be completly empty.

run

public ProcessRunner.ProcessResult run()

Runs command and returns process result.