de.mklinger.commons.exec

Class Cmd

java.lang.Object

de.mklinger.commons.exec.Cmd

public class Cmd
extends Object

A command. It may be not be started yet, it may be running right now or it may be terminated. Other parties (i.e. Threads) may be waiting for it to terminate or doing progress.

Instances of this class should usually be created using CmdBuilder.

Author:

Marc Klinger - mklinger[at]mklinger[dot]de - klingerm

Constructor Summary

Constructors

Constructor and Description
Cmd(CmdSettings cmdSettings)

Method Summary

Modifier and Type	Method and Description
void	close()
void	destroy()
void	destroyForcibly()
void	execute() Start the process and wait for it to exit.
int	exitValue()
boolean	isExecuting()
void	start() Start the process and return immediately.
String	toString()
int	waitFor() Wait for an already started process.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cmd

public Cmd(CmdSettings cmdSettings)

Method Detail

execute

public void execute()
             throws CmdException

Start the process and wait for it to exit.

Throws:

CmdException - in case of an error

CmdInterruptedException - if the waiting thread was interrupted. The interruption state of the current thread is set to interrupted.

start

public void start()
           throws CmdException

Start the process and return immediately. Cmds started with this method must be closed or destroyed at some point in future.

Throws:

CmdException - in case of an error

waitFor

public int waitFor()
            throws CmdException,
                   InterruptedException

Wait for an already started process.

Returns:

The process exit value.

Throws:

CmdException - in case of an error

InterruptedException - if the current thread is interrupted while waiting for the process to finish.

close

public void close()

destroy

public void destroy()

destroyForcibly

public void destroyForcibly()

isExecuting

public boolean isExecuting()

exitValue

public int exitValue()

toString

public String toString()

Overrides:

toString in class Object